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 8ca542af5c..7dcf71e32a 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 @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings" | -| `invalidKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down. | -| `enrolledAncestor` | `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). | +| `notificationEmails` | `array` | A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. | | `preferredRequestExpirationDays` | `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. | | `enrolledServices` | `array` | A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. | -| `notificationEmails` | `array` | A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. | -| `activeKeyVersion` | `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. | +| `invalidKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down. | +| `enrolledAncestor` | `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). | | `preferNoBroadApprovalRequests` | `boolean` | This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. | +| `activeKeyVersion` | `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. | | `ancestorHasActiveKeyVersion` | `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). | ## Methods | Name | Accessible by | Required Params | Description | 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 e05889d141..eb29a0d790 100644 --- a/docs/google-docs/providers/google/accessapproval/approval_requests/index.md +++ b/docs/google-docs/providers/google/accessapproval/approval_requests/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the request. Format is "{projects\|folders\|organizations}/{id}/approvalRequests/{approval_request}". | +| `dismiss` | `object` | A decision that has been made to dismiss an approval request. | | `approve` | `object` | A decision that has been made to approve access to a resource. | -| `requestedLocations` | `object` | Home office and physical location of the principal. | -| `requestedResourceProperties` | `object` | The properties associated with the resource of the request. | | `requestTime` | `string` | The time at which approval was requested. | | `requestedResourceName` | `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. | -| `dismiss` | `object` | A decision that has been made to dismiss an approval request. | -| `requestedReason` | `object` | | | `requestedExpiration` | `string` | The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. | +| `requestedResourceProperties` | `object` | The properties associated with the resource of the request. | +| `requestedLocations` | `object` | Home office and physical location of the principal. | +| `requestedReason` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/accessapproval/folders/index.md b/docs/google-docs/providers/google/accessapproval/folders/index.md deleted file mode 100644 index 21b12a8b72..0000000000 --- a/docs/google-docs/providers/google/accessapproval/folders/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: folders -hide_title: false -hide_table_of_contents: false -keywords: - - folders - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Namefolders
TypeResource
Idgoogle.accessapproval.folders
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateAccessApprovalSettings` | `EXEC` | `foldersId` | diff --git a/docs/google-docs/providers/google/accessapproval/folders_access_approval_settings/index.md b/docs/google-docs/providers/google/accessapproval/folders_access_approval_settings/index.md deleted file mode 100644 index e014eefc7c..0000000000 --- a/docs/google-docs/providers/google/accessapproval/folders_access_approval_settings/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: folders_access_approval_settings -hide_title: false -hide_table_of_contents: false -keywords: - - folders_access_approval_settings - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Namefolders_access_approval_settings
TypeResource
Idgoogle.accessapproval.folders_access_approval_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings" | -| `activeKeyVersion` | `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. | -| `ancestorHasActiveKeyVersion` | `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). | -| `enrolledAncestor` | `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). | -| `enrolledServices` | `array` | A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. | -| `invalidKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down. | -| `notificationEmails` | `array` | A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `folders_getAccessApprovalSettings` | `SELECT` | `foldersId` | Gets the settings associated with a project, folder, or organization. | -| `folders_deleteAccessApprovalSettings` | `DELETE` | `foldersId` | 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. | diff --git a/docs/google-docs/providers/google/accessapproval/folders_service_account/index.md b/docs/google-docs/providers/google/accessapproval/folders_service_account/index.md deleted file mode 100644 index 3273a8c053..0000000000 --- a/docs/google-docs/providers/google/accessapproval/folders_service_account/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: folders_service_account -hide_title: false -hide_table_of_contents: false -keywords: - - folders_service_account - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Namefolders_service_account
TypeResource
Idgoogle.accessapproval.folders_service_account
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the Access Approval service account. Format is one of: * "projects/{project}/serviceAccount" * "folders/{folder}/serviceAccount" * "organizations/{organization}/serviceAccount" | -| `accountEmail` | `string` | Email address of the service account. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `folders_getServiceAccount` | `SELECT` | `foldersId` | diff --git a/docs/google-docs/providers/google/accessapproval/organizations/index.md b/docs/google-docs/providers/google/accessapproval/organizations/index.md deleted file mode 100644 index b49fbc871c..0000000000 --- a/docs/google-docs/providers/google/accessapproval/organizations/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: organizations -hide_title: false -hide_table_of_contents: false -keywords: - - organizations - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Nameorganizations
TypeResource
Idgoogle.accessapproval.organizations
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateAccessApprovalSettings` | `EXEC` | `organizationsId` | diff --git a/docs/google-docs/providers/google/accessapproval/organizations_access_approval_settings/index.md b/docs/google-docs/providers/google/accessapproval/organizations_access_approval_settings/index.md deleted file mode 100644 index a49add6278..0000000000 --- a/docs/google-docs/providers/google/accessapproval/organizations_access_approval_settings/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: organizations_access_approval_settings -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_access_approval_settings - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_access_approval_settings
TypeResource
Idgoogle.accessapproval.organizations_access_approval_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings" | -| `enrolledServices` | `array` | A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. | -| `invalidKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down. | -| `notificationEmails` | `array` | A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. | -| `activeKeyVersion` | `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. | -| `ancestorHasActiveKeyVersion` | `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). | -| `enrolledAncestor` | `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). | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `organizations_getAccessApprovalSettings` | `SELECT` | `organizationsId` | Gets the settings associated with a project, folder, or organization. | -| `organizations_deleteAccessApprovalSettings` | `DELETE` | `organizationsId` | 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. | diff --git a/docs/google-docs/providers/google/accessapproval/organizations_service_account/index.md b/docs/google-docs/providers/google/accessapproval/organizations_service_account/index.md deleted file mode 100644 index e44d644ed8..0000000000 --- a/docs/google-docs/providers/google/accessapproval/organizations_service_account/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: organizations_service_account -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_service_account - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_service_account
TypeResource
Idgoogle.accessapproval.organizations_service_account
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the Access Approval service account. Format is one of: * "projects/{project}/serviceAccount" * "folders/{folder}/serviceAccount" * "organizations/{organization}/serviceAccount" | -| `accountEmail` | `string` | Email address of the service account. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getServiceAccount` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/accessapproval/projects/index.md b/docs/google-docs/providers/google/accessapproval/projects/index.md deleted file mode 100644 index 906177f583..0000000000 --- a/docs/google-docs/providers/google/accessapproval/projects/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: projects -hide_title: false -hide_table_of_contents: false -keywords: - - projects - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Nameprojects
TypeResource
Idgoogle.accessapproval.projects
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateAccessApprovalSettings` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/accessapproval/projects_access_approval_settings/index.md b/docs/google-docs/providers/google/accessapproval/projects_access_approval_settings/index.md deleted file mode 100644 index 213641203e..0000000000 --- a/docs/google-docs/providers/google/accessapproval/projects_access_approval_settings/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: projects_access_approval_settings -hide_title: false -hide_table_of_contents: false -keywords: - - projects_access_approval_settings - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Nameprojects_access_approval_settings
TypeResource
Idgoogle.accessapproval.projects_access_approval_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the settings. Format is one of: * "projects/{project}/accessApprovalSettings" * "folders/{folder}/accessApprovalSettings" * "organizations/{organization}/accessApprovalSettings" | -| `enrolledAncestor` | `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). | -| `enrolledServices` | `array` | A list of Google Cloud Services for which the given resource has Access Approval enrolled. Access requests for the resource given by name against any of these services contained here will be required to have explicit approval. If name refers to an organization, enrollment can be done for individual services. If name refers to a folder or project, enrollment can only be done on an all or nothing basis. If a cloud_product is repeated in this list, the first entry will be honored and all following entries will be discarded. A maximum of 10 enrolled services will be enforced, to be expanded as the set of supported services is expanded. | -| `invalidKeyVersion` | `boolean` | Output only. This field is read only (not settable via UpdateAccessApprovalSettings method). If the field is true, that indicates that there is some configuration issue with the active_key_version configured at this level in the resource hierarchy (e.g. it doesn't exist or the Access Approval service account doesn't have the correct permissions on it, etc.) This key version is not necessarily the effective key version at this level, as key versions are inherited top-down. | -| `notificationEmails` | `array` | A list of email addresses to which notifications relating to approval requests should be sent. Notifications relating to a resource will be sent to all emails in the settings of ancestor resources of that resource. A maximum of 50 email addresses are allowed. | -| `activeKeyVersion` | `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. | -| `ancestorHasActiveKeyVersion` | `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). | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_getAccessApprovalSettings` | `SELECT` | `projectsId` | Gets the settings associated with a project, folder, or organization. | -| `projects_deleteAccessApprovalSettings` | `DELETE` | `projectsId` | 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. | diff --git a/docs/google-docs/providers/google/accessapproval/projects_service_account/index.md b/docs/google-docs/providers/google/accessapproval/projects_service_account/index.md deleted file mode 100644 index c7b3dd2e51..0000000000 --- a/docs/google-docs/providers/google/accessapproval/projects_service_account/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: projects_service_account -hide_title: false -hide_table_of_contents: false -keywords: - - projects_service_account - - accessapproval - - 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 ---- - - - -## Overview - - - - -
Nameprojects_service_account
TypeResource
Idgoogle.accessapproval.projects_service_account
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the Access Approval service account. Format is one of: * "projects/{project}/serviceAccount" * "folders/{folder}/serviceAccount" * "organizations/{organization}/serviceAccount" | -| `accountEmail` | `string` | Email address of the service account. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getServiceAccount` | `SELECT` | `projectsId` | 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 30b74564cd..fb50b788cc 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/access_policies/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/{access_policy}` | +| `etag` | `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. | | `parent` | `string` | Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/{organization_id}` | | `scopes` | `array` | The scopes of a policy define which resources an ACM policy can restrict, and where ACM resources can be referenced. For example, a policy with scopes=["folders/123"] has the following behavior: - vpcsc perimeters can only restrict projects within folders/123 - access levels can only be referenced by resources within folders/123. If empty, there are no limitations on which resources can be restricted by an ACM policy, and there are no limitations on where ACM resources can be referenced. Only one policy can include a given scope (attempting to create a second policy which includes "folders/123" will result in an error). Currently, scopes cannot be modified after a policy is created. Currently, policies can only have a single scope. Format: list of `folders/{folder_number}` or `projects/{project_number}` | | `title` | `string` | Required. Human readable title. Does not affect behavior. | -| `etag` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_audit_configs/index.md deleted file mode 100644 index 9806f7e9c2..0000000000 --- a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: access_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - access_policies_iam_audit_configs - - accesscontextmanager - - 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 ---- - - - -## Overview - - - - -
Nameaccess_policies_iam_audit_configs
TypeResource
Idgoogle.accesscontextmanager.access_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accessPolicies_getIamPolicy` | `SELECT` | `accessPoliciesId` | diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_bindings/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_bindings/index.md deleted file mode 100644 index a0b5106742..0000000000 --- a/docs/google-docs/providers/google/accesscontextmanager/access_policies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: access_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - access_policies_iam_bindings - - accesscontextmanager - - 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 ---- - - - -## Overview - - - - -
Nameaccess_policies_iam_bindings
TypeResource
Idgoogle.accesscontextmanager.access_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accessPolicies_getIamPolicy` | `SELECT` | `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 248e090731..8bf7a15702 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 @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 17f1994583..5d7ff04df6 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 @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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`. | -| `authorizationDirection` | `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. | -| `authorizationType` | `string` | A granular control type for authorization levels. Valid value is `AUTHORIZATION_TYPE_TRUST`. | | `orgs` | `array` | The list of organization ids in this AuthorizedOrgsDesc. Format: `organizations/` Example: `organizations/123456` | | `assetType` | `string` | The asset type of this authorized orgs desc. Valid values are `ASSET_TYPE_DEVICE`, and `ASSET_TYPE_CREDENTIAL_STRENGTH`. | +| `authorizationDirection` | `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. | +| `authorizationType` | `string` | A granular control type for authorization levels. Valid value is `AUTHORIZATION_TYPE_TRUST`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/accesscontextmanager/operations/index.md b/docs/google-docs/providers/google/accesscontextmanager/operations/index.md index 03d62cab61..c8cbf26f5e 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/operations/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | | `response` | `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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 d97a2c0183..8da68efcdd 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/service_perimeters/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `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`. | | `description` | `string` | Description of the `ServicePerimeter` and its use. Does not affect behavior. | -| `status` | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. | -| `title` | `string` | Human readable title. Must be unique within the Policy. | | `useExplicitDryRunSpec` | `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. | | `perimeterType` | `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. | | `spec` | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. | +| `status` | `object` | `ServicePerimeterConfig` specifies a set of Google Cloud resources that describe specific Service Perimeter configuration. | +| `title` | `string` | Human readable title. Must be unique within the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md index 44051ee311..1d96048c6e 100644 --- a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md +++ b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification}. | +| `createTime` | `string` | Output only. Time the notification was created. | | `messages` | `array` | A list of messages in the notification. | | `notificationType` | `string` | Type of notification | | `subject` | `object` | A subject line of a notification. | -| `createTime` | `string` | Output only. Time the notification was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 d94d9414ee..f06d59624b 100644 --- a/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md +++ b/docs/google-docs/providers/google/aiplatform/annotation_specs/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the AnnotationSpec. | -| `createTime` | `string` | Output only. Timestamp when this AnnotationSpec was created. | -| `displayName` | `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. | | `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `updateTime` | `string` | Output only. Timestamp when AnnotationSpec was last updated. | +| `createTime` | `string` | Output only. Timestamp when this AnnotationSpec was created. | +| `displayName` | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/aiplatform/annotations/index.md b/docs/google-docs/providers/google/aiplatform/annotations/index.md index 39a6a7238f..471f76c1d5 100644 --- a/docs/google-docs/providers/google/aiplatform/annotations/index.md +++ b/docs/google-docs/providers/google/aiplatform/annotations/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the Annotation. | +| `updateTime` | `string` | Output only. Timestamp when this Annotation was last updated. | +| `annotationSource` | `object` | References an API call. It contains more information about long running operation and Jobs that are triggered by the API call. | +| `createTime` | `string` | Output only. Timestamp when this Annotation was created. | | `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `labels` | `object` | Optional. The labels with user-defined metadata to organize your Annotations. 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 Annotation(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 Annotation: * "aiplatform.googleapis.com/annotation_set_name": optional, name of the UI's annotation set this Annotation belongs to. If not set, the Annotation is not visible in the UI. * "aiplatform.googleapis.com/payload_schema": output only, its value is the payload_schema's title. | | `payload` | `any` | Required. The schema of the payload can be found in payload_schema. | | `payloadSchemaUri` | `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. | -| `updateTime` | `string` | Output only. Timestamp when this Annotation was last updated. | -| `annotationSource` | `object` | References an API call. It contains more information about long running operation and Jobs that are triggered by the API call. | -| `createTime` | `string` | Output only. Timestamp when this Annotation was created. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/aiplatform/artifacts/index.md b/docs/google-docs/providers/google/aiplatform/artifacts/index.md index cf977c4279..c668dbe962 100644 --- a/docs/google-docs/providers/google/aiplatform/artifacts/index.md +++ b/docs/google-docs/providers/google/aiplatform/artifacts/index.md @@ -32,13 +32,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `state` | `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. | | `schemaTitle` | `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. | | `schemaVersion` | `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. | -| `uri` | `string` | The uniform resource identifier of the artifact file. May be empty if there is no actual artifact file. | -| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `metadata` | `object` | Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. | | `createTime` | `string` | Output only. Timestamp when this Artifact was created. | | `displayName` | `string` | User provided display name of the Artifact. May be up to 128 Unicode characters. | -| `labels` | `object` | The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded). | -| `metadata` | `object` | Properties of the Artifact. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. | +| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `updateTime` | `string` | Output only. Timestamp when this Artifact was last updated. | +| `labels` | `object` | The labels with user-defined metadata to organize your Artifacts. 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 Artifact (System labels are excluded). | +| `uri` | `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 | |:-----|:--------------|:----------------|:------------| 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 5de2230e59..bae3e12370 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 @@ -29,31 +29,31 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the BatchPredictionJob. | | `generateExplanation` | `boolean` | Generate explanation with the batch prediction results. When set to `true`, the batch prediction output changes based on the `predictions_format` field of the BatchPredictionJob.output_config object: * `bigquery`: output includes a column named `explanation`. The value is a struct that conforms to the Explanation object. * `jsonl`: The JSON objects on each line include an additional entry keyed `explanation`. The value of the entry is a JSON object that conforms to the Explanation object. * `csv`: Generating explanations for CSV format is not supported. If this field is set to true, either the Model.explanation_spec or explanation_spec must be populated. | -| `outputInfo` | `object` | Further describes this job's output. Supplements output_config. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `error` | `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). | -| `serviceAccount` | `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. | -| `modelParameters` | `any` | The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri. | -| `completionStats` | `object` | Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. | | `partialFailures` | `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. | -| `createTime` | `string` | Output only. Time when the BatchPredictionJob was created. | -| `outputConfig` | `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. | -| `unmanagedContainerModel` | `object` | Contains model information necessary to perform batch prediction without requiring a full model import. | -| `startTime` | `string` | Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `outputInfo` | `object` | Further describes this job's output. Supplements output_config. | +| `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}` | +| `displayName` | `string` | Required. The user-defined name of this BatchPredictionJob. | | `dedicatedResources` | `object` | A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. | +| `explanationSpec` | `object` | Specification of Model explanation. | +| `resourcesConsumed` | `object` | Statistics information about resource consumption. | +| `completionStats` | `object` | Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. | | `inputConfig` | `object` | Configures the input to BatchPredictionJob. See Model.supported_input_storage_formats for Model's supported input formats, and how instances should be expressed via any of them. | +| `outputConfig` | `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. | +| `disableContainerLogging` | `boolean` | For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances 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. | | `labels` | `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. | -| `modelVersionId` | `string` | Output only. The version ID of the Model that produces the predictions via this job. | -| `instanceConfig` | `object` | Configuration defining how to transform batch prediction input instances to the instances that the Model accepts. | +| `endTime` | `string` | Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | | `manualBatchTuningParameters` | `object` | Manual batch tuning parameters. | -| `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}` | -| `resourcesConsumed` | `object` | Statistics information about resource consumption. | -| `disableContainerLogging` | `boolean` | For custom-trained Models and AutoML Tabular Models, the container of the DeployedModel instances 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. | +| `startTime` | `string` | Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `unmanagedContainerModel` | `object` | Contains model information necessary to perform batch prediction without requiring a full model import. | +| `instanceConfig` | `object` | Configuration defining how to transform batch prediction input instances to the instances that the Model accepts. | | `state` | `string` | Output only. The detailed state of the job. | -| `displayName` | `string` | Required. The user-defined name of this BatchPredictionJob. | -| `endTime` | `string` | Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `serviceAccount` | `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. | +| `modelVersionId` | `string` | Output only. The version ID of the Model that produces the predictions via this job. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `createTime` | `string` | Output only. Time when the BatchPredictionJob was created. | +| `modelParameters` | `any` | The parameters that govern the predictions. The schema of the parameters may be specified via the Model's PredictSchemata's parameters_schema_uri. | | `updateTime` | `string` | Output only. Time when the BatchPredictionJob was most recently updated. | -| `explanationSpec` | `object` | Specification of Model explanation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/contexts/index.md b/docs/google-docs/providers/google/aiplatform/contexts/index.md index 83de47f4f5..29f29f197f 100644 --- a/docs/google-docs/providers/google/aiplatform/contexts/index.md +++ b/docs/google-docs/providers/google/aiplatform/contexts/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Immutable. The resource name of the Context. | | `description` | `string` | Description of the Context | | `displayName` | `string` | User provided display name of the Context. May be up to 128 Unicode characters. | -| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `metadata` | `object` | Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. | -| `schemaTitle` | `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. | | `parentContexts` | `array` | Output only. A list of resource names of Contexts that are parents of this Context. A Context may have at most 10 parent_contexts. | -| `createTime` | `string` | Output only. Timestamp when this Context was created. | +| `schemaTitle` | `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. | +| `updateTime` | `string` | Output only. Timestamp when this Context was last updated. | | `labels` | `object` | The labels with user-defined metadata to organize your Contexts. 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 Context (System labels are excluded). | +| `metadata` | `object` | Properties of the Context. Top level metadata keys' heading and trailing spaces will be trimmed. The size of this field should not exceed 200KB. | +| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `schemaVersion` | `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. | -| `updateTime` | `string` | Output only. Timestamp when this Context was last updated. | +| `createTime` | `string` | Output only. Timestamp when this Context was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 c4f52613fd..91e6873bd9 100644 --- a/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of a CustomJob. | -| `endTime` | `string` | Output only. Time when the CustomJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `webAccessUris` | `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. | +| `startTime` | `string` | Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `jobSpec` | `object` | Represents the spec of a CustomJob. | | `error` | `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). | -| `state` | `string` | Output only. The detailed state of the job. | | `labels` | `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. | -| `startTime` | `string` | Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. | -| `webAccessUris` | `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. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `createTime` | `string` | Output only. Time when the CustomJob was created. | -| `jobSpec` | `object` | Represents the spec of a CustomJob. | -| `displayName` | `string` | Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `endTime` | `string` | Output only. Time when the CustomJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `state` | `string` | Output only. The detailed state of the job. | | `updateTime` | `string` | Output only. Time when the CustomJob was most recently updated. | +| `displayName` | `string` | Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 545958df92..ea4ca4050e 100644 --- a/docs/google-docs/providers/google/aiplatform/data_items/index.md +++ b/docs/google-docs/providers/google/aiplatform/data_items/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the DataItem. | +| `createTime` | `string` | Output only. Timestamp when this DataItem was created. | | `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `labels` | `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. | | `payload` | `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. | | `updateTime` | `string` | Output only. Timestamp when this DataItem was last updated. | -| `createTime` | `string` | Output only. Timestamp when this DataItem was created. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 68e17718e1..5c7ddbcc6b 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 @@ -28,23 +28,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the DataLabelingJob. | -| `datasets` | `array` | Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` | -| `displayName` | `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. | -| `specialistPools` | `array` | The SpecialistPools' resource names associated with this job. | -| `createTime` | `string` | Output only. Timestamp when this DataLabelingJob was created. | -| `annotationLabels` | `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. | | `inputs` | `any` | Required. Input config parameters for the DataLabelingJob. | -| `instructionUri` | `string` | Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets. | -| `labelingProgress` | `integer` | Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished. | -| `state` | `string` | Output only. The detailed state of the job. | -| `labelerCount` | `integer` | Required. Number of labelers to work on each DataItem. | | `labels` | `object` | The labels with user-defined metadata to organize your DataLabelingJobs. 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. Following system labels exist for each DataLabelingJob: * "aiplatform.googleapis.com/schema": output only, its value is the inputs_schema's title. | +| `labelerCount` | `integer` | Required. Number of labelers to work on each DataItem. | +| `state` | `string` | Output only. The detailed state of the job. | | `inputsSchemaUri` | `string` | Required. Points to a YAML file stored on Google Cloud Storage describing the config for a specific type of DataLabelingJob. The schema files that can be used here are found in the https://storage.googleapis.com/google-cloud-aiplatform bucket in the /schema/datalabelingjob/inputs/ folder. | -| `updateTime` | `string` | Output only. Timestamp when this DataLabelingJob was updated most recently. | +| `datasets` | `array` | Required. Dataset resource names. Right now we only support labeling from a single Dataset. Format: `projects/{project}/locations/{location}/datasets/{dataset}` | | `activeLearningConfig` | `object` | Parameters that configure the active learning pipeline. Active learning will label the data incrementally by several iterations. For every iteration, it will select a batch of data based on the sampling strategy. | +| `instructionUri` | `string` | Required. The Google Cloud Storage location of the instruction pdf. This pdf is shared with labelers, and provides detailed description on how to label DataItems in Datasets. | +| `labelingProgress` | `integer` | Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished. | +| `annotationLabels` | `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. | +| `specialistPools` | `array` | The SpecialistPools' resource names associated with this job. | | `currentSpend` | `object` | Represents an amount of money with its currency type. | | `error` | `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). | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `updateTime` | `string` | Output only. Timestamp when this DataLabelingJob was updated most recently. | +| `displayName` | `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. | +| `createTime` | `string` | Output only. Timestamp when this DataLabelingJob was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/datasets/index.md b/docs/google-docs/providers/google/aiplatform/datasets/index.md index bfe46caa2a..10ca246132 100644 --- a/docs/google-docs/providers/google/aiplatform/datasets/index.md +++ b/docs/google-docs/providers/google/aiplatform/datasets/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the Dataset. | | `description` | `string` | The description of the Dataset. | -| `createTime` | `string` | Output only. Timestamp when this Dataset was created. | -| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `labels` | `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. | -| `metadataArtifact` | `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}`. | -| `savedQueries` | `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. | -| `metadata` | `any` | Required. Additional information about the Dataset. | | `metadataSchemaUri` | `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/. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `dataItemCount` | `string` | Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset. | -| `updateTime` | `string` | Output only. Timestamp when this Dataset was last updated. | +| `savedQueries` | `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. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `metadataArtifact` | `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}`. | | `displayName` | `string` | Required. The user-defined name of the Dataset. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `updateTime` | `string` | Output only. Timestamp when this Dataset was last updated. | +| `metadata` | `any` | Required. Additional information about the Dataset. | +| `createTime` | `string` | Output only. Timestamp when this Dataset was created. | +| `dataItemCount` | `string` | Output only. The number of DataItems in this Dataset. Only apply for non-structured Dataset. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/endpoints/index.md b/docs/google-docs/providers/google/aiplatform/endpoints/index.md index 1a3b2977c4..10f724aab7 100644 --- a/docs/google-docs/providers/google/aiplatform/endpoints/index.md +++ b/docs/google-docs/providers/google/aiplatform/endpoints/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the Endpoint. | | `description` | `string` | The description of the Endpoint. | -| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `trafficSplit` | `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. | | `enablePrivateServiceConnect` | `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. | -| `network` | `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. | +| `deployedModels` | `array` | Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. | | `predictRequestResponseLoggingConfig` | `object` | Configuration for logging request-response to a BigQuery table. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `displayName` | `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. | -| `updateTime` | `string` | Output only. Timestamp when this Endpoint was last updated. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `labels` | `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. | | `modelDeploymentMonitoringJob` | `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}` | | `createTime` | `string` | Output only. Timestamp when this Endpoint was created. | -| `labels` | `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. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `deployedModels` | `array` | Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. | +| `network` | `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. | +| `updateTime` | `string` | Output only. Timestamp when this Endpoint was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 00a9e4b894..65218ff835 100644 --- a/docs/google-docs/providers/google/aiplatform/entity_types/index.md +++ b/docs/google-docs/providers/google/aiplatform/entity_types/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `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. | | `description` | `string` | Optional. Description of the EntityType. | +| `monitoringConfig` | `object` | Configuration of how features in Featurestore are monitored. | | `offlineStorageTtlDays` | `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. | | `updateTime` | `string` | Output only. Timestamp when this EntityType was most recently updated. | | `createTime` | `string` | Output only. Timestamp when this EntityType was created. | | `etag` | `string` | Optional. Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `labels` | `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. | -| `monitoringConfig` | `object` | Configuration of how features in Featurestore are monitored. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 2c6adeabac..85d6ff89c0 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 @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/evaluations/index.md b/docs/google-docs/providers/google/aiplatform/evaluations/index.md index 74ac769d17..e53b5dc06b 100644 --- a/docs/google-docs/providers/google/aiplatform/evaluations/index.md +++ b/docs/google-docs/providers/google/aiplatform/evaluations/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the ModelEvaluation. | -| `modelExplanation` | `object` | Aggregated explanation metrics for a Model over a set of instances. | +| `metricsSchemaUri` | `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). | | `displayName` | `string` | The display name of the ModelEvaluation. | | `annotationSchemaUri` | `string` | Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.predictions, EvaluatedDataItemView.ground_truths, EvaluatedAnnotation.predictions, and EvaluatedAnnotation.ground_truths. 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). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation. | -| `createTime` | `string` | Output only. Timestamp when this ModelEvaluation was created. | -| `metadata` | `any` | The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of "pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path". | +| `dataItemSchemaUri` | `string` | Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and EvaluatedAnnotation.data_item_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). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation. | | `explanationSpecs` | `array` | Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data. | +| `metadata` | `any` | The metadata of the ModelEvaluation. For the ModelEvaluation uploaded from Managed Pipeline, metadata contains a structured value with keys of "pipeline_job_id", "evaluation_dataset_type", "evaluation_dataset_path". | +| `modelExplanation` | `object` | Aggregated explanation metrics for a Model over a set of instances. | +| `createTime` | `string` | Output only. Timestamp when this ModelEvaluation was created. | | `metrics` | `any` | Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri | -| `dataItemSchemaUri` | `string` | Points to a YAML file stored on Google Cloud Storage describing EvaluatedDataItemView.data_item_payload and EvaluatedAnnotation.data_item_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). This field is not populated if there are neither EvaluatedDataItemViews nor EvaluatedAnnotations under this ModelEvaluation. | -| `metricsSchemaUri` | `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). | | `sliceDimensions` | `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 | diff --git a/docs/google-docs/providers/google/aiplatform/executions/index.md b/docs/google-docs/providers/google/aiplatform/executions/index.md index 038e6377e0..2125374835 100644 --- a/docs/google-docs/providers/google/aiplatform/executions/index.md +++ b/docs/google-docs/providers/google/aiplatform/executions/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the Execution. | | `description` | `string` | Description of the Execution | +| `metadata` | `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. | +| `schemaVersion` | `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. | +| `schemaTitle` | `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. | | `labels` | `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). | -| `createTime` | `string` | Output only. Timestamp when this Execution was created. | | `updateTime` | `string` | Output only. Timestamp when this Execution was last updated. | | `state` | `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. | -| `schemaVersion` | `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. | -| `schemaTitle` | `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. | +| `createTime` | `string` | Output only. Timestamp when this Execution was created. | | `displayName` | `string` | User provided display name of the Execution. May be up to 128 Unicode characters. | | `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/experiments/index.md b/docs/google-docs/providers/google/aiplatform/experiments/index.md index ee6988bfaf..8e7cf86900 100644 --- a/docs/google-docs/providers/google/aiplatform/experiments/index.md +++ b/docs/google-docs/providers/google/aiplatform/experiments/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the TensorboardExperiment. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}` | | `description` | `string` | Description of this TensorboardExperiment. | +| `source` | `string` | Immutable. Source of the TensorboardExperiment. Example: a custom training job. | | `updateTime` | `string` | Output only. Timestamp when this TensorboardExperiment was last updated. | | `createTime` | `string` | Output only. Timestamp when this TensorboardExperiment was created. | | `displayName` | `string` | User provided name of this TensorboardExperiment. | | `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `labels` | `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. | -| `source` | `string` | Immutable. Source of the TensorboardExperiment. Example: a custom training job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/features/index.md b/docs/google-docs/providers/google/aiplatform/features/index.md index b0e14bd136..5be540f050 100644 --- a/docs/google-docs/providers/google/aiplatform/features/index.md +++ b/docs/google-docs/providers/google/aiplatform/features/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/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. | | `description` | `string` | Description of the Feature. | -| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `disableMonitoring` | `boolean` | Optional. 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. | +| `labels` | `object` | Optional. The labels with user-defined metadata to organize your Features. 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 Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | | `versionLabels` | `object` | The labels with user-defined metadata to organize your versions. 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. | +| `disableMonitoring` | `boolean` | Optional. 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. | +| `monitoringStatsAnomalies` | `array` | Output only. The list of historical stats and anomalies with specified objectives. | | `updateTime` | `string` | Output only. Timestamp when this EntityType was most recently updated. | +| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `valueType` | `string` | Required. Immutable. Type of Feature value. | -| `labels` | `object` | Optional. The labels with user-defined metadata to organize your Features. 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 Feature (System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. | -| `monitoringStatsAnomalies` | `array` | Output only. The list of historical stats and anomalies with specified objectives. | | `createTime` | `string` | Output only. Timestamp when this EntityType was created. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/aiplatform/featurestores/index.md b/docs/google-docs/providers/google/aiplatform/featurestores/index.md index 3beef9d370..8f1003b0eb 100644 --- a/docs/google-docs/providers/google/aiplatform/featurestores/index.md +++ b/docs/google-docs/providers/google/aiplatform/featurestores/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the Featurestore. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}` | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `labels` | `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. | -| `state` | `string` | Output only. State of the featurestore. | | `onlineServingConfig` | `object` | OnlineServingConfig specifies the details for provisioning online serving resources. | +| `onlineStorageTtlDays` | `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 | | `updateTime` | `string` | Output only. Timestamp when this Featurestore was last updated. | -| `createTime` | `string` | Output only. Timestamp when this Featurestore was created. | | `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `onlineStorageTtlDays` | `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 | +| `labels` | `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. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `state` | `string` | Output only. State of the featurestore. | +| `createTime` | `string` | Output only. Timestamp when this Featurestore was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 219ed172a5..0a9e231b06 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 @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 4b38e1cf00..124795fc4e 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 @@ -28,21 +28,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the HyperparameterTuningJob. | -| `maxTrialCount` | `integer` | Required. The desired total number of Trials. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `displayName` | `string` | Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | -| `state` | `string` | Output only. The detailed state of the job. | +| `endTime` | `string` | Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | | `error` | `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). | +| `labels` | `object` | The labels with user-defined metadata to organize HyperparameterTuningJobs. 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. | +| `parallelTrialCount` | `integer` | Required. The desired number of Trials to run in parallel. | +| `trials` | `array` | Output only. Trials of the HyperparameterTuningJob. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `createTime` | `string` | Output only. Time when the HyperparameterTuningJob was created. | | `startTime` | `string` | Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. | -| `trials` | `array` | Output only. Trials of the HyperparameterTuningJob. | -| `labels` | `object` | The labels with user-defined metadata to organize HyperparameterTuningJobs. 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. | | `studySpec` | `object` | Represents specification of a Study. | -| `parallelTrialCount` | `integer` | Required. The desired number of Trials to run in parallel. | | `trialJobSpec` | `object` | Represents the spec of a CustomJob. | | `maxFailedTrialCount` | `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. | -| `endTime` | `string` | Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `displayName` | `string` | Required. The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `maxTrialCount` | `integer` | Required. The desired total number of Trials. | | `updateTime` | `string` | Output only. Time when the HyperparameterTuningJob was most recently updated. | +| `state` | `string` | Output only. The detailed state of the job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 dc20b6f6ee..595f1a02c6 100644 --- a/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md +++ b/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the IndexEndpoint. | | `description` | `string` | The description of the IndexEndpoint. | -| `deployedIndexes` | `array` | Output only. The indexes deployed in this endpoint. | -| `enablePrivateServiceConnect` | `boolean` | Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set. | -| `labels` | `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. | -| `network` | `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. | -| `updateTime` | `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. | -| `createTime` | `string` | Output only. Timestamp when this IndexEndpoint was created. | | `privateServiceConnectConfig` | `object` | Represents configuration for private service connect. | -| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `publicEndpointEnabled` | `boolean` | Optional. If true, the deployed index will be accessible through public endpoint. | +| `updateTime` | `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. | +| `labels` | `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. | | `displayName` | `string` | Required. The display name of the IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `enablePrivateServiceConnect` | `boolean` | Optional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set. | +| `createTime` | `string` | Output only. Timestamp when this IndexEndpoint was created. | +| `deployedIndexes` | `array` | Output only. The indexes deployed in this endpoint. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `network` | `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. | | `publicEndpointDomainName` | `string` | Output only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/aiplatform/indexes/index.md b/docs/google-docs/providers/google/aiplatform/indexes/index.md index 9d75a027ea..9973bba5e1 100644 --- a/docs/google-docs/providers/google/aiplatform/indexes/index.md +++ b/docs/google-docs/providers/google/aiplatform/indexes/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the Index. | | `description` | `string` | The description of the Index. | -| `createTime` | `string` | Output only. Timestamp when this Index was created. | -| `metadata` | `any` | An additional information about the Index; the schema of the metadata can be found in metadata_schema. | -| `displayName` | `string` | Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. | -| `indexUpdateMethod` | `string` | Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `metadataSchemaUri` | `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. | | `deployedIndexes` | `array` | Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first. | -| `updateTime` | `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. | | `indexStats` | `object` | Stats of the Index. | -| `metadataSchemaUri` | `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. | +| `indexUpdateMethod` | `string` | Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. | | `labels` | `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. | -| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `updateTime` | `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. | +| `metadata` | `any` | An additional information about the Index; the schema of the metadata can be found in metadata_schema. | +| `displayName` | `string` | Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `createTime` | `string` | Output only. Timestamp when this Index was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 0d32520ff4..b13ece8f30 100644 --- a/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md +++ b/docs/google-docs/providers/google/aiplatform/metadata_schemas/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the MetadataSchema. | | `description` | `string` | Description of the Metadata Schema | -| `schema` | `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) | | `schemaType` | `string` | The type of the MetadataSchema. This is a property that identifies which metadata types will use the MetadataSchema. | | `schemaVersion` | `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. | | `createTime` | `string` | Output only. Timestamp when this MetadataSchema was created. | +| `schema` | `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) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 3c28839a08..b12b5b56c6 100644 --- a/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md +++ b/docs/google-docs/providers/google/aiplatform/metadata_stores/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the MetadataStore instance. | | `description` | `string` | Description of the MetadataStore. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `state` | `object` | Represents state information for a MetadataStore. | | `updateTime` | `string` | Output only. Timestamp when this MetadataStore was last updated. | | `createTime` | `string` | Output only. Timestamp when this MetadataStore was created. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level 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 92148c8b8f..c374dc81cf 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 @@ -28,28 +28,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of a ModelDeploymentMonitoringJob. | +| `createTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was created. | +| `analysisInstanceSchemaUri` | `string` | YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from predict_instance_schema_uri, meaning that TFDV will use the data in the exact format(data type) as prediction request/response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string. | | `labels` | `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. | -| `displayName` | `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. | -| `latestMonitoringPipelineMetadata` | `object` | All metadata of most recent monitoring pipelines. | -| `logTtl` | `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. | -| `bigqueryTables` | `array` | Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response | -| `endpoint` | `string` | Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` | +| `samplePredictInstance` | `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. | +| `nextScheduleTime` | `string` | Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. | | `statsAnomaliesBaseDirectory` | `object` | The Google Cloud Storage location where the output is to be written to. | +| `modelMonitoringAlertConfig` | `object` | | +| `modelDeploymentMonitoringObjectiveConfigs` | `array` | Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately. | | `enableMonitoringPipelineLogs` | `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). | | `error` | `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). | -| `modelMonitoringAlertConfig` | `object` | | -| `analysisInstanceSchemaUri` | `string` | YAML schema file uri describing the format of a single instance that you want Tensorflow Data Validation (TFDV) to analyze. If this field is empty, all the feature data types are inferred from predict_instance_schema_uri, meaning that TFDV will use the data in the exact format(data type) as prediction request/response. If there are any data type differences between predict instance and TFDV instance, this field can be used to override the schema. For models trained with Vertex AI, this field must be set as all the fields in predict instance formatted as string. | | `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'. | -| `modelDeploymentMonitoringScheduleConfig` | `object` | The config for scheduling monitoring job. | -| `loggingSamplingStrategy` | `object` | Sampling Strategy for logging, can be for both training and prediction dataset. | -| `modelDeploymentMonitoringObjectiveConfigs` | `array` | Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately. | -| `samplePredictInstance` | `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. | -| `nextScheduleTime` | `string` | Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. | -| `predictInstanceSchemaUri` | `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. | -| `scheduleState` | `string` | Output only. Schedule state when the monitoring job is in Running state. | -| `createTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was created. | | `updateTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. | +| `loggingSamplingStrategy` | `object` | Sampling Strategy for logging, can be for both training and prediction dataset. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `endpoint` | `string` | Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` | +| `modelDeploymentMonitoringScheduleConfig` | `object` | The config for scheduling monitoring job. | +| `scheduleState` | `string` | Output only. Schedule state when the monitoring job is in Running state. | +| `latestMonitoringPipelineMetadata` | `object` | All metadata of most recent monitoring pipelines. | +| `logTtl` | `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. | +| `bigqueryTables` | `array` | Output only. The created bigquery tables for the job under customer project. Customer could do their own query & analysis. There could be 4 log tables in maximum: 1. Training data logging predict request/response 2. Serving data logging predict request/response | +| `displayName` | `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. | +| `predictInstanceSchemaUri` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/models/index.md b/docs/google-docs/providers/google/aiplatform/models/index.md index eb48f87d63..5af9f86d34 100644 --- a/docs/google-docs/providers/google/aiplatform/models/index.md +++ b/docs/google-docs/providers/google/aiplatform/models/index.md @@ -29,33 +29,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the Model. | | `description` | `string` | The description of the Model. | -| `explanationSpec` | `object` | Specification of Model explanation. | -| `labels` | `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. | +| `supportedDeploymentResourcesTypes` | `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. | +| `versionDescription` | `string` | The description of this version. | | `supportedExportFormats` | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. | -| `metadataArtifact` | `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}`. | +| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | +| `versionId` | `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. | +| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | +| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | +| `explanationSpec` | `object` | Specification of Model explanation. | +| `displayName` | `string` | Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | +| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | +| `modelSourceInfo` | `object` | Detail description of the source information of the model. | +| `metadata` | `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. | +| `supportedInputStorageFormats` | `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. | +| `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | +| `supportedOutputStorageFormats` | `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. | | `versionAliases` | `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. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `displayName` | `string` | Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters. | -| `versionId` | `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. | -| `artifactUri` | `string` | Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not present for AutoML Models or Large Models. | +| `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | | `metadataSchemaUri` | `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. | -| `supportedOutputStorageFormats` | `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. | -| `supportedDeploymentResourcesTypes` | `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. | +| `labels` | `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. | +| `artifactUri` | `string` | Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not present for AutoML Models or Large Models. | +| `metadataArtifact` | `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}`. | | `containerSpec` | `object` | Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). | -| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | | `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | -| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | -| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | -| `supportedInputStorageFormats` | `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. | -| `metadata` | `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. | -| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | | `updateTime` | `string` | Output only. Timestamp when this Model was most recently updated. | -| `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | -| `modelSourceInfo` | `object` | Detail description of the source information of the model. | -| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | -| `versionDescription` | `string` | The description of this version. | -| `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | +| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 1eef4fb75e..d8c2c857e1 100644 --- a/docs/google-docs/providers/google/aiplatform/models_versions/index.md +++ b/docs/google-docs/providers/google/aiplatform/models_versions/index.md @@ -29,33 +29,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the Model. | | `description` | `string` | The description of the Model. | -| `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | | `supportedOutputStorageFormats` | `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. | -| `metadata` | `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. | -| `supportedDeploymentResourcesTypes` | `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. | -| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | -| `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | -| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | | `supportedExportFormats` | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. | -| `supportedInputStorageFormats` | `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. | +| `modelSourceInfo` | `object` | Detail description of the source information of the model. | +| `labels` | `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. | +| `versionDescription` | `string` | The description of this version. | +| `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | +| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | +| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | | `versionId` | `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. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `versionAliases` | `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. | +| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | +| `metadata` | `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. | +| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | +| `supportedInputStorageFormats` | `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. | | `metadataArtifact` | `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}`. | -| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | -| `modelSourceInfo` | `object` | Detail description of the source information of the model. | | `artifactUri` | `string` | Immutable. The path to the directory containing the Model artifact and any of its supporting files. Not present for AutoML Models or Large Models. | | `containerSpec` | `object` | Specification of a container for serving predictions. Some fields in this message correspond to fields in the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#container-v1-core). | -| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | -| `labels` | `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. | +| `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | +| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | | `metadataSchemaUri` | `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. | +| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `updateTime` | `string` | Output only. Timestamp when this Model was most recently updated. | -| `explanationSpec` | `object` | Specification of Model explanation. | | `displayName` | `string` | Required. The display name of the Model. The name can be up to 128 characters long and can consist of any UTF-8 characters. | -| `versionAliases` | `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. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | -| `versionDescription` | `string` | The description of this version. | -| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | +| `supportedDeploymentResourcesTypes` | `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. | +| `explanationSpec` | `object` | Specification of Model explanation. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 f6cc47fafe..47e35dfd31 100644 --- a/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the NasJob. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `error` | `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). | | `labels` | `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. | +| `startTime` | `string` | Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. | | `state` | `string` | Output only. The detailed state of the job. | -| `endTime` | `string` | Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `createTime` | `string` | Output only. Time when the NasJob was created. | | `enableRestrictedImageTraining` | `boolean` | Optional. Enable a separation of Custom model training and restricted image training for tenant project. | -| `error` | `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). | +| `updateTime` | `string` | Output only. Time when the NasJob was most recently updated. | +| `nasJobSpec` | `object` | Represents the spec of a NasJob. | | `nasJobOutput` | `object` | Represents a uCAIP NasJob output. | | `displayName` | `string` | Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters. | -| `nasJobSpec` | `object` | Represents the spec of a NasJob. | -| `startTime` | `string` | Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. | -| `updateTime` | `string` | Output only. Time when the NasJob was most recently updated. | -| `createTime` | `string` | Output only. Time when the NasJob was created. | +| `endTime` | `string` | Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 33fb988e1b..c40f0131f7 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 @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the NasTrialDetail. | -| `trainTrial` | `object` | Represents a uCAIP NasJob trial. | | `parameters` | `string` | The parameters for the NasJob NasTrial. | | `searchTrial` | `object` | Represents a uCAIP NasJob trial. | +| `trainTrial` | `object` | Represents a uCAIP NasJob trial. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 224013ca5c..a12a420514 100644 --- a/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md @@ -28,23 +28,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the PipelineJob. | -| `jobDetail` | `object` | The runtime detail of PipelineJob. | -| `updateTime` | `string` | Output only. Timestamp when this PipelineJob was most recently updated. | -| `runtimeConfig` | `object` | The runtime config of a PipelineJob. | -| `error` | `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). | -| `labels` | `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. | +| `reservedIpRanges` | `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']. | | `createTime` | `string` | Output only. Pipeline creation time. | +| `startTime` | `string` | Output only. Pipeline start time. | +| `endTime` | `string` | Output only. Pipeline end time. | | `serviceAccount` | `string` | The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. | -| `reservedIpRanges` | `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']. | | `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. | -| `startTime` | `string` | Output only. Pipeline start time. | -| `state` | `string` | Output only. The detailed state of the job. | +| `error` | `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). | +| `templateUri` | `string` | A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `pipelineSpec` | `object` | The spec of the pipeline. | | `templateMetadata` | `object` | Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. | -| `templateUri` | `string` | A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. | +| `runtimeConfig` | `object` | The runtime config of a PipelineJob. | | `displayName` | `string` | The display name of the Pipeline. The name can be up to 128 characters long and can consist of any UTF-8 characters. | -| `endTime` | `string` | Output only. Pipeline end time. | -| `pipelineSpec` | `object` | The spec of the pipeline. | +| `updateTime` | `string` | Output only. Timestamp when this PipelineJob was most recently updated. | +| `state` | `string` | Output only. The detailed state of the job. | +| `labels` | `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. | +| `jobDetail` | `object` | The runtime detail of PipelineJob. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/runs/index.md b/docs/google-docs/providers/google/aiplatform/runs/index.md index f3a67b2d58..0f861504c0 100644 --- a/docs/google-docs/providers/google/aiplatform/runs/index.md +++ b/docs/google-docs/providers/google/aiplatform/runs/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the TensorboardRun. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}/experiments/{experiment}/runs/{run}` | | `description` | `string` | Description of this TensorboardRun. | -| `updateTime` | `string` | Output only. Timestamp when this TensorboardRun was last updated. | -| `createTime` | `string` | Output only. Timestamp when this TensorboardRun was created. | | `displayName` | `string` | Required. User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment. | | `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `labels` | `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. | +| `updateTime` | `string` | Output only. Timestamp when this TensorboardRun was last updated. | +| `createTime` | `string` | Output only. Timestamp when this TensorboardRun was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 863e995736..57c1a22da2 100644 --- a/docs/google-docs/providers/google/aiplatform/saved_queries/index.md +++ b/docs/google-docs/providers/google/aiplatform/saved_queries/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the SavedQuery. | -| `problemType` | `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 | -| `displayName` | `string` | Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `metadata` | `any` | Some additional information about the SavedQuery. | +| `etag` | `string` | Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens. | +| `updateTime` | `string` | Output only. Timestamp when SavedQuery was last updated. | | `annotationFilter` | `string` | Output only. Filters on the Annotations in the dataset. | -| `annotationSpecCount` | `integer` | Output only. Number of AnnotationSpecs in the context of the SavedQuery. | | `createTime` | `string` | Output only. Timestamp when this SavedQuery was created. | -| `updateTime` | `string` | Output only. Timestamp when SavedQuery was last updated. | -| `metadata` | `any` | Some additional information about the SavedQuery. | | `supportAutomlTraining` | `boolean` | Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training. | -| `etag` | `string` | Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens. | +| `displayName` | `string` | Required. The user-defined name of the SavedQuery. The name can be up to 128 characters long and can consist of any UTF-8 characters. | +| `annotationSpecCount` | `integer` | Output only. Number of AnnotationSpecs in the context of the SavedQuery. | +| `problemType` | `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 | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/schedules/index.md b/docs/google-docs/providers/google/aiplatform/schedules/index.md index 7587df1d2e..1802f58821 100644 --- a/docs/google-docs/providers/google/aiplatform/schedules/index.md +++ b/docs/google-docs/providers/google/aiplatform/schedules/index.md @@ -28,23 +28,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the Schedule. | -| `displayName` | `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. | -| `createPipelineJobRequest` | `object` | Request message for PipelineService.CreatePipelineJob. | -| `endTime` | `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. | -| `state` | `string` | Output only. The state of this Schedule. | -| `maxConcurrentRunCount` | `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). | -| `createTime` | `string` | Output only. Timestamp when this Schedule was created. | +| `allowQueueing` | `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. | | `maxRunCount` | `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. | -| `lastPauseTime` | `string` | Output only. Timestamp when this Schedule was last paused. Unset if never paused. | +| `startTime` | `string` | Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified. | | `startedRunCount` | `string` | Output only. The number of runs started by this schedule. | +| `state` | `string` | Output only. The state of this Schedule. | | `cron` | `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 * * * *". | -| `catchUp` | `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. | -| `lastResumeTime` | `string` | Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause. | +| `lastPauseTime` | `string` | Output only. Timestamp when this Schedule was last paused. Unset if never paused. | +| `createTime` | `string` | Output only. Timestamp when this Schedule was created. | +| `displayName` | `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. | +| `createPipelineJobRequest` | `object` | Request message for PipelineService.CreatePipelineJob. | | `lastScheduledRunResponse` | `object` | Status of a scheduled run. | -| `nextRunTime` | `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. | -| `allowQueueing` | `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. | +| `maxConcurrentRunCount` | `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). | +| `endTime` | `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. | +| `lastResumeTime` | `string` | Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause. | | `updateTime` | `string` | Output only. Timestamp when this Schedule was updated. | -| `startTime` | `string` | Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified. | +| `catchUp` | `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. | +| `nextRunTime` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 e44b2af606..f5372253ac 100644 --- a/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md +++ b/docs/google-docs/providers/google/aiplatform/specialist_pools/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the SpecialistPool. | -| `specialistWorkerEmails` | `array` | The email addresses of workers in the SpecialistPool. | -| `displayName` | `string` | Required. The user-defined name of the SpecialistPool. The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level. | | `pendingDataLabelingJobs` | `array` | Output only. The resource name of the pending data labeling jobs. | | `specialistManagerEmails` | `array` | The email addresses of the managers in the SpecialistPool. | | `specialistManagersCount` | `integer` | Output only. The number of managers in this SpecialistPool. | +| `specialistWorkerEmails` | `array` | The email addresses of workers in the SpecialistPool. | +| `displayName` | `string` | Required. The user-defined name of the SpecialistPool. The name can be up to 128 characters long and can consist of any UTF-8 characters. This field should be unique on project-level. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/studies/index.md b/docs/google-docs/providers/google/aiplatform/studies/index.md index eefa44c0c2..712e726fc0 100644 --- a/docs/google-docs/providers/google/aiplatform/studies/index.md +++ b/docs/google-docs/providers/google/aiplatform/studies/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of a study. The study's globally unique identifier. Format: `projects/{project}/locations/{location}/studies/{study}` | +| `displayName` | `string` | Required. Describes the Study, default value is empty string. | +| `inactiveReason` | `string` | Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. | | `state` | `string` | Output only. The detailed state of a Study. | | `studySpec` | `object` | Represents specification of a Study. | | `createTime` | `string` | Output only. Time at which the study was created. | -| `displayName` | `string` | Required. Describes the Study, default value is empty string. | -| `inactiveReason` | `string` | Output only. A human readable reason why the Study is inactive. This should be empty if a study is ACTIVE or COMPLETED. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/tensorboards/index.md b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md index 364b1ebf29..b8f8db2873 100644 --- a/docs/google-docs/providers/google/aiplatform/tensorboards/index.md +++ b/docs/google-docs/providers/google/aiplatform/tensorboards/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the Tensorboard. Format: `projects/{project}/locations/{location}/tensorboards/{tensorboard}` | | `description` | `string` | Description of this Tensorboard. | -| `blobStoragePathPrefix` | `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 '/'. | -| `displayName` | `string` | Required. User provided name of this Tensorboard. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `updateTime` | `string` | Output only. Timestamp when this Tensorboard was last updated. | +| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `runCount` | `integer` | Output only. The number of Runs stored in this Tensorboard. | +| `displayName` | `string` | Required. User provided name of this Tensorboard. | +| `isDefault` | `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. | | `createTime` | `string` | Output only. Timestamp when this Tensorboard was created. | -| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `blobStoragePathPrefix` | `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 '/'. | | `labels` | `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. | -| `isDefault` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 4d3879daa8..c790ce2748 100644 --- a/docs/google-docs/providers/google/aiplatform/time_series/index.md +++ b/docs/google-docs/providers/google/aiplatform/time_series/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the TensorboardTimeSeries. | | `description` | `string` | Description of this TensorboardTimeSeries. | +| `updateTime` | `string` | Output only. Timestamp when this TensorboardTimeSeries was last updated. | | `createTime` | `string` | Output only. Timestamp when this TensorboardTimeSeries was created. | -| `pluginData` | `string` | Data of the current plugin, with the size limited to 65KB. | -| `pluginName` | `string` | Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob | -| `valueType` | `string` | Required. Immutable. Type of TensorboardTimeSeries value. | | `displayName` | `string` | Required. User provided name of this TensorboardTimeSeries. This value should be unique among all TensorboardTimeSeries resources belonging to the same TensorboardRun resource (parent resource). | -| `metadata` | `object` | Describes metadata for a TensorboardTimeSeries. | +| `valueType` | `string` | Required. Immutable. Type of TensorboardTimeSeries value. | +| `pluginName` | `string` | Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob | | `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `updateTime` | `string` | Output only. Timestamp when this TensorboardTimeSeries was last updated. | +| `metadata` | `object` | Describes metadata for a TensorboardTimeSeries. | +| `pluginData` | `string` | Data of the current plugin, with the size limited to 65KB. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 26ee2c5458..73e5ae6a62 100644 --- a/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md +++ b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md @@ -29,21 +29,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the TrainingPipeline. | | `state` | `string` | Output only. The detailed state of the pipeline. | -| `trainingTaskDefinition` | `string` | Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. 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. | -| `endTime` | `string` | Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. | | `displayName` | `string` | Required. The user-defined name of this TrainingPipeline. | -| `modelToUpload` | `object` | A trained machine learning Model. | | `trainingTaskMetadata` | `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. | -| `createTime` | `string` | Output only. Time when the TrainingPipeline was created. | -| `modelId` | `string` | Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen. | -| `labels` | `object` | The labels with user-defined metadata to organize TrainingPipelines. 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. | | `startTime` | `string` | Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state. | -| `parentModel` | `string` | Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`. | -| `updateTime` | `string` | Output only. Time when the TrainingPipeline was most recently updated. | -| `error` | `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). | -| `inputDataConfig` | `object` | Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. | +| `modelToUpload` | `object` | A trained machine learning Model. | +| `modelId` | `string` | Optional. The ID to use for the uploaded Model, which will become the final component of the model resource name. This value may be up to 63 characters, and valid characters are `[a-z0-9_-]`. The first character cannot be a number or hyphen. | +| `createTime` | `string` | Output only. Time when the TrainingPipeline was created. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `error` | `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). | | `trainingTaskInputs` | `any` | Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`. | +| `updateTime` | `string` | Output only. Time when the TrainingPipeline was most recently updated. | +| `parentModel` | `string` | Optional. When specify this field, the `model_to_upload` will not be uploaded as a new model, instead, it will become a new version of this `parent_model`. | +| `trainingTaskDefinition` | `string` | Required. A Google Cloud Storage path to the YAML file that defines the training task which is responsible for producing the model artifact, and may also include additional auxiliary work. The definition files that can be used here are found in gs://google-cloud-aiplatform/schema/trainingjob/definition/. 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. | +| `labels` | `object` | The labels with user-defined metadata to organize TrainingPipelines. 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. | +| `inputDataConfig` | `object` | Specifies Vertex AI owned input data to be used for training, and possibly evaluating, the Model. | +| `endTime` | `string` | Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/trials/index.md b/docs/google-docs/providers/google/aiplatform/trials/index.md index fc6ac83c0e..83fad4eb61 100644 --- a/docs/google-docs/providers/google/aiplatform/trials/index.md +++ b/docs/google-docs/providers/google/aiplatform/trials/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. The identifier of the Trial assigned by the service. | | `name` | `string` | Output only. Resource name of the Trial assigned by the service. | +| `customJob` | `string` | Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial. | | `webAccessUris` | `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. | | `endTime` | `string` | Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`. | +| `finalMeasurement` | `object` | A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. | +| `clientId` | `string` | Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial. | | `startTime` | `string` | Output only. Time when the Trial was started. | -| `infeasibleReason` | `string` | Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`. | +| `measurements` | `array` | Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations. | | `parameters` | `array` | Output only. The parameters of the Trial. | -| `clientId` | `string` | Output only. The identifier of the client that originally requested this Trial. Each client is identified by a unique client_id. When a client asks for a suggestion, Vertex AI Vizier will assign it a Trial. The client should evaluate the Trial, complete it, and report back to Vertex AI Vizier. If suggestion is asked again by same client_id before the Trial is completed, the same Trial will be returned. Multiple clients with different client_ids can ask for suggestions simultaneously, each of them will get their own Trial. | -| `finalMeasurement` | `object` | A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. | +| `infeasibleReason` | `string` | Output only. A human readable string describing why the Trial is infeasible. This is set only if Trial state is `INFEASIBLE`. | | `state` | `string` | Output only. The detailed state of the Trial. | -| `measurements` | `array` | Output only. A list of measurements that are strictly lexicographically ordered by their induced tuples (steps, elapsed_duration). These are used for early stopping computations. | -| `customJob` | `string` | Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 e056370931..a0c0cb8042 100644 --- a/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md +++ b/docs/google-docs/providers/google/analyticshub/data_exchanges/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`. | | `description` | `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. | -| `displayName` | `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. | | `documentation` | `string` | Optional. Documentation describing the data exchange. | | `icon` | `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. | | `listingCount` | `integer` | Output only. Number of listings contained in the data exchange. | | `primaryContact` | `string` | Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes. | | `sharingEnvironmentConfig` | `object` | Sharing environment is a behavior model for sharing data within a data exchange. This option is configurable for a data exchange. | +| `displayName` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_audit_configs/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_audit_configs/index.md deleted file mode 100644 index db37d9fe44..0000000000 --- a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: data_exchanges_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - data_exchanges_iam_audit_configs - - analyticshub - - 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 ---- - - - -## Overview - - - - -
Namedata_exchanges_iam_audit_configs
TypeResource
Idgoogle.analyticshub.data_exchanges_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataExchanges_getIamPolicy` | `SELECT` | `dataExchangesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_bindings/index.md b/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_bindings/index.md deleted file mode 100644 index 03bcf1e7c3..0000000000 --- a/docs/google-docs/providers/google/analyticshub/data_exchanges_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: data_exchanges_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - data_exchanges_iam_bindings - - analyticshub - - 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 ---- - - - -## Overview - - - - -
Namedata_exchanges_iam_bindings
TypeResource
Idgoogle.analyticshub.data_exchanges_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataExchanges_getIamPolicy` | `SELECT` | `dataExchangesId, locationsId, 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 03e518b67b..36c7dea069 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 @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 d6e4516787..55059884cf 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 @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. | -| `creationTime` | `string` | Output only. Timestamp when the subscription was created. | -| `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | -| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | -| `linkedDatasetMap` | `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. | -| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | | `state` | `string` | Output only. Current state of the subscription. | -| `subscriberContact` | `string` | Output only. Email of the subscriber. | | `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | +| `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | +| `subscriberContact` | `string` | Output only. Email of the subscriber. | +| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | +| `creationTime` | `string` | Output only. Timestamp when the subscription was created. | | `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | +| `linkedDatasetMap` | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/analyticshub/listings/index.md b/docs/google-docs/providers/google/analyticshub/listings/index.md index ed6f6de755..34afdc0d49 100644 --- a/docs/google-docs/providers/google/analyticshub/listings/index.md +++ b/docs/google-docs/providers/google/analyticshub/listings/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456` | | `description` | `string` | Optional. Short description of the listing. The description must not contain Unicode non-characters and 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. | +| `icon` | `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. | +| `documentation` | `string` | Optional. Documentation describing the listing. | +| `publisher` | `object` | Contains details of the listing publisher. | | `requestAccess` | `string` | Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes. | -| `bigqueryDataset` | `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. | -| `restrictedExportConfig` | `object` | Restricted export config, used to configure restricted export on linked dataset. | +| `dataProvider` | `object` | Contains details of the data provider. | | `displayName` | `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. | +| `restrictedExportConfig` | `object` | Restricted export config, used to configure restricted export on linked dataset. | +| `bigqueryDataset` | `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. | +| `categories` | `array` | Optional. Categories of the listing. Up to two categories are allowed. | | `primaryContact` | `string` | Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. | -| `documentation` | `string` | Optional. Documentation describing the listing. | | `state` | `string` | Output only. Current state of the listing. | -| `dataProvider` | `object` | Contains details of the data provider. | -| `icon` | `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. | -| `publisher` | `object` | Contains details of the listing publisher. | -| `categories` | `array` | Optional. Categories of the listing. Up to two categories are allowed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/analyticshub/listings_iam_audit_configs/index.md b/docs/google-docs/providers/google/analyticshub/listings_iam_audit_configs/index.md deleted file mode 100644 index b06460379f..0000000000 --- a/docs/google-docs/providers/google/analyticshub/listings_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: listings_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - listings_iam_audit_configs - - analyticshub - - 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 ---- - - - -## Overview - - - - -
Namelistings_iam_audit_configs
TypeResource
Idgoogle.analyticshub.listings_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataExchanges_listings_getIamPolicy` | `SELECT` | `dataExchangesId, listingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/analyticshub/listings_iam_bindings/index.md b/docs/google-docs/providers/google/analyticshub/listings_iam_bindings/index.md deleted file mode 100644 index b69cd1f1a9..0000000000 --- a/docs/google-docs/providers/google/analyticshub/listings_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: listings_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - listings_iam_bindings - - analyticshub - - 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 ---- - - - -## Overview - - - - -
Namelistings_iam_bindings
TypeResource
Idgoogle.analyticshub.listings_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataExchanges_listings_getIamPolicy` | `SELECT` | `dataExchangesId, listingsId, locationsId, 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 f39d928e29..7b83040967 100644 --- a/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md +++ b/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. | -| `subscriberContact` | `string` | Output only. Email of the subscriber. | | `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | | `state` | `string` | Output only. Current state of the subscription. | | `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | | `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | -| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | +| `subscriberContact` | `string` | Output only. Email of the subscriber. | | `creationTime` | `string` | Output only. Timestamp when the subscription was created. | -| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | | `linkedDatasetMap` | `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. | ## Methods | Name | Accessible by | Required Params | diff --git a/docs/google-docs/providers/google/analyticshub/subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/subscriptions/index.md index a8a3c04469..9c54922d82 100644 --- a/docs/google-docs/providers/google/analyticshub/subscriptions/index.md +++ b/docs/google-docs/providers/google/analyticshub/subscriptions/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. | -| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | -| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | | `linkedDatasetMap` | `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. | +| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | +| `state` | `string` | Output only. Current state of the subscription. | | `subscriberContact` | `string` | Output only. Email of the subscriber. | -| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | | `creationTime` | `string` | Output only. Timestamp when the subscription was created. | +| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | +| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | | `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | -| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | -| `state` | `string` | Output only. Current state of the subscription. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/apis_iam_audit_configs/index.md b/docs/google-docs/providers/google/apigateway/apis_iam_audit_configs/index.md deleted file mode 100644 index 7c3a59a170..0000000000 --- a/docs/google-docs/providers/google/apigateway/apis_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: apis_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - apis_iam_audit_configs - - apigateway - - 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 ---- - - - -## Overview - - - - -
Nameapis_iam_audit_configs
TypeResource
Idgoogle.apigateway.apis_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_getIamPolicy` | `SELECT` | `apisId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigateway/apis_iam_bindings/index.md b/docs/google-docs/providers/google/apigateway/apis_iam_bindings/index.md deleted file mode 100644 index 5317c08182..0000000000 --- a/docs/google-docs/providers/google/apigateway/apis_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: apis_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - apis_iam_bindings - - apigateway - - 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 ---- - - - -## Overview - - - - -
Nameapis_iam_bindings
TypeResource
Idgoogle.apigateway.apis_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_getIamPolicy` | `SELECT` | `apisId, locationsId, 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 c727fe5ad8..bfc428c871 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 @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/configs/index.md b/docs/google-docs/providers/google/apigateway/configs/index.md index 9ee1b95883..93a7fabf35 100644 --- a/docs/google-docs/providers/google/apigateway/configs/index.md +++ b/docs/google-docs/providers/google/apigateway/configs/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the API Config. Format: projects/{project}/locations/global/apis/{api}/configs/{api_config} | -| `createTime` | `string` | Output only. Created time. | -| `displayName` | `string` | Optional. Display name. | -| `serviceConfigId` | `string` | Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config). | -| `gatewayServiceAccount` | `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. | -| `openapiDocuments` | `array` | Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. | -| `updateTime` | `string` | Output only. Updated time. | | `grpcServices` | `array` | Optional. gRPC service definition files. If specified, openapi_documents must not be included. | +| `displayName` | `string` | Optional. Display name. | | `managedServiceConfigs` | `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. | +| `updateTime` | `string` | Output only. Updated time. | | `labels` | `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 | +| `serviceConfigId` | `string` | Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config). | +| `gatewayServiceAccount` | `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. | | `state` | `string` | Output only. State of the API Config. | +| `createTime` | `string` | Output only. Created time. | +| `openapiDocuments` | `array` | Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/configs_iam_audit_configs/index.md b/docs/google-docs/providers/google/apigateway/configs_iam_audit_configs/index.md deleted file mode 100644 index e983534ac1..0000000000 --- a/docs/google-docs/providers/google/apigateway/configs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: configs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - configs_iam_audit_configs - - apigateway - - 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 ---- - - - -## Overview - - - - -
Nameconfigs_iam_audit_configs
TypeResource
Idgoogle.apigateway.configs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_configs_getIamPolicy` | `SELECT` | `apisId, configsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigateway/configs_iam_bindings/index.md b/docs/google-docs/providers/google/apigateway/configs_iam_bindings/index.md deleted file mode 100644 index 4e0995ef76..0000000000 --- a/docs/google-docs/providers/google/apigateway/configs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: configs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - configs_iam_bindings - - apigateway - - 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 ---- - - - -## Overview - - - - -
Nameconfigs_iam_bindings
TypeResource
Idgoogle.apigateway.configs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_configs_getIamPolicy` | `SELECT` | `apisId, configsId, locationsId, 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 643ebd87e9..f1e9ff325b 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 @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/gateways/index.md b/docs/google-docs/providers/google/apigateway/gateways/index.md index 4c02e792cd..2b473b2ee6 100644 --- a/docs/google-docs/providers/google/apigateway/gateways/index.md +++ b/docs/google-docs/providers/google/apigateway/gateways/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the Gateway. Format: projects/{project}/locations/{location}/gateways/{gateway} | -| `defaultHostname` | `string` | Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. | | `displayName` | `string` | Optional. Display name. | | `labels` | `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 | | `state` | `string` | Output only. The current state of the Gateway. | | `updateTime` | `string` | Output only. Updated time. | | `apiConfig` | `string` | Required. Resource name of the API Config for this Gateway. Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig} | | `createTime` | `string` | Output only. Created time. | +| `defaultHostname` | `string` | Output only. The default API Gateway host name of the form `{gateway_id}-{hash}.{region_code}.gateway.dev`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/gateways_iam_audit_configs/index.md b/docs/google-docs/providers/google/apigateway/gateways_iam_audit_configs/index.md deleted file mode 100644 index 56016aca63..0000000000 --- a/docs/google-docs/providers/google/apigateway/gateways_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: gateways_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - gateways_iam_audit_configs - - apigateway - - 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 ---- - - - -## Overview - - - - -
Namegateways_iam_audit_configs
TypeResource
Idgoogle.apigateway.gateways_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_gateways_getIamPolicy` | `SELECT` | `gatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigateway/gateways_iam_bindings/index.md b/docs/google-docs/providers/google/apigateway/gateways_iam_bindings/index.md deleted file mode 100644 index 8e1be82a43..0000000000 --- a/docs/google-docs/providers/google/apigateway/gateways_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: gateways_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - gateways_iam_bindings - - apigateway - - 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 ---- - - - -## Overview - - - - -
Namegateways_iam_bindings
TypeResource
Idgoogle.apigateway.gateways_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_gateways_getIamPolicy` | `SELECT` | `gatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigee/aliases/index.md b/docs/google-docs/providers/google/apigee/aliases/index.md index 6657ff9f31..2a017303e1 100644 --- a/docs/google-docs/providers/google/apigee/aliases/index.md +++ b/docs/google-docs/providers/google/apigee/aliases/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `certsInfo` | `object` | | | `type` | `string` | Type of alias. | | `alias` | `string` | Resource ID for this alias. Values must match the regular expression `[^/]{1,255}`. | +| `certsInfo` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 e6939f879b..fcba9dd556 100644 --- a/docs/google-docs/providers/google/apigee/aliases_certificate/index.md +++ b/docs/google-docs/providers/google/apigee/aliases_certificate/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | | `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | | `data` | `string` | The HTTP request/response body as raw binary. | -| `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/apicategories/index.md b/docs/google-docs/providers/google/apigee/apicategories/index.md index 163f7e83ce..b28c32694d 100644 --- a/docs/google-docs/providers/google/apigee/apicategories/index.md +++ b/docs/google-docs/providers/google/apigee/apicategories/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `message` | `string` | Description of the operation. | +| `requestId` | `string` | ID that can be used to find request details in the log files. | | `status` | `string` | Status of the operation. | | `data` | `object` | the Api category resource. | | `errorCode` | `string` | ID that can be used to find errors in the log files. | -| `message` | `string` | Description of the operation. | -| `requestId` | `string` | ID that can be used to find request details in the log files. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/apiproducts/index.md b/docs/google-docs/providers/google/apigee/apiproducts/index.md index 96ce963de6..0b67624a92 100644 --- a/docs/google-docs/providers/google/apigee/apiproducts/index.md +++ b/docs/google-docs/providers/google/apigee/apiproducts/index.md @@ -29,22 +29,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Internal name of the API product. Characters you can use in the name are restricted to: `A-Z0-9._\-$ %`. **Note:** The internal name cannot be edited when updating the API product. | | `description` | `string` | Description of the API product. Include key information about the API product that is not captured by other fields. | -| `operationGroup` | `object` | List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. | +| `scopes` | `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. | | `quota` | `string` | Number of request messages permitted per app by this API product for the specified `quotaInterval` and `quotaTimeUnit`. For example, a `quota` of 50, for a `quotaInterval` of 12 and a `quotaTimeUnit` of hours means 50 requests are allowed every 12 hours. | +| `quotaCounterScope` | `string` | Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself. | +| `attributes` | `array` | Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers. | | `approvalType` | `string` | Flag that specifies how API keys are approved to access the APIs defined by the API product. If set to `manual`, the consumer key is generated and returned in "pending" state. In this case, the API keys won't work until they have been explicitly approved. If set to `auto`, the consumer key is generated and returned in "approved" state and can be used immediately. **Note:** Typically, `auto` is used to provide access to free or trial API products that provide limited quota or capabilities. | -| `grpcOperationGroup` | `object` | List of gRPC operation configuration details associated with Apigee API proxies. | +| `lastModifiedAt` | `string` | Response only. Modified time of this environment as milliseconds since epoch. | +| `quotaInterval` | `string` | Time interval over which the number of request messages is calculated. | | `apiResources` | `array` | Comma-separated list of API resources to be bundled in the API product. By default, the resource paths are mapped from the `proxy.pathsuffix` variable. The proxy path suffix is defined as the URI fragment following the ProxyEndpoint base path. For example, if the `apiResources` element is defined to be `/forecastrss` and the base path defined for the API proxy is `/weather`, then only requests to `/weather/forecastrss` are permitted by the API product. You can select a specific path, or you can select all subpaths with the following wildcard: - `/**`: Indicates that all sub-URIs are included. - `/*` : Indicates that only URIs one level down are included. By default, / supports the same resources as /** as well as the base path defined by the API proxy. For example, if the base path of the API proxy is `/v1/weatherapikey`, then the API product supports requests to `/v1/weatherapikey` and to any sub-URIs, such as `/v1/weatherapikey/forecastrss`, `/v1/weatherapikey/region/CA`, and so on. For more information, see Managing API products. | +| `displayName` | `string` | Name displayed in the UI or developer portal to developers registering for API access. | +| `graphqlOperationGroup` | `object` | List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. | | `proxies` | `array` | Comma-separated list of API proxy names to which this API product is bound. By specifying API proxies, you can associate resources in the API product with specific API proxies, preventing developers from accessing those resources through other API proxies. Apigee rejects requests to API proxies that are not listed. **Note:** The API proxy names must already exist in the specified environment as they will be validated upon creation. | | `quotaTimeUnit` | `string` | Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`. | -| `createdAt` | `string` | Response only. Creation time of this environment as milliseconds since epoch. | -| `quotaInterval` | `string` | Time interval over which the number of request messages is calculated. | -| `attributes` | `array` | Array of attributes that may be used to extend the default API product profile with customer-specific metadata. You can specify a maximum of 18 attributes. Use this property to specify the access level of the API product as either `public`, `private`, or `internal`. Only products marked `public` are available to developers in the Apigee developer portal. For example, you can set a product to `internal` while it is in development and then change access to `public` when it is ready to release on the portal. API products marked as `private` do not appear on the portal, but can be accessed by external developers. | -| `graphqlOperationGroup` | `object` | List of graphQL operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. | -| `scopes` | `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. | -| `quotaCounterScope` | `string` | Scope of the quota decides how the quota counter gets applied and evaluate for quota violation. If the Scope is set as PROXY, then all the operations defined for the APIproduct that are associated with the same proxy will share the same quota counter set at the APIproduct level, making it a global counter at a proxy level. If the Scope is set as OPERATION, then each operations get the counter set at the API product dedicated, making it a local counter. Note that, the QuotaCounterScope applies only when an operation does not have dedicated quota set for itself. | +| `grpcOperationGroup` | `object` | List of gRPC operation configuration details associated with Apigee API proxies. | +| `operationGroup` | `object` | List of operation configuration details associated with Apigee API proxies or remote services. Remote services are non-Apigee proxies, such as Istio-Envoy. | | `environments` | `array` | Comma-separated list of environment names to which the API product is bound. Requests to environments that are not listed are rejected. By specifying one or more environments, you can bind the resources listed in the API product to a specific environment, preventing developers from accessing those resources through API proxies deployed in another environment. This setting is used, for example, to prevent resources associated with API proxies in `prod` from being accessed by API proxies deployed in `test`. | -| `lastModifiedAt` | `string` | Response only. Modified time of this environment as milliseconds since epoch. | -| `displayName` | `string` | Name displayed in the UI or developer portal to developers registering for API access. | +| `createdAt` | `string` | Response only. Creation time of this environment as milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/appgroups/index.md b/docs/google-docs/providers/google/apigee/appgroups/index.md index b4bcb153f7..7968d56aab 100644 --- a/docs/google-docs/providers/google/apigee/appgroups/index.md +++ b/docs/google-docs/providers/google/apigee/appgroups/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. | +| `displayName` | `string` | app group name displayed in the UI | | `channelUri` | `string` | A reference to the associated storefront/marketplace. | -| `organization` | `string` | Immutable. the org the app group is created | +| `attributes` | `array` | A list of attributes | +| `createdAt` | `string` | Output only. Created time as milliseconds since epoch. | | `status` | `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`. | | `lastModifiedAt` | `string` | Output only. Modified time as milliseconds since epoch. | -| `attributes` | `array` | A list of attributes | | `channelId` | `string` | channel identifier identifies the owner maintaing this grouping. | -| `displayName` | `string` | app group name displayed in the UI | +| `organization` | `string` | Immutable. the org the app group is created | | `appGroupId` | `string` | Output only. Internal identifier that cannot be edited | -| `createdAt` | `string` | Output only. Created time as milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/apps/index.md b/docs/google-docs/providers/google/apigee/apps/index.md index a6b20c2c7d..07d1115170 100644 --- a/docs/google-docs/providers/google/apigee/apps/index.md +++ b/docs/google-docs/providers/google/apigee/apps/index.md @@ -28,19 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the app. | -| `status` | `string` | Status of the credential. | -| `keyExpiresIn` | `string` | Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn | -| `apiProducts` | `array` | List of API products associated with the app. | -| `attributes` | `array` | List of attributes. | -| `developerId` | `string` | ID of the developer. | | `appId` | `string` | ID of the app. | | `credentials` | `array` | Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products. | -| `callbackUrl` | `string` | Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. | -| `companyName` | `string` | Name of the company that owns the app. | -| `developerEmail` | `string` | Email of the developer. | +| `developerId` | `string` | ID of the developer. | +| `attributes` | `array` | List of attributes. | +| `keyExpiresIn` | `string` | Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn | | `scopes` | `array` | Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app. | -| `createdAt` | `string` | Output only. Unix time when the app was created. | +| `status` | `string` | Status of the credential. | +| `apiProducts` | `array` | List of API products associated with the app. | | `lastModifiedAt` | `string` | Output only. Last modified time as milliseconds since epoch. | +| `createdAt` | `string` | Output only. Unix time when the app was created. | +| `callbackUrl` | `string` | Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. | +| `developerEmail` | `string` | Email of the developer. | +| `companyName` | `string` | Name of the company that owns the app. | | `appGroup` | `string` | Name of the AppGroup | ## Methods | Name | Accessible by | Required Params | Description | 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 f336abad7b..07a5280853 100644 --- a/docs/google-docs/providers/google/apigee/archive_deployments/index.md +++ b/docs/google-docs/providers/google/apigee/archive_deployments/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the Archive Deployment in the following format: `organizations/{org}/environments/{env}/archiveDeployments/{id}`. | -| `createdAt` | `string` | Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. | | `gcsUri` | `string` | Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. | | `labels` | `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. | | `operation` | `string` | Output only. A reference to the LRO that created this Archive Deployment in the following format: `organizations/{org}/operations/{id}` | | `updatedAt` | `string` | Output only. The time at which the Archive Deployment was updated in milliseconds since the epoch. | +| `createdAt` | `string` | Output only. The time at which the Archive Deployment was created in milliseconds since the epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md index 4018327be8..2f3491e404 100644 --- a/docs/google-docs/providers/google/apigee/canaryevaluations/index.md +++ b/docs/google-docs/providers/google/apigee/canaryevaluations/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the canary evalution. | -| `verdict` | `string` | Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. | | `treatment` | `string` | Required. The newer version that is serving requests. | +| `endTime` | `string` | Required. End time for the evaluation's analysis. | +| `control` | `string` | Required. The stable version that is serving requests. | | `createTime` | `string` | Output only. Create time of the canary evaluation. | -| `metricLabels` | `object` | Labels that can be used to filter Apigee metrics. | | `startTime` | `string` | Required. Start time for the canary evaluation's analysis. | -| `control` | `string` | Required. The stable version that is serving requests. | +| `metricLabels` | `object` | Labels that can be used to filter Apigee metrics. | +| `verdict` | `string` | Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. | | `state` | `string` | Output only. The current state of the canary evaluation. | -| `endTime` | `string` | Required. End time for the evaluation's analysis. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/datastores/index.md b/docs/google-docs/providers/google/apigee/datastores/index.md index 93575e80e1..e724f87f13 100644 --- a/docs/google-docs/providers/google/apigee/datastores/index.md +++ b/docs/google-docs/providers/google/apigee/datastores/index.md @@ -27,13 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `displayName` | `string` | Required. Display name in UI | +| `lastUpdateTime` | `string` | Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z | +| `org` | `string` | Output only. Organization that the datastore belongs to | | `self` | `string` | Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` | | `targetType` | `string` | Destination storage type. Supported types `gcs` or `bigquery`. | | `createTime` | `string` | Output only. Datastore create time, in milliseconds since the epoch of 1970-01-01T00:00:00Z | | `datastoreConfig` | `object` | Configuration detail for datastore | -| `displayName` | `string` | Required. Display name in UI | -| `lastUpdateTime` | `string` | Output only. Datastore last update time, in milliseconds since the epoch of 1970-01-01T00:00:00Z | -| `org` | `string` | Output only. Organization that the datastore belongs to | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 134f94db01..76c0f82419 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 @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`. | +| `environmentGroups` | `array` | List of environment groups in the organization. | | `revisionCreateTime` | `string` | Time at which the IngressConfig revision was created. | | `revisionId` | `string` | Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed. | | `uid` | `string` | A unique id for the ingress config that will only change if the organization is deleted and recreated. | -| `environmentGroups` | `array` | List of environment groups in the organization. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/developers/index.md b/docs/google-docs/providers/google/apigee/developers/index.md index f363b273e2..13a6fc5063 100644 --- a/docs/google-docs/providers/google/apigee/developers/index.md +++ b/docs/google-docs/providers/google/apigee/developers/index.md @@ -27,20 +27,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `appFamily` | `string` | Developer app family. | -| `lastName` | `string` | Required. Last name of the developer. | +| `apps` | `array` | List of apps associated with the developer. | | `developerId` | `string` | ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time. | -| `status` | `string` | Output only. Status of the developer. Valid values are `active` and `inactive`. | -| `companies` | `array` | List of companies associated with the developer. | +| `organizationName` | `string` | Output only. Name of the Apigee organization in which the developer resides. | | `email` | `string` | Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only. | +| `firstName` | `string` | Required. First name of the developer. | +| `accessType` | `string` | Access type. | +| `appFamily` | `string` | Developer app family. | +| `lastName` | `string` | Required. Last name of the developer. | | `userName` | `string` | Required. User name of the developer. Not used by Apigee hybrid. | -| `apps` | `array` | List of apps associated with the developer. | -| `organizationName` | `string` | Output only. Name of the Apigee organization in which the developer resides. | -| `createdAt` | `string` | Output only. Time at which the developer was created in milliseconds since epoch. | +| `companies` | `array` | List of companies associated with the developer. | +| `status` | `string` | Output only. Status of the developer. Valid values are `active` and `inactive`. | | `attributes` | `array` | Optional. Developer attributes (name/value pairs). The custom attribute limit is 18. | +| `createdAt` | `string` | Output only. Time at which the developer was created in milliseconds since epoch. | | `lastModifiedAt` | `string` | Output only. Time at which the developer was last modified in milliseconds since epoch. | -| `accessType` | `string` | Access type. | -| `firstName` | `string` | Required. First name of the developer. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 4b11c4a915..6ce47dded7 100644 --- a/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md +++ b/docs/google-docs/providers/google/apigee/endpoint_attachments/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the endpoint attachment. Use the following structure in your request: `organizations/{org}/endpointAttachments/{endpoint_attachment}` | +| `state` | `string` | Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use. | +| `connectionState` | `string` | Output only. State of the endpoint attachment connection to the service attachment. | | `host` | `string` | Output only. Host that can be used in either the HTTP target endpoint directly or as the host in target server. | | `location` | `string` | Required. Location of the endpoint attachment. | | `serviceAttachment` | `string` | Format: projects/*/regions/*/serviceAttachments/* | -| `state` | `string` | Output only. State of the endpoint attachment. Values other than `ACTIVE` mean the resource is not ready to use. | -| `connectionState` | `string` | Output only. State of the endpoint attachment connection to the service attachment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/envgroups/index.md b/docs/google-docs/providers/google/apigee/envgroups/index.md index bcc56432bd..e53e655aad 100644 --- a/docs/google-docs/providers/google/apigee/envgroups/index.md +++ b/docs/google-docs/providers/google/apigee/envgroups/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | ID of the environment group. | -| `hostnames` | `array` | Required. Host names for this environment group. | -| `lastModifiedAt` | `string` | Output only. The time at which the environment group was last updated as milliseconds since epoch. | | `state` | `string` | Output only. State of the environment group. Values other than ACTIVE means the resource is not ready to use. | | `createdAt` | `string` | Output only. The time at which the environment group was created as milliseconds since epoch. | +| `hostnames` | `array` | Required. Host names for this environment group. | +| `lastModifiedAt` | `string` | Output only. The time at which the environment group was last updated as milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 9b57cdec52..57f7608e70 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 @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the environment group in the following format: `organizations/{org}/envgroups/{envgroup}`. | -| `hostnames` | `array` | Host names for the environment group. | -| `location` | `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. | | `revisionId` | `string` | Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed. | | `routingRules` | `array` | Ordered list of routing rules defining how traffic to this environment group's hostnames should be routed to different environments. | | `uid` | `string` | A unique id for the environment group config that will only change if the environment group is deleted and recreated. | | `endpointChainingRules` | `array` | A list of proxies in each deployment group for proxy chaining calls. | +| `hostnames` | `array` | Host names for the environment group. | +| `location` | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/environments/index.md b/docs/google-docs/providers/google/apigee/environments/index.md index bd8c726718..e5164dcd55 100644 --- a/docs/google-docs/providers/google/apigee/environments/index.md +++ b/docs/google-docs/providers/google/apigee/environments/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the environment. Values must match the regular expression `^[.\\p{Alnum}-_]{1,255}$` | | `description` | `string` | Optional. Description of the environment. | -| `state` | `string` | Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. | -| `nodeConfig` | `object` | NodeConfig for setting the min/max number of nodes associated with the environment. | -| `deploymentType` | `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 | | `lastModifiedAt` | `string` | Output only. Last modification time of this environment as milliseconds since epoch. | -| `hasAttachedFlowHooks` | `boolean` | | +| `deploymentType` | `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 | | `apiProxyType` | `string` | Optional. API Proxy type supported by the environment. The type can be set when creating the Environment and cannot be changed. | -| `forwardProxyUri` | `string` | Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied. | -| `displayName` | `string` | Optional. Display name for this environment. | -| `createdAt` | `string` | Output only. Creation time of this environment as milliseconds since epoch. | | `properties` | `object` | Message for compatibility with legacy Edge specification for Java Properties object in JSON. | +| `createdAt` | `string` | Output only. Creation time of this environment as milliseconds since epoch. | +| `displayName` | `string` | Optional. Display name for this environment. | +| `hasAttachedFlowHooks` | `boolean` | | +| `nodeConfig` | `object` | NodeConfig for setting the min/max number of nodes associated with the environment. | +| `forwardProxyUri` | `string` | Optional. Url 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 scheme must be one of "http" or "https", and port must be supplied. | +| `state` | `string` | Output only. State of the environment. Values other than ACTIVE means the resource is not ready to use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/environments_iam_audit_configs/index.md b/docs/google-docs/providers/google/apigee/environments_iam_audit_configs/index.md deleted file mode 100644 index d075045071..0000000000 --- a/docs/google-docs/providers/google/apigee/environments_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: environments_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - environments_iam_audit_configs - - 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 ---- - - - -## Overview - - - - -
Nameenvironments_iam_audit_configs
TypeResource
Idgoogle.apigee.environments_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_environments_getIamPolicy` | `SELECT` | `environmentsId, organizationsId` | diff --git a/docs/google-docs/providers/google/apigee/environments_iam_bindings/index.md b/docs/google-docs/providers/google/apigee/environments_iam_bindings/index.md deleted file mode 100644 index 5c22d8aaf1..0000000000 --- a/docs/google-docs/providers/google/apigee/environments_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: environments_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - environments_iam_bindings - - 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 ---- - - - -## Overview - - - - -
Nameenvironments_iam_bindings
TypeResource
Idgoogle.apigee.environments_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_environments_getIamPolicy` | `SELECT` | `environmentsId, 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 45de893fd4..20ee0bc125 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 @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 757473b813..526935372b 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 @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `endpoint` | `string` | Required. Endpoint of the exporter. | | `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. | | `samplingConfig` | `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. | +| `endpoint` | `string` | Required. Endpoint of the exporter. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 a036459829..1070c2d315 100644 --- a/docs/google-docs/providers/google/apigee/host_queries/index.md +++ b/docs/google-docs/providers/google/apigee/host_queries/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Asynchronous Query Name. | -| `resultRows` | `string` | ResultRows is available only after the query is completed. | -| `reportDefinitionId` | `string` | Asynchronous Report ID. | -| `updated` | `string` | Last updated timestamp for the query. | -| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | | `result` | `object` | | -| `self` | `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` | -| `created` | `string` | Creation time of the query. | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `queryParams` | `object` | | +| `resultRows` | `string` | ResultRows is available only after the query is completed. | | `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | | `error` | `string` | Error is set when query fails. | -| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `created` | `string` | Creation time of the query. | +| `self` | `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` | +| `updated` | `string` | Last updated timestamp for the query. | +| `reportDefinitionId` | `string` | Asynchronous Report ID. | | `state` | `string` | Query state could be "enqueued", "running", "completed", "failed". | -| `queryParams` | `object` | | +| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/host_queries_result/index.md b/docs/google-docs/providers/google/apigee/host_queries_result/index.md index 79057baea7..20a39b21c6 100644 --- a/docs/google-docs/providers/google/apigee/host_queries_result/index.md +++ b/docs/google-docs/providers/google/apigee/host_queries_result/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | | `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | | `data` | `string` | The HTTP request/response body as raw binary. | -| `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md b/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md index 6f2e684ee0..a1a433e5fd 100644 --- a/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md +++ b/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `error` | `string` | Error message when there is a failure. | +| `metadata` | `object` | | | `rows` | `array` | Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | | `state` | `string` | State of retrieving ResultView. | | `code` | `integer` | Error code when there is a failure. | -| `error` | `string` | Error message when there is a failure. | -| `metadata` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/host_security_reports/index.md b/docs/google-docs/providers/google/apigee/host_security_reports/index.md index af2f9fbd5a..7e09c4a573 100644 --- a/docs/google-docs/providers/google/apigee/host_security_reports/index.md +++ b/docs/google-docs/providers/google/apigee/host_security_reports/index.md @@ -27,19 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `updated` | `string` | Output only. Last updated timestamp for the query. | +| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `queryParams` | `object` | Metadata for the security report. | | `result` | `object` | Contains informations about the security report results. | -| `created` | `string` | Creation time of the query. | -| `error` | `string` | Error is set when query fails. | -| `resultRows` | `string` | ResultRows is available only after the query is completed. | | `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `created` | `string` | Creation time of the query. | +| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | | `displayName` | `string` | Display Name specified by the user. | -| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `resultRows` | `string` | ResultRows is available only after the query is completed. | | `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | -| `updated` | `string` | Output only. Last updated timestamp for the query. | -| `queryParams` | `object` | Metadata for the security report. | +| `error` | `string` | Error is set when query fails. | | `reportDefinitionId` | `string` | Report Definition ID. | -| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md b/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md index 19d450b885..d9b1d284cf 100644 --- a/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md +++ b/docs/google-docs/providers/google/apigee/host_security_reports_result_view/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `error` | `string` | Error message when there is a failure. | | `metadata` | `object` | Metadata for the security report. | | `rows` | `array` | Rows of security report result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | | `state` | `string` | State of retrieving ResultView. | | `code` | `integer` | Error code when there is a failure. | +| `error` | `string` | Error message when there is a failure. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/host_stats/index.md b/docs/google-docs/providers/google/apigee/host_stats/index.md index ad0e4ebbd0..d76d13a282 100644 --- a/docs/google-docs/providers/google/apigee/host_stats/index.md +++ b/docs/google-docs/providers/google/apigee/host_stats/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `environments` | `array` | List of query results on the environment level. | | `hosts` | `array` | List of query results grouped by host. | | `metaData` | `object` | Encapsulates additional information about query execution. | +| `environments` | `array` | List of query results on the environment level. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/instances/index.md b/docs/google-docs/providers/google/apigee/instances/index.md index d6dc4b000e..7c88502c51 100644 --- a/docs/google-docs/providers/google/apigee/instances/index.md +++ b/docs/google-docs/providers/google/apigee/instances/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Resource ID of the instance. Values must match the regular expression `^a-z{0,30}[a-z\d]$`. | | `description` | `string` | Optional. Description of the instance. | -| `createdAt` | `string` | Output only. Time the instance was created in milliseconds since epoch. | -| `location` | `string` | Required. Compute Engine location where the instance resides. | -| `peeringCidrRange` | `string` | Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. | -| `consumerAcceptList` | `array` | Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list. | -| `state` | `string` | Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. | -| `host` | `string` | Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. | -| `diskEncryptionKeyName` | `string` | Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` | | `runtimeVersion` | `string` | Output only. Version of the runtime system running in the instance. The runtime system is the set of components that serve the API Proxy traffic in your Environments. | +| `state` | `string` | Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. | | `ipRange` | `string` | Optional. Comma-separated list of CIDR blocks of length 22 and/or 28 used to create the Apigee instance. Providing CIDR ranges is optional. You can provide just /22 or /28 or both (or neither). Ranges you provide should be freely available as part of a larger named range you have allocated to the Service Networking peering. If this parameter is not provided, Apigee automatically requests an available /22 and /28 CIDR block from Service Networking. Use the /22 CIDR block for configuring your firewall needs to allow traffic from Apigee. Input formats: `a.b.c.d/22` or `e.f.g.h/28` or `a.b.c.d/22,e.f.g.h/28` | -| `port` | `string` | Output only. Port number of the exposed Apigee endpoint. | +| `location` | `string` | Required. Compute Engine location where the instance resides. | | `displayName` | `string` | Optional. Display name for the instance. | +| `createdAt` | `string` | Output only. Time the instance was created in milliseconds since epoch. | +| `diskEncryptionKeyName` | `string` | Customer Managed Encryption Key (CMEK) used for disk and volume encryption. Required for Apigee paid subscriptions only. Use the following format: `projects/([^/]+)/locations/([^/]+)/keyRings/([^/]+)/cryptoKeys/([^/]+)` | | `lastModifiedAt` | `string` | Output only. Time the instance was last modified in milliseconds since epoch. | +| `peeringCidrRange` | `string` | Optional. Size of the CIDR block range that will be reserved by the instance. PAID organizations support `SLASH_16` to `SLASH_20` and defaults to `SLASH_16`. Evaluation organizations support only `SLASH_23`. | +| `host` | `string` | Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. | | `serviceAttachment` | `string` | Output only. Resource name of the service attachment created for the instance in the format: `projects/*/regions/*/serviceAttachments/*` Apigee customers can privately forward traffic to this service attachment using the PSC endpoints. | +| `consumerAcceptList` | `array` | Optional. Customer accept list represents the list of projects (id/number) on customer side that can privately connect to the service attachment. It is an optional field which the customers can provide during the instance creation. By default, the customer project associated with the Apigee organization will be included to the list. | +| `port` | `string` | Output only. Port number of the exposed Apigee endpoint. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/keys/index.md b/docs/google-docs/providers/google/apigee/keys/index.md index 9314485140..2b9b1db2cc 100644 --- a/docs/google-docs/providers/google/apigee/keys/index.md +++ b/docs/google-docs/providers/google/apigee/keys/index.md @@ -27,15 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `attributes` | `array` | List of attributes associated with the credential. | +| `status` | `string` | Status of the credential. Valid values include `approved` or `revoked`. | | `scopes` | `array` | Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app. | +| `consumerSecret` | `string` | Secret key. | | `apiProducts` | `array` | List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created. | +| `issuedAt` | `string` | Time the developer app was created in milliseconds since epoch. | +| `attributes` | `array` | List of attributes associated with the credential. | +| `expiresAt` | `string` | Time the developer app expires in milliseconds since epoch. | | `consumerKey` | `string` | Consumer key. | -| `status` | `string` | Status of the credential. Valid values include `approved` or `revoked`. | | `expiresInSeconds` | `string` | Input only. Expiration time, in seconds, for the consumer key. 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. | -| `consumerSecret` | `string` | Secret key. | -| `expiresAt` | `string` | Time the developer app expires in milliseconds since epoch. | -| `issuedAt` | `string` | Time the developer app was created in milliseconds since epoch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/nat_addresses/index.md b/docs/google-docs/providers/google/apigee/nat_addresses/index.md index a0b57d546c..04f4860396 100644 --- a/docs/google-docs/providers/google/apigee/nat_addresses/index.md +++ b/docs/google-docs/providers/google/apigee/nat_addresses/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Resource ID of the NAT address. | -| `ipAddress` | `string` | Output only. The static IPV4 address. | | `state` | `string` | Output only. State of the nat address. | +| `ipAddress` | `string` | Output only. The static IPV4 address. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/operations/index.md b/docs/google-docs/providers/google/apigee/operations/index.md index 66f87b5914..3e8ea83ca2 100644 --- a/docs/google-docs/providers/google/apigee/operations/index.md +++ b/docs/google-docs/providers/google/apigee/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/organizations_deployed_ingress_config/index.md b/docs/google-docs/providers/google/apigee/organizations_deployed_ingress_config/index.md deleted file mode 100644 index 3b00248d57..0000000000 --- a/docs/google-docs/providers/google/apigee/organizations_deployed_ingress_config/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: organizations_deployed_ingress_config -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_deployed_ingress_config - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_deployed_ingress_config
TypeResource
Idgoogle.apigee.organizations_deployed_ingress_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Name of the resource in the following format: `organizations/{org}/deployedIngressConfig`. | -| `revisionCreateTime` | `string` | Time at which the IngressConfig revision was created. | -| `revisionId` | `string` | Revision id that defines the ordering on IngressConfig resources. The higher the revision, the more recently the configuration was deployed. | -| `uid` | `string` | A unique id for the ingress config that will only change if the organization is deleted and recreated. | -| `environmentGroups` | `array` | List of environment groups in the organization. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getDeployedIngressConfig` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/apigee/organizations_project_mapping/index.md b/docs/google-docs/providers/google/apigee/organizations_project_mapping/index.md deleted file mode 100644 index 52f95043f8..0000000000 --- a/docs/google-docs/providers/google/apigee/organizations_project_mapping/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: organizations_project_mapping -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_project_mapping - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_project_mapping
TypeResource
Idgoogle.apigee.organizations_project_mapping
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `projectIds` | `array` | DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a single project. | -| `location` | `string` | Output only. The Google Cloud region where control plane data is located. For more information, see https://cloud.google.com/about/locations/. | -| `organization` | `string` | Name of the Apigee organization. | -| `projectId` | `string` | Google Cloud project associated with the Apigee organization | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getProjectMapping` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/apigee/organizations_runtime_config/index.md b/docs/google-docs/providers/google/apigee/organizations_runtime_config/index.md deleted file mode 100644 index f1643d0ccc..0000000000 --- a/docs/google-docs/providers/google/apigee/organizations_runtime_config/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: organizations_runtime_config -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_runtime_config - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_runtime_config
TypeResource
Idgoogle.apigee.organizations_runtime_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Name of the resource in the following format: `organizations/{org}/runtimeConfig`. | -| `traceBucket` | `string` | Cloud Storage bucket used for uploading Trace records. | -| `analyticsBucket` | `string` | Cloud Storage bucket used for uploading Analytics records. | -| `tenantProjectId` | `string` | Output only. Tenant project ID associated with the Apigee organization. The tenant project is used to host Google-managed resources that are dedicated to this Apigee organization. Clients have limited access to resources within the tenant project used to support Apigee runtime instances. Access to the tenant project is managed using SetSyncAuthorization. It can be empty if the tenant project hasn't been created yet. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getRuntimeConfig` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/apigee/organizations_sync_authorization/index.md b/docs/google-docs/providers/google/apigee/organizations_sync_authorization/index.md deleted file mode 100644 index 0a640247db..0000000000 --- a/docs/google-docs/providers/google/apigee/organizations_sync_authorization/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: organizations_sync_authorization -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_sync_authorization - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_sync_authorization
TypeResource
Idgoogle.apigee.organizations_sync_authorization
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `etag` | `string` | Entity tag (ETag) used for optimistic concurrency control as a way to help prevent simultaneous updates from overwriting each other. For example, when you call [getSyncAuthorization](organizations/getSyncAuthorization) an ETag is returned in the response. Pass that ETag when calling the [setSyncAuthorization](organizations/setSyncAuthorization) to ensure that you are updating the correct version. If you don't pass the ETag in the call to `setSyncAuthorization`, then the existing authorization is overwritten indiscriminately. **Note**: We strongly recommend that you use the ETag in the read-modify-write cycle to avoid race conditions. | -| `identities` | `array` | Required. Array of service accounts to grant access to control plane resources, each specified using the following format: `serviceAccount:` service-account-name. The service-account-name is formatted like an email address. For example: `my-synchronizer-manager-service_account@my_project_id.iam.gserviceaccount.com` You might specify multiple service accounts, for example, if you have multiple environments and wish to assign a unique service account to each one. The service accounts must have **Apigee Synchronizer Manager** role. See also [Create service accounts](https://cloud.google.com/apigee/docs/hybrid/latest/sa-about#create-the-service-accounts). | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getSyncAuthorization` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/apigee/overrides/index.md b/docs/google-docs/providers/google/apigee/overrides/index.md index f4e36f223c..453078adbd 100644 --- a/docs/google-docs/providers/google/apigee/overrides/index.md +++ b/docs/google-docs/providers/google/apigee/overrides/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | ID of the trace configuration override specified as a system-generated UUID. | -| `apiProxy` | `string` | ID of the API proxy that will have its trace configuration overridden. | | `samplingConfig` | `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. | +| `apiProxy` | `string` | ID of the API proxy that will have its trace configuration overridden. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/project_mapping/index.md b/docs/google-docs/providers/google/apigee/project_mapping/index.md index 0688a688f3..657696c580 100644 --- a/docs/google-docs/providers/google/apigee/project_mapping/index.md +++ b/docs/google-docs/providers/google/apigee/project_mapping/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `organization` | `string` | Name of the Apigee organization. | | `projectId` | `string` | Google Cloud project associated with the Apigee organization | | `projectIds` | `array` | DEPRECATED: Use `project_id`. An Apigee Organization is mapped to a single project. | | `location` | `string` | Output only. The Google Cloud region where control plane data is located. For more information, see https://cloud.google.com/about/locations/. | +| `organization` | `string` | Name of the Apigee organization. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/queries/index.md b/docs/google-docs/providers/google/apigee/queries/index.md index c0cd9c887e..0fccd09a3d 100644 --- a/docs/google-docs/providers/google/apigee/queries/index.md +++ b/docs/google-docs/providers/google/apigee/queries/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Asynchronous Query Name. | +| `created` | `string` | Creation time of the query. | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | | `reportDefinitionId` | `string` | Asynchronous Report ID. | -| `self` | `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` | -| `error` | `string` | Error is set when query fails. | +| `updated` | `string` | Last updated timestamp for the query. | | `executionTime` | `string` | ExecutionTime is available only after the query is completed. | | `result` | `object` | | +| `self` | `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` | +| `state` | `string` | Query state could be "enqueued", "running", "completed", "failed". | +| `error` | `string` | Error is set when query fails. | | `queryParams` | `object` | | -| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | -| `updated` | `string` | Last updated timestamp for the query. | -| `created` | `string` | Creation time of the query. | -| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | | `resultRows` | `string` | ResultRows is available only after the query is completed. | -| `state` | `string` | Query state could be "enqueued", "running", "completed", "failed". | +| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/queries_result/index.md b/docs/google-docs/providers/google/apigee/queries_result/index.md index 49d4db0016..12717141d4 100644 --- a/docs/google-docs/providers/google/apigee/queries_result/index.md +++ b/docs/google-docs/providers/google/apigee/queries_result/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `data` | `string` | The HTTP request/response body as raw binary. | | `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | | `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | -| `data` | `string` | The HTTP request/response body as raw binary. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/reports/index.md b/docs/google-docs/providers/google/apigee/reports/index.md index ce3a988aa7..945e97d2bb 100644 --- a/docs/google-docs/providers/google/apigee/reports/index.md +++ b/docs/google-docs/providers/google/apigee/reports/index.md @@ -28,27 +28,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Unique identifier for the report T his is a legacy field used to encode custom report unique id | -| `lastViewedAt` | `string` | Output only. Last viewed time of this entity as milliseconds since epoch | -| `metrics` | `array` | Required. This contains the list of metrics | -| `organization` | `string` | Output only. Organization name | -| `topk` | `string` | Legacy field: not used. This field contains the top k parameter value for restricting the result | -| `createdAt` | `string` | Output only. Unix time when the app was created json key: createdAt | -| `comments` | `array` | Legacy field: not used. This field contains a list of comments associated with custom report | -| `dimensions` | `array` | This contains the list of dimensions for the report | +| `sortByCols` | `array` | Legacy field: not used much. Contains the list of sort by columns | +| `tags` | `array` | Legacy field: not used. This field contains a list of tags associated with custom report | +| `offset` | `string` | Legacy field: not used. This field contains the offset for the data | +| `fromTime` | `string` | Legacy field: not used. Contains the from time for the report | | `limit` | `string` | Legacy field: not used This field contains the limit for the result retrieved | +| `chartType` | `string` | This field contains the chart type for the report | | `displayName` | `string` | This is the display name for the report | -| `tags` | `array` | Legacy field: not used. This field contains a list of tags associated with custom report | | `lastModifiedAt` | `string` | Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt | -| `environment` | `string` | Output only. Environment name | -| `filter` | `string` | This field contains the filter expression | -| `sortByCols` | `array` | Legacy field: not used much. Contains the list of sort by columns | | `properties` | `array` | This field contains report properties such as ui metadata etc. | -| `fromTime` | `string` | Legacy field: not used. Contains the from time for the report | +| `organization` | `string` | Output only. Organization name | +| `environment` | `string` | Output only. Environment name | +| `lastViewedAt` | `string` | Output only. Last viewed time of this entity as milliseconds since epoch | +| `createdAt` | `string` | Output only. Unix time when the app was created json key: createdAt | +| `topk` | `string` | Legacy field: not used. This field contains the top k parameter value for restricting the result | +| `metrics` | `array` | Required. This contains the list of metrics | +| `dimensions` | `array` | This contains the list of dimensions for the report | | `sortOrder` | `string` | Legacy field: not used much. Contains the sort order for the sort columns | | `toTime` | `string` | Legacy field: not used. Contains the end time for the report | | `timeUnit` | `string` | This field contains the time unit of aggregation for the report | -| `offset` | `string` | Legacy field: not used. This field contains the offset for the data | -| `chartType` | `string` | This field contains the chart type for the report | +| `filter` | `string` | This field contains the filter expression | +| `comments` | `array` | Legacy field: not used. This field contains a list of comments associated with custom report | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/revisions/index.md b/docs/google-docs/providers/google/apigee/revisions/index.md index d9e3387e21..7863a24a7a 100644 --- a/docs/google-docs/providers/google/apigee/revisions/index.md +++ b/docs/google-docs/providers/google/apigee/revisions/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | | `data` | `string` | The HTTP request/response body as raw binary. | | `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | -| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/revisions_deployments/index.md b/docs/google-docs/providers/google/apigee/revisions_deployments/index.md index efc88c4a7d..0699b31a3e 100644 --- a/docs/google-docs/providers/google/apigee/revisions_deployments/index.md +++ b/docs/google-docs/providers/google/apigee/revisions_deployments/index.md @@ -27,16 +27,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `routeConflicts` | `array` | Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status. | +| `serviceAccount` | `string` | The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. | | `environment` | `string` | Environment. | -| `revision` | `string` | API proxy revision. | +| `state` | `string` | Current state of the deployment. **Note**: This field is displayed only when viewing deployment status. | +| `apiProxy` | `string` | API proxy. | | `errors` | `array` | Errors reported for this deployment. Populated only when state == ERROR. **Note**: This field is displayed only when viewing deployment status. | +| `deployStartTime` | `string` | Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. | | `pods` | `array` | Status reported by runtime pods. **Note**: **This field is deprecated**. Runtime versions 1.3 and above report instance level status rather than pod status. | +| `routeConflicts` | `array` | Conflicts in the desired state routing configuration. The presence of conflicts does not cause the state to be `ERROR`, but it will mean that some of the deployment's base paths are not routed to its environment. If the conflicts change, the state will transition to `PROGRESSING` until the latest configuration is rolled out to all instances. **Note**: This field is displayed only when viewing deployment status. | | `instances` | `array` | Status reported by each runtime instance. **Note**: This field is displayed only when viewing deployment status. | -| `apiProxy` | `string` | API proxy. | -| `deployStartTime` | `string` | Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. | -| `state` | `string` | Current state of the deployment. **Note**: This field is displayed only when viewing deployment status. | -| `serviceAccount` | `string` | The full resource name of Cloud IAM Service Account that this deployment is using, eg, `projects/-/serviceAccounts/{email}`. | +| `revision` | `string` | API proxy revision. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/security_incidents/index.md b/docs/google-docs/providers/google/apigee/security_incidents/index.md index ef25d08c77..db63bccfc4 100644 --- a/docs/google-docs/providers/google/apigee/security_incidents/index.md +++ b/docs/google-docs/providers/google/apigee/security_incidents/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. Name of the security incident resource. Format: organizations/{org}/environments/{environment}/securityIncidents/{incident} Example: organizations/apigee-org/environments/dev/securityIncidents/1234-5678-9101-1111 | -| `firstDetectedTime` | `string` | Output only. The time when events associated with the incident were first detected. | -| `lastDetectedTime` | `string` | Output only. The time when events associated with the incident were last detected. | | `riskLevel` | `string` | Output only. Risk level of the incident. | | `trafficCount` | `string` | Total traffic detected as part of the incident. | | `detectionTypes` | `array` | Output only. Detection types which are part of the incident. Examples: Flooder, OAuth Abuser, Static Content Scraper, Anomaly Detection. | | `displayName` | `string` | Display name of the security incident. | +| `firstDetectedTime` | `string` | Output only. The time when events associated with the incident were first detected. | +| `lastDetectedTime` | `string` | Output only. The time when events associated with the incident were last detected. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/security_profiles/index.md b/docs/google-docs/providers/google/apigee/security_profiles/index.md index 25404181c8..818c5090e8 100644 --- a/docs/google-docs/providers/google/apigee/security_profiles/index.md +++ b/docs/google-docs/providers/google/apigee/security_profiles/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} | | `description` | `string` | Description of the security profile. | +| `revisionUpdateTime` | `string` | Output only. The time when revision was updated. | | `maxScore` | `integer` | Output only. Maximum security score that can be generated by this profile. | | `revisionId` | `string` | Output only. Revision ID of the security profile. | -| `revisionUpdateTime` | `string` | Output only. The time when revision was updated. | -| `minScore` | `integer` | Output only. Minimum security score that can be generated by this profile. | -| `revisionPublishTime` | `string` | Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. | | `displayName` | `string` | Display name of the security profile. | | `revisionCreateTime` | `string` | Output only. The time when revision was created. | +| `minScore` | `integer` | Output only. Minimum security score that can be generated by this profile. | | `scoringConfigs` | `array` | List of profile scoring configs in this revision. | +| `revisionPublishTime` | `string` | Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. | | `environments` | `array` | List of environments attached to security profile. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md b/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md index 0cb1ef5117..6f6dc980b6 100644 --- a/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md +++ b/docs/google-docs/providers/google/apigee/security_profiles_revisions/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile} | | `description` | `string` | Description of the security profile. | -| `revisionCreateTime` | `string` | Output only. The time when revision was created. | -| `revisionPublishTime` | `string` | Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. | -| `displayName` | `string` | Display name of the security profile. | | `revisionUpdateTime` | `string` | Output only. The time when revision was updated. | -| `scoringConfigs` | `array` | List of profile scoring configs in this revision. | | `maxScore` | `integer` | Output only. Maximum security score that can be generated by this profile. | -| `environments` | `array` | List of environments attached to security profile. | -| `minScore` | `integer` | Output only. Minimum security score that can be generated by this profile. | | `revisionId` | `string` | Output only. Revision ID of the security profile. | +| `minScore` | `integer` | Output only. Minimum security score that can be generated by this profile. | +| `revisionCreateTime` | `string` | Output only. The time when revision was created. | +| `environments` | `array` | List of environments attached to security profile. | +| `displayName` | `string` | Display name of the security profile. | +| `scoringConfigs` | `array` | List of profile scoring configs in this revision. | +| `revisionPublishTime` | `string` | Output only. The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/security_reports/index.md b/docs/google-docs/providers/google/apigee/security_reports/index.md index 1f8b01c659..a624cccdb8 100644 --- a/docs/google-docs/providers/google/apigee/security_reports/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports/index.md @@ -27,19 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `error` | `string` | Error is set when query fails. | -| `queryParams` | `object` | Metadata for the security report. | -| `updated` | `string` | Output only. Last updated timestamp for the query. | +| `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | | `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | -| `displayName` | `string` | Display Name specified by the user. | +| `result` | `object` | Contains informations about the security report results. | | `reportDefinitionId` | `string` | Report Definition ID. | -| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | | `created` | `string` | Creation time of the query. | +| `queryParams` | `object` | Metadata for the security report. | | `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `updated` | `string` | Output only. Last updated timestamp for the query. | +| `displayName` | `string` | Display Name specified by the user. | +| `error` | `string` | Error is set when query fails. | | `resultRows` | `string` | ResultRows is available only after the query is completed. | -| `self` | `string` | Self link of the query. Example: `/organizations/myorg/environments/myenv/securityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` or following format if query is running at host level: `/organizations/myorg/hostSecurityReports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | -| `result` | `object` | Contains informations about the security report results. | -| `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md b/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md index be58ba8581..a4fb9ddd1d 100644 --- a/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `state` | `string` | State of retrieving ResultView. | | `code` | `integer` | Error code when there is a failure. | | `error` | `string` | Error message when there is a failure. | | `metadata` | `object` | Metadata for the security report. | | `rows` | `array` | Rows of security report result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | -| `state` | `string` | State of retrieving ResultView. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/subscriptions/index.md b/docs/google-docs/providers/google/apigee/subscriptions/index.md index 1f4734c49a..45717e1002 100644 --- a/docs/google-docs/providers/google/apigee/subscriptions/index.md +++ b/docs/google-docs/providers/google/apigee/subscriptions/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the API product subscription. | -| `apiproduct` | `string` | Name of the API product for which the developer is purchasing a subscription. | | `createdAt` | `string` | Output only. Time when the API product subscription was created in milliseconds since epoch. | | `endTime` | `string` | Time when the API product subscription ends in milliseconds since epoch. | | `lastModifiedAt` | `string` | Output only. Time when the API product subscription was last modified in milliseconds since epoch. | | `startTime` | `string` | Time when the API product subscription starts in milliseconds since epoch. | +| `apiproduct` | `string` | Name of the API product for which the developer is purchasing a subscription. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/apis/index.md b/docs/google-docs/providers/google/apigeeregistry/apis/index.md index 2f80120448..6af3c44577 100644 --- a/docs/google-docs/providers/google/apigeeregistry/apis/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/apis/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `recommendedDeployment` | `string` | The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}` | +| `createTime` | `string` | Output only. Creation timestamp. | | `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | | `availability` | `string` | A user-definable description of the availability of this service. Format: free-form, but we expect single words that describe availability, e.g., "NONE", "TESTING", "PREVIEW", "GENERAL", "DEPRECATED", "SHUTDOWN". | -| `createTime` | `string` | Output only. Creation timestamp. | -| `displayName` | `string` | Human-meaningful name. | -| `recommendedDeployment` | `string` | The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}` | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | | `recommendedVersion` | `string` | The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` | | `updateTime` | `string` | Output only. Last update timestamp. | +| `displayName` | `string` | Human-meaningful name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/apis_iam_bindings/index.md b/docs/google-docs/providers/google/apigeeregistry/apis_iam_bindings/index.md deleted file mode 100644 index d1b5223835..0000000000 --- a/docs/google-docs/providers/google/apigeeregistry/apis_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: apis_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - apis_iam_bindings - - apigeeregistry - - 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 ---- - - - -## Overview - - - - -
Nameapis_iam_bindings
TypeResource
Idgoogle.apigeeregistry.apis_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_getIamPolicy` | `SELECT` | `apisId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md b/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md index c76fcd4289..d7a0fc522e 100644 --- a/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name. | -| `contents` | `string` | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. | -| `sizeBytes` | `integer` | Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact. | -| `hash` | `string` | Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact. | -| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | -| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "registry.googleapis.com/" and cannot be changed. | | `createTime` | `string` | Output only. Creation timestamp. | | `updateTime` | `string` | Output only. Last update timestamp. | | `mimeType` | `string` | A content type specifier for the artifact. Content type specifiers are Media Types (https://en.wikipedia.org/wiki/Media_type) with a possible "schema" parameter that specifies a schema for the stored information. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "registry.googleapis.com/" and cannot be changed. | +| `contents` | `string` | Input only. The contents of the artifact. Provided by API callers when artifacts are created or replaced. To access the contents of an artifact, use GetArtifactContents. | +| `hash` | `string` | Output only. A SHA-256 hash of the artifact's contents. If the artifact is gzipped, this is the hash of the uncompressed artifact. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `sizeBytes` | `integer` | Output only. The size of the artifact in bytes. If the artifact is gzipped, this is the size of the uncompressed artifact. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/artifacts_contents/index.md b/docs/google-docs/providers/google/apigeeregistry/artifacts_contents/index.md index dcbb09959a..3e1777c316 100644 --- a/docs/google-docs/providers/google/apigeeregistry/artifacts_contents/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/artifacts_contents/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | | `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | | `data` | `string` | The HTTP request/response body as raw binary. | +| `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_bindings/index.md b/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_bindings/index.md deleted file mode 100644 index 76d28e2dc7..0000000000 --- a/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: artifacts_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - artifacts_iam_bindings - - apigeeregistry - - 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 ---- - - - -## Overview - - - - -
Nameartifacts_iam_bindings
TypeResource
Idgoogle.apigeeregistry.artifacts_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_artifacts_getIamPolicy` | `SELECT` | `artifactsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_policies/index.md index 4b35d26c86..d8cb9005b4 100644 --- a/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/deployments/index.md b/docs/google-docs/providers/google/apigeeregistry/deployments/index.md index e61ac25114..14d50681dc 100644 --- a/docs/google-docs/providers/google/apigeeregistry/deployments/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/deployments/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `apiSpecRevision` | `string` | The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}` | +| `externalChannelUri` | `string` | The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | | `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | | `intendedAudience` | `string` | Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. | -| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource was created. | | `endpointUri` | `string` | The address where the deployment is serving. Changes to this value will update the revision. | -| `externalChannelUri` | `string` | The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. | -| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | -| `revisionId` | `string` | Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string. | -| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | | `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. | +| `apiSpecRevision` | `string` | The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}` | | `displayName` | `string` | Human-meaningful name. | -| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/deployments_iam_bindings/index.md b/docs/google-docs/providers/google/apigeeregistry/deployments_iam_bindings/index.md deleted file mode 100644 index b6e82416ad..0000000000 --- a/docs/google-docs/providers/google/apigeeregistry/deployments_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: deployments_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - deployments_iam_bindings - - apigeeregistry - - 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 ---- - - - -## Overview - - - - -
Namedeployments_iam_bindings
TypeResource
Idgoogle.apigeeregistry.deployments_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_deployments_getIamPolicy` | `SELECT` | `apisId, deploymentsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md index 6df3504b38..d7c7300147 100644 --- a/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/deployments_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md b/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md index 6e147eadce..f853d8314a 100644 --- a/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/deployments_revisions/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `revisionId` | `string` | Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string. | -| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. | +| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `endpointUri` | `string` | The address where the deployment is serving. Changes to this value will update the revision. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `intendedAudience` | `string` | Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | | `apiSpecRevision` | `string` | The full resource name (including revision ID) of the spec of the API being served by the deployment. Changes to this value will update the revision. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec@revision}` | | `displayName` | `string` | Human-meaningful name. | -| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource was created. | -| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | | `externalChannelUri` | `string` | The address of the external channel of the API (e.g., the Developer Portal). Changes to this value will not affect the revision. | -| `intendedAudience` | `string` | Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. | -| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. | +| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource was created. | | `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | -| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | -| `endpointUri` | `string` | The address where the deployment is serving. Changes to this value will update the revision. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the deployment. A new revision is committed whenever the deployment contents are changed. The format is an 8-character hexadecimal string. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/instances/index.md b/docs/google-docs/providers/google/apigeeregistry/instances/index.md index 25d986dc97..6f79ab42fa 100644 --- a/docs/google-docs/providers/google/apigeeregistry/instances/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/instances/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Format: `projects/*/locations/*/instance`. Currently only `locations/global` is supported. | -| `stateMessage` | `string` | Output only. Extra information of Instance.State if the state is `FAILED`. | -| `updateTime` | `string` | Output only. Last update timestamp. | -| `build` | `object` | Build information of the Instance if it's in `ACTIVE` state. | | `config` | `object` | Available configurations to provision an Instance. | | `createTime` | `string` | Output only. Creation timestamp. | | `state` | `string` | Output only. The current state of the Instance. | +| `stateMessage` | `string` | Output only. Extra information of Instance.State if the state is `FAILED`. | +| `updateTime` | `string` | Output only. Last update timestamp. | +| `build` | `object` | Build information of the Instance if it's in `ACTIVE` state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/instances_iam_bindings/index.md b/docs/google-docs/providers/google/apigeeregistry/instances_iam_bindings/index.md deleted file mode 100644 index 74bcd4275d..0000000000 --- a/docs/google-docs/providers/google/apigeeregistry/instances_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instances_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_bindings - - apigeeregistry - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_bindings
TypeResource
Idgoogle.apigeeregistry.instances_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_instances_getIamPolicy` | `SELECT` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/operations/index.md b/docs/google-docs/providers/google/apigeeregistry/operations/index.md index a1bcefe343..3d372bed57 100644 --- a/docs/google-docs/providers/google/apigeeregistry/operations/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/runtime_iam_bindings/index.md b/docs/google-docs/providers/google/apigeeregistry/runtime_iam_bindings/index.md deleted file mode 100644 index dc62eb9daa..0000000000 --- a/docs/google-docs/providers/google/apigeeregistry/runtime_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: runtime_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - runtime_iam_bindings - - apigeeregistry - - 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 ---- - - - -## Overview - - - - -
Nameruntime_iam_bindings
TypeResource
Idgoogle.apigeeregistry.runtime_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_runtime_getIamPolicy` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/specs/index.md b/docs/google-docs/providers/google/apigeeregistry/specs/index.md index 8dbc076f1b..c301b37d1c 100644 --- a/docs/google-docs/providers/google/apigeeregistry/specs/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/specs/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `revisionId` | `string` | Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string. | -| `sourceUri` | `string` | The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved. | -| `contents` | `string` | Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. | +| `mimeType` | `string` | A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). | | `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | -| `hash` | `string` | Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. | -| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | | `createTime` | `string` | Output only. Creation timestamp; when the spec resource was created. | +| `hash` | `string` | Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. | | `filename` | `string` | A possibly-hierarchical name used to refer to the spec from other specs. | -| `mimeType` | `string` | A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). | -| `sizeBytes` | `integer` | Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec. | -| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | | `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `contents` | `string` | Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. | +| `sourceUri` | `string` | The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved. | +| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string. | +| `sizeBytes` | `integer` | Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/specs_contents/index.md b/docs/google-docs/providers/google/apigeeregistry/specs_contents/index.md index a8e10c0997..ec51fbc815 100644 --- a/docs/google-docs/providers/google/apigeeregistry/specs_contents/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/specs_contents/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | | `data` | `string` | The HTTP request/response body as raw binary. | | `extensions` | `array` | Application specific response metadata. Must be set in the first response for streaming APIs. | +| `contentType` | `string` | The HTTP Content-Type header value specifying the content type of the body. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/specs_iam_bindings/index.md b/docs/google-docs/providers/google/apigeeregistry/specs_iam_bindings/index.md deleted file mode 100644 index e9e1fd086f..0000000000 --- a/docs/google-docs/providers/google/apigeeregistry/specs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: specs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - specs_iam_bindings - - apigeeregistry - - 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 ---- - - - -## Overview - - - - -
Namespecs_iam_bindings
TypeResource
Idgoogle.apigeeregistry.specs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_versions_specs_getIamPolicy` | `SELECT` | `apisId, locationsId, projectsId, specsId, versionsId` | diff --git a/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md b/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md index 5acdd83af1..59c367fe63 100644 --- a/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `revisionId` | `string` | Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string. | | `mimeType` | `string` | A style (format) descriptor for this spec that is specified as a Media Type (https://en.wikipedia.org/wiki/Media_type). Possible values include `application/vnd.apigee.proto`, `application/vnd.apigee.openapi`, and `application/vnd.apigee.graphql`, with possible suffixes representing compression types. These hypothetical names are defined in the vendor tree defined in RFC6838 (https://tools.ietf.org/html/rfc6838) and are not final. Content types can specify compression. Currently only GZip compression is supported (indicated with "+gzip"). | +| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `contents` | `string` | Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. | | `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | -| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `hash` | `string` | Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. | | `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | | `filename` | `string` | A possibly-hierarchical name used to refer to the spec from other specs. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the spec. A new revision is committed whenever the spec contents are changed. The format is an 8-character hexadecimal string. | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | | `sizeBytes` | `integer` | Output only. The size of the spec file in bytes. If the spec is gzipped, this is the size of the uncompressed spec. | -| `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | -| `hash` | `string` | Output only. A SHA-256 hash of the spec's contents. If the spec is gzipped, this is the hash of the uncompressed spec. | | `sourceUri` | `string` | The original source URI of the spec (if one exists). This is an external location that can be used for reference purposes but which may not be authoritative since this external resource may change after the spec is retrieved. | | `createTime` | `string` | Output only. Creation timestamp; when the spec resource was created. | -| `contents` | `string` | Input only. The contents of the spec. Provided by API callers when specs are created or updated. To access the contents of a spec, use GetApiSpecContents. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/versions/index.md b/docs/google-docs/providers/google/apigeeregistry/versions/index.md index 9afd339e52..75c66264ab 100644 --- a/docs/google-docs/providers/google/apigeeregistry/versions/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/versions/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `state` | `string` | A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED". | | `updateTime` | `string` | Output only. Last update timestamp. | -| `createTime` | `string` | Output only. Creation timestamp. | | `displayName` | `string` | Human-meaningful name. | -| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | | `primarySpec` | `string` | The primary spec for this version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec} | +| `labels` | `object` | Labels attach identifying metadata to resources. Identifying metadata can be used to filter list operations. 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 resource (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with `apigeeregistry.googleapis.com/` and cannot be changed. | +| `state` | `string` | A user-definable description of the lifecycle phase of this API version. Format: free-form, but we expect single words that describe API maturity, e.g., "CONCEPT", "DESIGN", "DEVELOPMENT", "STAGING", "PRODUCTION", "DEPRECATED", "RETIRED". | | `annotations` | `object` | Annotations attach non-identifying metadata to resources. Annotation keys and values are less restricted than those of labels, but should be generally used for small values of broad interest. Larger, topic- specific metadata should be stored in Artifacts. | +| `createTime` | `string` | Output only. Creation timestamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/versions_iam_bindings/index.md b/docs/google-docs/providers/google/apigeeregistry/versions_iam_bindings/index.md deleted file mode 100644 index 8bb720eabe..0000000000 --- a/docs/google-docs/providers/google/apigeeregistry/versions_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: versions_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - versions_iam_bindings - - apigeeregistry - - 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 ---- - - - -## Overview - - - - -
Nameversions_iam_bindings
TypeResource
Idgoogle.apigeeregistry.versions_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_apis_versions_getIamPolicy` | `SELECT` | `apisId, locationsId, projectsId, versionsId` | diff --git a/docs/google-docs/providers/google/apikeys/keys/index.md b/docs/google-docs/providers/google/apikeys/keys/index.md index 6e51f58544..f8e211951b 100644 --- a/docs/google-docs/providers/google/apikeys/keys/index.md +++ b/docs/google-docs/providers/google/apikeys/keys/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the key. The `name` has the form: `projects//locations/global/keys/`. For example: `projects/123456867718/locations/global/keys/b7ff1f9f-8275-410a-94dd-3855ee9b5dd2` NOTE: Key is a global resource; hence the only supported value for location is `global`. | -| `restrictions` | `object` | Describes the restrictions on the key. | -| `updateTime` | `string` | Output only. A timestamp identifying the time this key was last updated. | -| `uid` | `string` | Output only. Unique id in UUID4 format. | -| `annotations` | `object` | Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. | -| `deleteTime` | `string` | Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. | -| `displayName` | `string` | Human-readable display name of this key that you can modify. The maximum length is 63 characters. | | `createTime` | `string` | Output only. A timestamp identifying the time this key was originally created. | -| `keyString` | `string` | Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. | +| `displayName` | `string` | Human-readable display name of this key that you can modify. The maximum length is 63 characters. | | `etag` | `string` | Output only. A checksum computed by the server based on the current value of the Key resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. See https://google.aip.dev/154. | +| `uid` | `string` | Output only. Unique id in UUID4 format. | +| `keyString` | `string` | Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. | +| `deleteTime` | `string` | Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. | +| `annotations` | `object` | Annotations is an unstructured key-value map stored with a policy that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. | +| `restrictions` | `object` | Describes the restrictions on the key. | +| `updateTime` | `string` | Output only. A timestamp identifying the time this key was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/appengine/applications/index.md b/docs/google-docs/providers/google/appengine/applications/index.md deleted file mode 100644 index dc9fb2ab67..0000000000 --- a/docs/google-docs/providers/google/appengine/applications/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: applications -hide_title: false -hide_table_of_contents: false -keywords: - - applications - - appengine - - 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 ---- - - - -## Overview - - - - -
Nameapplications
TypeResource
Idgoogle.appengine.applications
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp. | -| `name` | `string` | Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly | -| `dispatchRules` | `array` | HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. | -| `serviceAccount` | `string` | The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one. | -| `iap` | `object` | Identity-Aware Proxy | -| `codeBucket` | `string` | Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly | -| `servingStatus` | `string` | Serving status of this application. | -| `defaultCookieExpiration` | `string` | Cookie expiration policy for this application. | -| `defaultBucket` | `string` | Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly | -| `databaseType` | `string` | The type of the Cloud Firestore or Cloud Datastore database associated with this application. | -| `defaultHostname` | `string` | Hostname used to reach this application, as resolved by App Engine.@OutputOnly | -| `locationId` | `string` | Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). | -| `gcrDomain` | `string` | The Google Container Registry domain used for storing managed build docker images for this application. | -| `authDomain` | `string` | Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. | -| `featureSettings` | `object` | The feature specific settings to be used in the application. These define behaviors that are user configurable. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_applications_get` | `SELECT` | `applicationsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/appengine/apps/index.md b/docs/google-docs/providers/google/appengine/apps/index.md index be290efdc9..3cb3fa041e 100644 --- a/docs/google-docs/providers/google/appengine/apps/index.md +++ b/docs/google-docs/providers/google/appengine/apps/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp. | | `name` | `string` | Output only. Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly | -| `authDomain` | `string` | Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. | -| `defaultCookieExpiration` | `string` | Cookie expiration policy for this application. | -| `codeBucket` | `string` | Output only. Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly | +| `defaultBucket` | `string` | Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly | | `iap` | `object` | Identity-Aware Proxy | +| `defaultCookieExpiration` | `string` | Cookie expiration policy for this application. | | `serviceAccount` | `string` | The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one. | -| `databaseType` | `string` | The type of the Cloud Firestore or Cloud Datastore database associated with this application. | -| `dispatchRules` | `array` | HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. | -| `locationId` | `string` | Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). | -| `servingStatus` | `string` | Serving status of this application. | -| `defaultBucket` | `string` | Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly | -| `gcrDomain` | `string` | Output only. The Google Container Registry domain used for storing managed build docker images for this application. | | `featureSettings` | `object` | The feature specific settings to be used in the application. These define behaviors that are user configurable. | +| `authDomain` | `string` | Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. | +| `servingStatus` | `string` | Serving status of this application. | | `defaultHostname` | `string` | Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly | +| `locationId` | `string` | Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations). | +| `dispatchRules` | `array` | HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported. | +| `codeBucket` | `string` | Output only. Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly | +| `gcrDomain` | `string` | Output only. The Google Container Registry domain used for storing managed build docker images for this application. | +| `databaseType` | `string` | The type of the Cloud Firestore or Cloud Datastore database associated with this application. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/appengine/authorized_certificates/index.md b/docs/google-docs/providers/google/appengine/authorized_certificates/index.md index 06c97277dc..87f6404eea 100644 --- a/docs/google-docs/providers/google/appengine/authorized_certificates/index.md +++ b/docs/google-docs/providers/google/appengine/authorized_certificates/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly | | `name` | `string` | Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly | +| `displayName` | `string` | The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. | | `domainMappingsCount` | `integer` | Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly | -| `certificateRawData` | `object` | An SSL certificate obtained from a certificate authority. | -| `expireTime` | `string` | The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly | +| `domainNames` | `array` | Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly | | `managedCertificate` | `object` | A certificate managed by App Engine. | -| `displayName` | `string` | The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. | | `visibleDomainMappings` | `array` | The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly | -| `domainNames` | `array` | Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly | +| `certificateRawData` | `object` | An SSL certificate obtained from a certificate authority. | +| `expireTime` | `string` | The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/appengine/instances/index.md b/docs/google-docs/providers/google/appengine/instances/index.md index 06c2e1ca9e..c4f9e8a76e 100644 --- a/docs/google-docs/providers/google/appengine/instances/index.md +++ b/docs/google-docs/providers/google/appengine/instances/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. Relative name of the instance within the version. Example: instance-1. | | `name` | `string` | Output only. Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1. | +| `vmDebugEnabled` | `boolean` | Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. | +| `qps` | `number` | Output only. Average queries per second (QPS) over the last minute. | | `availability` | `string` | Output only. Availability of the instance. | +| `vmId` | `string` | Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. | +| `averageLatency` | `integer` | Output only. Average latency (ms) over the last minute. | +| `startTime` | `string` | Output only. Time that this instance was started.@OutputOnly | | `vmName` | `string` | Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | +| `vmIp` | `string` | Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment. | | `errors` | `integer` | Output only. Number of errors since this instance was started. | -| `vmDebugEnabled` | `boolean` | Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. | -| `appEngineRelease` | `string` | Output only. App Engine release this instance is running on. | -| `startTime` | `string` | Output only. Time that this instance was started.@OutputOnly | -| `vmStatus` | `string` | Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | | `vmLiveness` | `string` | Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment. | -| `averageLatency` | `integer` | Output only. Average latency (ms) over the last minute. | +| `vmStatus` | `string` | Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | +| `appEngineRelease` | `string` | Output only. App Engine release this instance is running on. | | `memoryUsage` | `string` | Output only. Total memory in use (bytes). | -| `vmId` | `string` | Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. | -| `qps` | `number` | Output only. Average queries per second (QPS) over the last minute. | | `requests` | `integer` | Output only. Number of requests since this instance was started. | -| `vmIp` | `string` | Output only. The IP address of this instance. Only applicable for instances in App Engine flexible environment. | | `vmZoneName` | `string` | Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/appengine/versions/index.md b/docs/google-docs/providers/google/appengine/versions/index.md index 47272b97d9..c52412daa0 100644 --- a/docs/google-docs/providers/google/appengine/versions/index.md +++ b/docs/google-docs/providers/google/appengine/versions/index.md @@ -29,45 +29,45 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-". | | `name` | `string` | Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly | -| `envVariables` | `object` | Environment variables available to the application.Only returned in GET requests if view=FULL is set. | -| `healthCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. | +| `inboundServices` | `array` | Before an application can receive email or XMPP messages, the application must be configured to enable the service. | +| `handlers` | `array` | An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set. | +| `manualScaling` | `object` | A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. | | `instanceClass` | `string` | Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling. | -| `nobuildFilesRegex` | `string` | Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. | -| `libraries` | `array` | Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. | -| `serviceAccount` | `string` | The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. | -| `endpointsApiService` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). | -| `servingStatus` | `string` | Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. | | `errorHandlers` | `array` | Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. | -| `livenessCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. | -| `zones` | `array` | The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. | -| `basicScaling` | `object` | A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. | | `runtimeApiVersion` | `string` | The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard//config/appref | -| `betaSettings` | `object` | Metadata settings that are supplied to this version to enable beta runtime features. | -| `apiConfig` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. | -| `runtime` | `string` | Desired runtime. Example: python27. | -| `runtimeChannel` | `string` | The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. | -| `handlers` | `array` | An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set. | | `versionUrl` | `string` | Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly | -| `automaticScaling` | `object` | Automatic scaling is based on request rate, response latencies, and other application metrics. | -| `entrypoint` | `object` | The entrypoint for the application. | +| `nobuildFilesRegex` | `string` | Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set. | | `appEngineApis` | `boolean` | Allows App Engine second generation runtimes to access the legacy bundled services. | -| `env` | `string` | App Engine execution environment for this version.Defaults to standard. | -| `createTime` | `string` | Time that this version was created.@OutputOnly | -| `network` | `object` | Extra network settings. Only applicable in the App Engine flexible environment. | -| `resources` | `object` | Machine resources for a version. | -| `inboundServices` | `array` | Before an application can receive email or XMPP messages, the application must be configured to enable the service. | | `buildEnvVariables` | `object` | Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. | | `flexibleRuntimeSettings` | `object` | Runtime settings for the App Engine flexible environment. | -| `createdBy` | `string` | Email address of the user who created this version.@OutputOnly | +| `diskUsageBytes` | `string` | Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly | | `runtimeMainExecutablePath` | `string` | The path or name of the app's main executable. | +| `createTime` | `string` | Time that this version was created.@OutputOnly | +| `vm` | `boolean` | Whether to deploy this version in a container on a virtual machine. | +| `basicScaling` | `object` | A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity. | +| `livenessCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. | +| `createdBy` | `string` | Email address of the user who created this version.@OutputOnly | | `deployment` | `object` | Code and application artifacts used to deploy a version to App Engine. | -| `diskUsageBytes` | `string` | Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly | -| `threadsafe` | `boolean` | Whether multiple requests can be dispatched to this version at once. | -| `defaultExpiration` | `string` | Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. | +| `entrypoint` | `object` | The entrypoint for the application. | | `vpcAccessConnector` | `object` | VPC access connector specification. | -| `vm` | `boolean` | Whether to deploy this version in a container on a virtual machine. | +| `healthCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment. | +| `defaultExpiration` | `string` | Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. | +| `network` | `object` | Extra network settings. Only applicable in the App Engine flexible environment. | +| `servingStatus` | `string` | Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. | | `readinessCheck` | `object` | Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. | -| `manualScaling` | `object` | A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. | +| `endpointsApiService` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). | +| `runtime` | `string` | Desired runtime. Example: python27. | +| `resources` | `object` | Machine resources for a version. | +| `serviceAccount` | `string` | The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. | +| `automaticScaling` | `object` | Automatic scaling is based on request rate, response latencies, and other application metrics. | +| `libraries` | `array` | Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set. | +| `envVariables` | `object` | Environment variables available to the application.Only returned in GET requests if view=FULL is set. | +| `betaSettings` | `object` | Metadata settings that are supplied to this version to enable beta runtime features. | +| `env` | `string` | App Engine execution environment for this version.Defaults to standard. | +| `runtimeChannel` | `string` | The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. | +| `threadsafe` | `boolean` | Whether multiple requests can be dispatched to this version at once. | +| `zones` | `array` | The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. | +| `apiConfig` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/docker_images/index.md b/docs/google-docs/providers/google/artifactregistry/docker_images/index.md index db34329beb..9d877be66f 100644 --- a/docs/google-docs/providers/google/artifactregistry/docker_images/index.md +++ b/docs/google-docs/providers/google/artifactregistry/docker_images/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. registry_location, project_id, repository_name and image id forms a unique image name:`projects//locations//repository//dockerImages/`. For example, "projects/test-project/locations/us-west4/repositories/test-repo/dockerImages/ nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf" is the image's digest. | +| `buildTime` | `string` | The time this image was built. This field is returned as the 'metadata.buildTime' field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor. | +| `imageSizeBytes` | `string` | Calculated size of the image. This field is returned as the 'metadata.imageSizeBytes' field in the Version resource. | +| `mediaType` | `string` | Media type of this image, e.g. "application/vnd.docker.distribution.manifest.v2+json". This field is returned as the 'metadata.mediaType' field in the Version resource. | | `tags` | `array` | Tags attached to this image. | | `updateTime` | `string` | Output only. The time when the docker image was last updated. | | `uploadTime` | `string` | Time the image was uploaded. | | `uri` | `string` | Required. URL to access the image. Example: us-west4-docker.pkg.dev/test-project/test-repo/nginx@sha256:e9954c1fc875017be1c3e36eca16be2d9e9bccc4bf072163515467d6a823c7cf | -| `buildTime` | `string` | The time this image was built. This field is returned as the 'metadata.buildTime' field in the Version resource. The build time is returned to the client as an RFC 3339 string, which can be easily used with the JavaScript Date constructor. | -| `imageSizeBytes` | `string` | Calculated size of the image. This field is returned as the 'metadata.imageSizeBytes' field in the Version resource. | -| `mediaType` | `string` | Media type of this image, e.g. "application/vnd.docker.distribution.manifest.v2+json". This field is returned as the 'metadata.mediaType' field in the Version resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/files/index.md b/docs/google-docs/providers/google/artifactregistry/files/index.md index be324519b0..b0c6b50fdf 100644 --- a/docs/google-docs/providers/google/artifactregistry/files/index.md +++ b/docs/google-docs/providers/google/artifactregistry/files/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the file, for example: "projects/p1/locations/us-central1/repositories/repo1/files/a%2Fb%2Fc.txt". If the file ID part contains slashes, they are escaped. | -| `owner` | `string` | The name of the Package or Version that owns this file, if any. | | `sizeBytes` | `string` | The size of the File in bytes. | | `updateTime` | `string` | Output only. The time when the File was last updated. | | `createTime` | `string` | Output only. The time when the File was created. | | `fetchTime` | `string` | Output only. The time when the last attempt to refresh the file's data was made. Only set when the repository is remote. | | `hashes` | `array` | The hashes of the file content. | +| `owner` | `string` | The name of the Package or Version that owns this file, if any. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/locations/index.md b/docs/google-docs/providers/google/artifactregistry/locations/index.md index 94a2387c91..abb9146c62 100644 --- a/docs/google-docs/providers/google/artifactregistry/locations/index.md +++ b/docs/google-docs/providers/google/artifactregistry/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md b/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md index 86fcb86915..518bc83541 100644 --- a/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md +++ b/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. registry_location, project_id, repository_name and maven_artifact forms a unique artifact For example, "projects/test-project/locations/us-west4/repositories/test-repo/mavenArtifacts/ com.google.guava:guava:31.0-jre", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and "com.google.guava:guava:31.0-jre" is the maven artifact. | -| `createTime` | `string` | Output only. Time the artifact was created. | -| `groupId` | `string` | Group ID for the artifact. Example: com.google.guava | | `pomUri` | `string` | Required. URL to access the pom file of the artifact. Example: us-west4-maven.pkg.dev/test-project/test-repo/com/google/guava/guava/31.0/guava-31.0.pom | | `updateTime` | `string` | Output only. Time the artifact was updated. | | `version` | `string` | Version of this artifact. | | `artifactId` | `string` | Artifact ID for the artifact. | +| `createTime` | `string` | Output only. Time the artifact was created. | +| `groupId` | `string` | Group ID for the artifact. Example: com.google.guava | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md b/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md index 2f0cf6db74..f2d3babb71 100644 --- a/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md +++ b/docs/google-docs/providers/google/artifactregistry/npm_packages/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. registry_location, project_id, repository_name and npm_package forms a unique package For example, "projects/test-project/locations/us-west4/repositories/test-repo/npmPackages/ npm_test:1.0.0", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and npm_test:1.0.0" is the npm package. | +| `createTime` | `string` | Output only. Time the package was created. | +| `packageName` | `string` | Package for the artifact. | | `tags` | `array` | Tags attached to this package. | | `updateTime` | `string` | Output only. Time the package was updated. | | `version` | `string` | Version of this package. | -| `createTime` | `string` | Output only. Time the package was created. | -| `packageName` | `string` | Package for the artifact. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/packages/index.md b/docs/google-docs/providers/google/artifactregistry/packages/index.md index df700b3409..091f6071b7 100644 --- a/docs/google-docs/providers/google/artifactregistry/packages/index.md +++ b/docs/google-docs/providers/google/artifactregistry/packages/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the package, for example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. If the package ID part contains slashes, the slashes are escaped. | +| `displayName` | `string` | The display name of the package. | | `updateTime` | `string` | The time when the package was last updated. This includes publishing a new version of the package. | | `createTime` | `string` | The time when the package was created. | -| `displayName` | `string` | The display name of the package. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/projects/index.md b/docs/google-docs/providers/google/artifactregistry/projects/index.md deleted file mode 100644 index fd29bb2ff4..0000000000 --- a/docs/google-docs/providers/google/artifactregistry/projects/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: projects -hide_title: false -hide_table_of_contents: false -keywords: - - projects - - artifactregistry - - 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 ---- - - - -## Overview - - - - -
Nameprojects
TypeResource
Idgoogle.artifactregistry.projects
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateProjectSettings` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/artifactregistry/projects_project_settings/index.md b/docs/google-docs/providers/google/artifactregistry/projects_project_settings/index.md deleted file mode 100644 index aa55796a86..0000000000 --- a/docs/google-docs/providers/google/artifactregistry/projects_project_settings/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: projects_project_settings -hide_title: false -hide_table_of_contents: false -keywords: - - projects_project_settings - - artifactregistry - - 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 ---- - - - -## Overview - - - - -
Nameprojects_project_settings
TypeResource
Idgoogle.artifactregistry.projects_project_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set | -| `legacyRedirectionState` | `string` | The redirection state of the legacy repositories in this project. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getProjectSettings` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/artifactregistry/python_packages/index.md b/docs/google-docs/providers/google/artifactregistry/python_packages/index.md index 08de61ec78..862a19f6fb 100644 --- a/docs/google-docs/providers/google/artifactregistry/python_packages/index.md +++ b/docs/google-docs/providers/google/artifactregistry/python_packages/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. registry_location, project_id, repository_name and python_package forms a unique package name:`projects//locations//repository//pythonPackages/`. For example, "projects/test-project/locations/us-west4/repositories/test-repo/pythonPackages/ python_package:1.0.0", where "us-west4" is the registry_location, "test-project" is the project_id, "test-repo" is the repository_name and python_package:1.0.0" is the python package. | -| `version` | `string` | Version of this package. | | `createTime` | `string` | Output only. Time the package was created. | | `packageName` | `string` | Package for the artifact. | | `updateTime` | `string` | Output only. Time the package was updated. | | `uri` | `string` | Required. URL to access the package. Example: us-west4-python.pkg.dev/test-project/test-repo/python_package/file-name-1.0.0.tar.gz | +| `version` | `string` | Version of this package. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/repositories/index.md b/docs/google-docs/providers/google/artifactregistry/repositories/index.md index 25bb560235..2cd3e17d63 100644 --- a/docs/google-docs/providers/google/artifactregistry/repositories/index.md +++ b/docs/google-docs/providers/google/artifactregistry/repositories/index.md @@ -29,21 +29,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The name of the repository, for example: "projects/p1/locations/us-central1/repositories/repo1". | | `description` | `string` | The user-provided description of the repository. | -| `cleanupPolicyDryRun` | `boolean` | Optional. If true, the cleanup pipeline is prevented from deleting versions in this repository. | -| `labels` | `object` | Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes. | -| `sbomConfig` | `object` | Config for whether to generate SBOMs for resources in this repository, as well as output fields describing current state. | -| `mavenConfig` | `object` | MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type. | -| `virtualRepositoryConfig` | `object` | Virtual repository configuration. | +| `updateTime` | `string` | Output only. The time when the repository was last updated. | | `format` | `string` | The format of packages that are stored in the repository. | -| `cleanupPolicies` | `object` | Optional. Cleanup policies for this repository. Cleanup policies indicate when certain package versions can be automatically deleted. Map keys are policy IDs supplied by users during policy creation. They must unique within a repository and be under 128 characters in length. | -| `sizeBytes` | `string` | Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs. | | `mode` | `string` | The mode of the repository. | -| `dockerConfig` | `object` | DockerRepositoryConfig is docker related repository details. Provides additional configuration details for repositories of the docker format type. | +| `cleanupPolicies` | `object` | Optional. Cleanup policies for this repository. Cleanup policies indicate when certain package versions can be automatically deleted. Map keys are policy IDs supplied by users during policy creation. They must unique within a repository and be under 128 characters in length. | | `remoteRepositoryConfig` | `object` | Remote repository configuration. | -| `updateTime` | `string` | Output only. The time when the repository was last updated. | -| `kmsKeyName` | `string` | The Cloud KMS resource name of the customer managed encryption key that's used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created. | | `createTime` | `string` | Output only. The time when the repository was created. | +| `kmsKeyName` | `string` | The Cloud KMS resource name of the customer managed encryption key that's used to encrypt the contents of the Repository. Has the form: `projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key`. This value may not be changed after the Repository has been created. | | `satisfiesPzs` | `boolean` | Output only. If set, the repository satisfies physical zone separation. | +| `mavenConfig` | `object` | MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type. | +| `virtualRepositoryConfig` | `object` | Virtual repository configuration. | +| `sizeBytes` | `string` | Output only. The size, in bytes, of all artifact storage in this repository. Repositories that are generally available or in public preview use this to calculate storage costs. | +| `sbomConfig` | `object` | Config for whether to generate SBOMs for resources in this repository, as well as output fields describing current state. | +| `cleanupPolicyDryRun` | `boolean` | Optional. If true, the cleanup pipeline is prevented from deleting versions in this repository. | +| `dockerConfig` | `object` | DockerRepositoryConfig is docker related repository details. Provides additional configuration details for repositories of the docker format type. | +| `labels` | `object` | Labels with user-defined metadata. This field may contain up to 64 entries. Label keys and values may be no longer than 63 characters. Label keys must begin with a lowercase letter and may only contain lowercase letters, numeric characters, underscores, and dashes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/repositories_iam_bindings/index.md b/docs/google-docs/providers/google/artifactregistry/repositories_iam_bindings/index.md deleted file mode 100644 index 217b4ce7b7..0000000000 --- a/docs/google-docs/providers/google/artifactregistry/repositories_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: repositories_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - repositories_iam_bindings - - artifactregistry - - 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 ---- - - - -## Overview - - - - -
Namerepositories_iam_bindings
TypeResource
Idgoogle.artifactregistry.repositories_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_repositories_getIamPolicy` | `SELECT` | `locationsId, projectsId, repositoriesId` | diff --git a/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md b/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md index 6051a21dd3..3c06c43ed4 100644 --- a/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md +++ b/docs/google-docs/providers/google/artifactregistry/repositories_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/versions/index.md b/docs/google-docs/providers/google/artifactregistry/versions/index.md index ce630aa4e9..f6534e48ae 100644 --- a/docs/google-docs/providers/google/artifactregistry/versions/index.md +++ b/docs/google-docs/providers/google/artifactregistry/versions/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The name of the version, for example: "projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/art1". If the package or version ID parts contain slashes, the slashes are escaped. | | `description` | `string` | Optional. Description of the version, as specified in its metadata. | -| `metadata` | `object` | Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact | | `relatedTags` | `array` | Output only. A list of related tags. Will contain up to 100 tags that reference this version. | | `updateTime` | `string` | The time when the version was last updated. | | `createTime` | `string` | The time when the version was created. | +| `metadata` | `object` | Output only. Repository-specific Metadata stored against this version. The fields returned are defined by the underlying repository-specific resource. Currently, the resources could be: DockerImage MavenArtifact | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/assuredworkloads/operations/index.md b/docs/google-docs/providers/google/assuredworkloads/operations/index.md index 79ec66e93e..0e42e50b38 100644 --- a/docs/google-docs/providers/google/assuredworkloads/operations/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/assuredworkloads/violations/index.md b/docs/google-docs/providers/google/assuredworkloads/violations/index.md index 9e58c03114..5ffaac0dd6 100644 --- a/docs/google-docs/providers/google/assuredworkloads/violations/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/violations/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Immutable. Name of the Violation. Format: organizations/{organization}/locations/{location}/workloads/{workload_id}/violations/{violations_id} | | `description` | `string` | Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. | -| `acknowledged` | `boolean` | A boolean that indicates if the violation is acknowledged | +| `beginTime` | `string` | Output only. Time of the event which triggered the Violation. | +| `acknowledgementTime` | `string` | Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. | +| `resolveTime` | `string` | Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. | +| `updateTime` | `string` | Output only. The last time when the Violation record was updated. | +| `state` | `string` | Output only. State of the violation | +| `auditLogLink` | `string` | Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} | | `nonCompliantOrgPolicy` | `string` | Output only. Immutable. Name of the OrgPolicy which was modified with non-compliant change and resulted this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} | | `exceptionContexts` | `array` | Output only. List of all the exception detail added for the violation. | -| `beginTime` | `string` | Output only. Time of the event which triggered the Violation. | -| `exceptionAuditLogLink` | `string` | Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} | | `category` | `string` | Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. | -| `state` | `string` | Output only. State of the violation | -| `resolveTime` | `string` | Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. | +| `exceptionAuditLogLink` | `string` | Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} | +| `acknowledged` | `boolean` | A boolean that indicates if the violation is acknowledged | | `orgPolicyConstraint` | `string` | Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation. | | `remediation` | `object` | Represents remediation guidance to resolve compliance violation for AssuredWorkload | -| `updateTime` | `string` | Output only. The last time when the Violation record was updated. | -| `auditLogLink` | `string` | Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} | -| `acknowledgementTime` | `string` | Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/assuredworkloads/workloads/index.md b/docs/google-docs/providers/google/assuredworkloads/workloads/index.md index af994403a7..39afcd6731 100644 --- a/docs/google-docs/providers/google/assuredworkloads/workloads/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/workloads/index.md @@ -28,25 +28,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Optional. The resource name of the workload. Format: organizations/{organization}/locations/{location}/workloads/{workload} Read-only. | -| `resources` | `array` | Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only. | -| `partnerPermissions` | `object` | Permissions granted to the AW Partner SA account for the customer workload | +| `partner` | `string` | Optional. Partner regime associated with this workload. | +| `labels` | `object` | Optional. Labels applied to the workload. | | `resourceSettings` | `array` | Input only. Resource properties that are used to customize workload resources. These properties (such as custom project id) will be used to create workload resources if possible. This field is optional. | | `compliantButDisallowedServices` | `array` | Output only. Urls for services which are compliant for this Assured Workload, but which are currently disallowed by the ResourceUsageRestriction org policy. Invoke RestrictAllowedResources endpoint to allow your project developers to use these services in their environment." | -| `displayName` | `string` | Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload | -| `enableSovereignControls` | `boolean` | Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. | -| `violationNotificationsEnabled` | `boolean` | Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. | | `etag` | `string` | Optional. ETag of the workload, it is calculated on the basis of the Workload contents. It will be used in Update & Delete operations. | -| `complianceStatus` | `object` | Represents the Compliance Status of this workload | -| `complianceRegime` | `string` | Required. Immutable. Compliance Regime associated with this workload. | -| `partner` | `string` | Optional. Partner regime associated with this workload. | -| `billingAccount` | `string` | Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. | +| `resources` | `array` | Output only. The resources associated with this workload. These resources will be created when creating the workload. If any of the projects already exist, the workload creation will fail. Always read only. | | `kajEnrollmentState` | `string` | Output only. Represents the KAJ enrollment state of the given workload. | -| `labels` | `object` | Optional. Labels applied to the workload. | +| `partnerPermissions` | `object` | Permissions granted to the AW Partner SA account for the customer workload | +| `complianceRegime` | `string` | Required. Immutable. Compliance Regime associated with this workload. | | `kmsSettings` | `object` | Settings specific to the Key Management Service. | -| `createTime` | `string` | Output only. Immutable. The Workload creation timestamp. | +| `provisionedResourcesParent` | `string` | Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} | +| `billingAccount` | `string` | Optional. The billing account used for the resources which are direct children of workload. This billing account is initially associated with the resources created as part of Workload creation. After the initial creation of these resources, the customer can change the assigned billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF`. | +| `enableSovereignControls` | `boolean` | Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. | | `saaEnrollmentResponse` | `object` | Signed Access Approvals (SAA) enrollment response. | | `ekmProvisioningResponse` | `object` | External key management systems(EKM) Provisioning response | -| `provisionedResourcesParent` | `string` | Input only. The parent resource for the resources managed by this Assured Workload. May be either empty or a folder resource which is a child of the Workload parent. If not specified all resources are created under the parent organization. Format: folders/{folder_id} | +| `violationNotificationsEnabled` | `boolean` | Optional. Indicates whether the e-mail notification for a violation is enabled for a workload. This value will be by default True, and if not present will be considered as true. This should only be updated via updateWorkload call. Any Changes to this field during the createWorkload call will not be honored. This will always be true while creating the workload. | +| `complianceStatus` | `object` | Represents the Compliance Status of this workload | +| `createTime` | `string` | Output only. Immutable. The Workload creation timestamp. | +| `displayName` | `string` | Required. The user-assigned display name of the Workload. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, and spaces. Example: My Workload | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/instance_provisioning_settings/index.md b/docs/google-docs/providers/google/baremetalsolution/instance_provisioning_settings/index.md deleted file mode 100644 index f4ade86eda..0000000000 --- a/docs/google-docs/providers/google/baremetalsolution/instance_provisioning_settings/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: instance_provisioning_settings -hide_title: false -hide_table_of_contents: false -keywords: - - instance_provisioning_settings - - baremetalsolution - - 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 ---- - - - -## Overview - - - - -
Nameinstance_provisioning_settings
TypeResource
Idgoogle.baremetalsolution.instance_provisioning_settings
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_instanceProvisioningSettings_fetch` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/baremetalsolution/instances/index.md b/docs/google-docs/providers/google/baremetalsolution/instances/index.md index f680313b9c..c7148e2c7d 100644 --- a/docs/google-docs/providers/google/baremetalsolution/instances/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/instances/index.md @@ -29,23 +29,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. An identifier for the `Instance`, generated by the backend. | | `name` | `string` | Immutable. The resource name of this `Instance`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/instances/{instance}` | -| `machineType` | `string` | Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | -| `firmwareVersion` | `string` | Output only. The firmware version for the instance. | | `state` | `string` | Output only. The state of the server. | -| `networks` | `array` | Output only. List of networks associated with this server. | -| `osImage` | `string` | The OS image currently installed on the server. | | `loginInfo` | `string` | Output only. Text field about info for logging in. | -| `createTime` | `string` | Output only. Create a time stamp. | -| `hyperthreadingEnabled` | `boolean` | True if you enable hyperthreading for the server, otherwise false. The default value is false. | -| `interactiveSerialConsoleEnabled` | `boolean` | Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. | -| `labels` | `object` | Labels as key value pairs. | +| `firmwareVersion` | `string` | Output only. The firmware version for the instance. | | `workloadProfile` | `string` | The workload profile for the instance. | -| `logicalInterfaces` | `array` | List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled. | | `updateTime` | `string` | Output only. Update a time stamp. | +| `hyperthreadingEnabled` | `boolean` | True if you enable hyperthreading for the server, otherwise false. The default value is false. | +| `logicalInterfaces` | `array` | List of logical interfaces for the instance. The number of logical interfaces will be the same as number of hardware bond/nic on the chosen network template. For the non-multivlan configurations (for eg, existing servers) that use existing default network template (bondaa-bondaa), both the Instance.networks field and the Instance.logical_interfaces fields will be filled to ensure backward compatibility. For the others, only Instance.logical_interfaces will be filled. | | `luns` | `array` | Immutable. List of LUNs associated with this server. | -| `pod` | `string` | Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only. | -| `networkTemplate` | `string` | Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic". | +| `machineType` | `string` | Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | +| `networks` | `array` | Output only. List of networks associated with this server. | +| `labels` | `object` | Labels as key value pairs. | +| `interactiveSerialConsoleEnabled` | `boolean` | Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. | +| `createTime` | `string` | Output only. Create a time stamp. | | `volumes` | `array` | Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. | +| `networkTemplate` | `string` | Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic". | +| `osImage` | `string` | The OS image currently installed on the server. | +| `pod` | `string` | Immutable. Pod name. Pod is an independent part of infrastructure. Instance can be connected to the assets (networks, volumes) allocated in the same pod only. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/luns/index.md b/docs/google-docs/providers/google/baremetalsolution/luns/index.md index f809efbfdd..b5af005a78 100644 --- a/docs/google-docs/providers/google/baremetalsolution/luns/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/luns/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | An identifier for the LUN, generated by the backend. | | `name` | `string` | Output only. The name of the LUN. | -| `sizeGb` | `string` | The size of this LUN, in gigabytes. | -| `expireTime` | `string` | Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state. | -| `storageVolume` | `string` | Display the storage volume for this LUN. | -| `multiprotocolType` | `string` | The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. | -| `state` | `string` | The state of this storage volume. | -| `storageType` | `string` | The storage type for this LUN. | | `wwid` | `string` | The WWID for this LUN. | +| `storageType` | `string` | The storage type for this LUN. | +| `state` | `string` | The state of this storage volume. | +| `instances` | `array` | Output only. Instances this Lun is attached to. | +| `multiprotocolType` | `string` | The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. | | `shareable` | `boolean` | Display if this LUN can be shared between multiple physical servers. | +| `storageVolume` | `string` | Display the storage volume for this LUN. | | `bootLun` | `boolean` | Display if this LUN is a boot LUN. | -| `instances` | `array` | Output only. Instances this Lun is attached to. | +| `expireTime` | `string` | Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state. | +| `sizeGb` | `string` | The size of this LUN, in gigabytes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/networks/index.md b/docs/google-docs/providers/google/baremetalsolution/networks/index.md index f2ea2716b8..43b1a650a1 100644 --- a/docs/google-docs/providers/google/baremetalsolution/networks/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/networks/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | An identifier for the `Network`, generated by the backend. | | `name` | `string` | Output only. The resource name of this `Network`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/networks/{network}` | +| `vlanId` | `string` | The vlan id of the Network. | | `macAddress` | `array` | List of physical interfaces. | -| `state` | `string` | The Network state. | -| `reservations` | `array` | List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server. | +| `labels` | `object` | Labels as key value pairs. | | `mountPoints` | `array` | Input only. List of mount points to attach the network to. | | `cidr` | `string` | The cidr of the Network. | -| `jumboFramesEnabled` | `boolean` | Whether network uses standard frames or jumbo ones. | +| `state` | `string` | The Network state. | +| `gatewayIp` | `string` | Output only. Gateway ip address. | | `ipAddress` | `string` | IP address configured. | | `pod` | `string` | Output only. Pod name. | -| `servicesCidr` | `string` | IP range for reserved for services (e.g. NFS). | -| `labels` | `object` | Labels as key value pairs. | -| `vlanId` | `string` | The vlan id of the Network. | | `vrf` | `object` | A network VRF. | -| `gatewayIp` | `string` | Output only. Gateway ip address. | +| `servicesCidr` | `string` | IP range for reserved for services (e.g. NFS). | | `type` | `string` | The type of this network. | +| `reservations` | `array` | List of IP address reservations in this network. When updating this field, an error will be generated if a reservation conflicts with an IP address already allocated to a physical server. | +| `jumboFramesEnabled` | `boolean` | Whether network uses standard frames or jumbo ones. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md b/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md index 579826cb3b..c72509fe72 100644 --- a/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/nfs_shares/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. An identifier for the NFS share, generated by the backend. This is the same value as nfs_share_id and will replace it in the future. | | `name` | `string` | Immutable. The name of the NFS share. | -| `state` | `string` | Output only. The state of the NFS share. | -| `labels` | `object` | Labels as key value pairs. | | `volume` | `string` | Output only. The underlying volume of the share. Created automatically during provisioning. | +| `allowedClients` | `array` | List of allowed access points. | +| `labels` | `object` | Labels as key value pairs. | | `nfsShareId` | `string` | Output only. An identifier for the NFS share, generated by the backend. This field will be deprecated in the future, use `id` instead. | -| `storageType` | `string` | Immutable. The storage type of the underlying volume. | | `requestedSizeGib` | `string` | The requested size, in GiB. | -| `allowedClients` | `array` | List of allowed access points. | +| `storageType` | `string` | Immutable. The storage type of the underlying volume. | +| `state` | `string` | Output only. The state of the NFS share. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md b/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md index 29e5a9877f..bdf5746aa3 100644 --- a/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/provisioning_configs/index.md @@ -28,19 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The system-generated name of the provisioning config. This follows the UUID format. | -| `handoverServiceAccount` | `string` | A service account to enable customers to access instance credentials upon handover. | +| `volumes` | `array` | Volumes to be created. | +| `location` | `string` | Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. | | `statusMessage` | `string` | Optional status messages associated with the FAILED state. | -| `updateTime` | `string` | Output only. Last update timestamp. | +| `customId` | `string` | Optional. The user-defined identifier of the provisioning config. | +| `cloudConsoleUri` | `string` | Output only. URI to Cloud Console UI view of this provisioning config. | | `ticketId` | `string` | A generated ticket id to track provisioning request. | +| `handoverServiceAccount` | `string` | A service account to enable customers to access instance credentials upon handover. | +| `updateTime` | `string` | Output only. Last update timestamp. | +| `vpcScEnabled` | `boolean` | If true, VPC SC is enabled for the cluster. | +| `networks` | `array` | Networks to be created. | | `instances` | `array` | Instances to be created. | | `email` | `string` | Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. | | `state` | `string` | Output only. State of ProvisioningConfig. | -| `networks` | `array` | Networks to be created. | -| `vpcScEnabled` | `boolean` | If true, VPC SC is enabled for the cluster. | -| `customId` | `string` | Optional. The user-defined identifier of the provisioning config. | -| `location` | `string` | Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. | -| `cloudConsoleUri` | `string` | Output only. URI to Cloud Console UI view of this provisioning config. | -| `volumes` | `array` | Volumes to be created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md b/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md index 1ecff34d88..509a076b0f 100644 --- a/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the provisioning quota. | -| `location` | `string` | The specific location of the provisioining quota. | -| `storageGib` | `string` | Storage size (GB). | -| `instanceQuota` | `object` | A resource budget. | -| `serverCount` | `string` | Server count. | | `networkBandwidth` | `string` | Network bandwidth, Gbps | +| `instanceQuota` | `object` | A resource budget. | | `availableCount` | `integer` | The available count of the provisioning quota. | +| `serverCount` | `string` | Server count. | +| `storageGib` | `string` | Storage size (GB). | +| `location` | `string` | The specific location of the provisioining quota. | | `assetType` | `string` | The asset type of this provisioning quota. | | `gcpService` | `string` | The gcp service of the provisioning quota. | ## Methods diff --git a/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md b/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md index c31c5acf6c..7606c65781 100644 --- a/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md @@ -30,9 +30,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Output only. An identifier for the snapshot, generated by the backend. | | `name` | `string` | The name of the snapshot. | | `description` | `string` | The description of the snapshot. | +| `storageVolume` | `string` | Output only. The name of the volume which this snapshot belongs to. | | `type` | `string` | Output only. The type of the snapshot which indicates whether it was scheduled or manual/ad-hoc. | | `createTime` | `string` | Output only. The creation time of the snapshot. | -| `storageVolume` | `string` | Output only. The name of the volume which this snapshot belongs to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/volumes/index.md b/docs/google-docs/providers/google/baremetalsolution/volumes/index.md index 57f339c0f5..59b4c9ca06 100644 --- a/docs/google-docs/providers/google/baremetalsolution/volumes/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/volumes/index.md @@ -29,30 +29,30 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | An identifier for the `Volume`, generated by the backend. | | `name` | `string` | Output only. The resource name of this `Volume`. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. Format: `projects/{project}/locations/{location}/volumes/{volume}` | -| `performanceTier` | `string` | Immutable. Performance tier of the Volume. Default is SHARED. | -| `instances` | `array` | Output only. Instances this Volume is attached to. This field is set only in Get requests. | -| `emergencySizeGib` | `string` | Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value. | -| `notes` | `string` | Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention. | -| `attached` | `boolean` | Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well. | -| `autoGrownSizeGib` | `string` | The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0. | -| `workloadProfile` | `string` | The workload profile for the volume. | -| `labels` | `object` | Labels as key value pairs. | -| `snapshotEnabled` | `boolean` | Whether snapshots are enabled. | -| `storageType` | `string` | The storage type for this volume. | | `storageAggregatePool` | `string` | Input only. Name of the storage aggregate pool to allocate the volume in. Can be used only for VOLUME_PERFORMANCE_TIER_ASSIGNED volumes. | -| `currentSizeGib` | `string` | The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink. | -| `requestedSizeGib` | `string` | The requested size of this storage volume, in GiB. | +| `snapshotAutoDeleteBehavior` | `string` | The behavior to use when snapshot reserved space is full. | | `state` | `string` | The state of this storage volume. | +| `snapshotEnabled` | `boolean` | Whether snapshots are enabled. | | `snapshotSchedulePolicy` | `string` | The name of the snapshot schedule policy in use for this volume, if any. | +| `storageType` | `string` | The storage type for this volume. | +| `originallyRequestedSizeGib` | `string` | Originally requested size, in GiB. | +| `autoGrownSizeGib` | `string` | The size, in GiB, that this storage volume has expanded as a result of an auto grow policy. In the absence of auto-grow, the value is 0. | +| `expireTime` | `string` | Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state. | +| `workloadProfile` | `string` | The workload profile for the volume. | +| `protocol` | `string` | Output only. Storage protocol for the Volume. | +| `notes` | `string` | Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention. | +| `requestedSizeGib` | `string` | The requested size of this storage volume, in GiB. | +| `currentSizeGib` | `string` | The current size of this storage volume, in GiB, including space reserved for snapshots. This size might be different than the requested size if the storage volume has been configured with auto grow or auto shrink. | +| `labels` | `object` | Labels as key value pairs. | | `maxSizeGib` | `string` | Maximum size volume can be expanded to in case of evergency, in GiB. | | `remainingSpaceGib` | `string` | The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots. | -| `protocol` | `string` | Output only. Storage protocol for the Volume. | -| `snapshotAutoDeleteBehavior` | `string` | The behavior to use when snapshot reserved space is full. | -| `bootVolume` | `boolean` | Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN. | +| `attached` | `boolean` | Output only. Is the Volume attached at at least one instance. This field is a lightweight counterpart of `instances` field. It is filled in List responses as well. | +| `emergencySizeGib` | `string` | Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value. | +| `instances` | `array` | Output only. Instances this Volume is attached to. This field is set only in Get requests. | | `pod` | `string` | Immutable. Pod name. | -| `originallyRequestedSizeGib` | `string` | Originally requested size, in GiB. | +| `performanceTier` | `string` | Immutable. Performance tier of the Volume. Default is SHARED. | | `snapshotReservationDetail` | `object` | Details about snapshot space reservation and usage on the storage volume. | -| `expireTime` | `string` | Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state. | +| `bootVolume` | `boolean` | Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/batch/jobs/index.md b/docs/google-docs/providers/google/batch/jobs/index.md index e5332b4dba..735f4e7d3b 100644 --- a/docs/google-docs/providers/google/batch/jobs/index.md +++ b/docs/google-docs/providers/google/batch/jobs/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01". | -| `logsPolicy` | `object` | LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. | +| `createTime` | `string` | Output only. When the Job was created. | | `taskGroups` | `array` | Required. TaskGroups in the Job. Only one TaskGroup is supported now. | -| `updateTime` | `string` | Output only. The last time the Job was updated. | | `priority` | `string` | Priority of the Job. The valid value range is [0, 100). Default value is 0. Higher value indicates higher priority. A job with higher priority value is more likely to run earlier if all other requirements are satisfied. | | `uid` | `string` | Output only. A system generated unique ID (in UUID4 format) for the Job. | -| `createTime` | `string` | Output only. When the Job was created. | +| `updateTime` | `string` | Output only. The last time the Job was updated. | +| `logsPolicy` | `object` | LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. | | `notifications` | `array` | Notification configurations. | -| `status` | `object` | Job status. | | `allocationPolicy` | `object` | A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. | +| `status` | `object` | Job status. | | `labels` | `object` | Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels. [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/batch/jobs_iam_audit_configs/index.md b/docs/google-docs/providers/google/batch/jobs_iam_audit_configs/index.md deleted file mode 100644 index cb10a724a6..0000000000 --- a/docs/google-docs/providers/google/batch/jobs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: jobs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_audit_configs - - batch - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_audit_configs
TypeResource
Idgoogle.batch.jobs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_jobs_getIamPolicy` | `SELECT` | `jobsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/batch/jobs_iam_bindings/index.md b/docs/google-docs/providers/google/batch/jobs_iam_bindings/index.md deleted file mode 100644 index 15dbf7f957..0000000000 --- a/docs/google-docs/providers/google/batch/jobs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: jobs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_bindings - - batch - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_bindings
TypeResource
Idgoogle.batch.jobs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_jobs_getIamPolicy` | `SELECT` | `jobsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/batch/jobs_iam_policies/index.md b/docs/google-docs/providers/google/batch/jobs_iam_policies/index.md deleted file mode 100644 index a96d463ba1..0000000000 --- a/docs/google-docs/providers/google/batch/jobs_iam_policies/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: jobs_iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_policies - - batch - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_policies
TypeResource
Idgoogle.batch.jobs_iam_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_jobs_getIamPolicy` | `SELECT` | `jobsId, locationsId, projectsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | -| `projects_locations_jobs_setIamPolicy` | `EXEC` | `jobsId, locationsId, projectsId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | -| `projects_locations_jobs_testIamPermissions` | `EXEC` | `jobsId, locationsId, projectsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/batch/locations/index.md b/docs/google-docs/providers/google/batch/locations/index.md index 1463fba2aa..1e77f74bcd 100644 --- a/docs/google-docs/providers/google/batch/locations/index.md +++ b/docs/google-docs/providers/google/batch/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/batch/operations/index.md b/docs/google-docs/providers/google/batch/operations/index.md index 2fa48114f9..da0736ad02 100644 --- a/docs/google-docs/providers/google/batch/operations/index.md +++ b/docs/google-docs/providers/google/batch/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | -| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/app_connections/index.md b/docs/google-docs/providers/google/beyondcorp/app_connections/index.md index b1f16afffd..7e84b43bba 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connections/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connections/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Required. Unique resource name of the AppConnection. The name is ignored when creating a AppConnection. | | `type` | `string` | Required. The type of network connectivity used by the AppConnection. | | `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | -| `connectors` | `array` | Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. | -| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | -| `applicationEndpoint` | `object` | ApplicationEndpoint represents a remote application endpoint. | | `displayName` | `string` | Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters. | -| `createTime` | `string` | Output only. Timestamp when the resource was created. | +| `gateway` | `object` | Gateway represents a user facing component that serves as an entrance to enable connectivity. | | `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `connectors` | `array` | Optional. List of [google.cloud.beyondcorp.v1main.Connector.name] that are authorised to be associated with this AppConnection. | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | | `state` | `string` | Output only. The current state of the AppConnection. | -| `gateway` | `object` | Gateway represents a user facing component that serves as an entrance to enable connectivity. | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | +| `applicationEndpoint` | `object` | ApplicationEndpoint represents a remote application endpoint. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/app_connections_iam_audit_configs/index.md b/docs/google-docs/providers/google/beyondcorp/app_connections_iam_audit_configs/index.md deleted file mode 100644 index f3077abac4..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/app_connections_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: app_connections_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - app_connections_iam_audit_configs - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameapp_connections_iam_audit_configs
TypeResource
Idgoogle.beyondcorp.app_connections_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_appConnections_getIamPolicy` | `SELECT` | `appConnectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/app_connections_iam_bindings/index.md b/docs/google-docs/providers/google/beyondcorp/app_connections_iam_bindings/index.md deleted file mode 100644 index e0b0aaf26c..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/app_connections_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: app_connections_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - app_connections_iam_bindings - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameapp_connections_iam_bindings
TypeResource
Idgoogle.beyondcorp.app_connections_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_appConnections_getIamPolicy` | `SELECT` | `appConnectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md b/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md index 1cb46f83a5..3a165e62a4 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector. | | `principalInfo` | `object` | PrincipalInfo represents an Identity oneof. | -| `createTime` | `string` | Output only. Timestamp when the resource was created. | | `state` | `string` | Output only. The current state of the AppConnector. | -| `displayName` | `string` | Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters. | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | | `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | -| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | | `resourceInfo` | `object` | ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent | -| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | +| `displayName` | `string` | Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters. | +| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_audit_configs/index.md b/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_audit_configs/index.md deleted file mode 100644 index f412c697ec..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: app_connectors_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - app_connectors_iam_audit_configs - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameapp_connectors_iam_audit_configs
TypeResource
Idgoogle.beyondcorp.app_connectors_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_appConnectors_getIamPolicy` | `SELECT` | `appConnectorsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_bindings/index.md b/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_bindings/index.md deleted file mode 100644 index 94b30c8d43..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/app_connectors_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: app_connectors_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - app_connectors_iam_bindings - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameapp_connectors_iam_bindings
TypeResource
Idgoogle.beyondcorp.app_connectors_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_appConnectors_getIamPolicy` | `SELECT` | `appConnectorsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md b/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md index c0ea3c1bc5..bece67eb0d 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Unique resource name of the AppGateway. The name is ignored when creating an AppGateway. | -| `state` | `string` | Output only. The current state of the AppGateway. | -| `type` | `string` | Required. The type of network connectivity used by the AppGateway. | -| `hostType` | `string` | Required. The type of hosting used by the AppGateway. | | `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `allocatedConnections` | `array` | Output only. A list of connections allocated for the Gateway | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | +| `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | | `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | -| `uri` | `string` | Output only. Server-defined URI for this resource. | | `displayName` | `string` | Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters. | -| `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | -| `createTime` | `string` | Output only. Timestamp when the resource was created. | -| `allocatedConnections` | `array` | Output only. A list of connections allocated for the Gateway | +| `hostType` | `string` | Required. The type of hosting used by the AppGateway. | +| `uri` | `string` | Output only. Server-defined URI for this resource. | +| `state` | `string` | Output only. The current state of the AppGateway. | +| `type` | `string` | Required. The type of network connectivity used by the AppGateway. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_audit_configs/index.md b/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_audit_configs/index.md deleted file mode 100644 index 0eec4e7bf4..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: app_gateways_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - app_gateways_iam_audit_configs - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameapp_gateways_iam_audit_configs
TypeResource
Idgoogle.beyondcorp.app_gateways_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_appGateways_getIamPolicy` | `SELECT` | `appGatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_bindings/index.md b/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_bindings/index.md deleted file mode 100644 index 0ec154851b..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: app_gateways_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - app_gateways_iam_bindings - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameapp_gateways_iam_bindings
TypeResource
Idgoogle.beyondcorp.app_gateways_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_appGateways_getIamPolicy` | `SELECT` | `appGatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/client_connector_services/index.md b/docs/google-docs/providers/google/beyondcorp/client_connector_services/index.md deleted file mode 100644 index e56222b28a..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/client_connector_services/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: client_connector_services -hide_title: false -hide_table_of_contents: false -keywords: - - client_connector_services - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameclient_connector_services
TypeResource
Idgoogle.beyondcorp.client_connector_services
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Required. Name of resource. The name is ignored during creation. | -| `ingress` | `object` | Settings of how to connect to the ClientGateway. One of the following options should be set. | -| `state` | `string` | Output only. The operational state of the ClientConnectorService. | -| `updateTime` | `string` | Output only. [Output only] Update time stamp. | -| `createTime` | `string` | Output only. [Output only] Create time stamp. | -| `displayName` | `string` | Optional. User-provided name. The display name should follow certain format. * Must be 6 to 30 characters in length. * Can only contain lowercase letters, numbers, and hyphens. * Must start with a letter. | -| `egress` | `object` | The details of the egress info. One of the following options should be set. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_clientConnectorServices_get` | `SELECT` | `clientConnectorServicesId, locationsId, projectsId` | Gets details of a single ClientConnectorService. | -| `projects_locations_clientConnectorServices_list` | `SELECT` | `locationsId, projectsId` | Lists ClientConnectorServices in a given project and location. | -| `projects_locations_clientConnectorServices_create` | `INSERT` | `locationsId, projectsId` | Creates a new ClientConnectorService in a given project and location. | -| `projects_locations_clientConnectorServices_delete` | `DELETE` | `clientConnectorServicesId, locationsId, projectsId` | Deletes a single ClientConnectorService. | -| `projects_locations_clientConnectorServices_patch` | `EXEC` | `clientConnectorServicesId, locationsId, projectsId` | Updates the parameters of a single ClientConnectorService. | diff --git a/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_audit_configs/index.md b/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_audit_configs/index.md deleted file mode 100644 index b2c8a02cf4..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: client_connector_services_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - client_connector_services_iam_audit_configs - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameclient_connector_services_iam_audit_configs
TypeResource
Idgoogle.beyondcorp.client_connector_services_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_clientConnectorServices_getIamPolicy` | `SELECT` | `clientConnectorServicesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_bindings/index.md b/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_bindings/index.md deleted file mode 100644 index a68151b416..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: client_connector_services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - client_connector_services_iam_bindings - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameclient_connector_services_iam_bindings
TypeResource
Idgoogle.beyondcorp.client_connector_services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_clientConnectorServices_getIamPolicy` | `SELECT` | `clientConnectorServicesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_policies/index.md b/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_policies/index.md index 595fea17b7..a80e073eb7 100644 --- a/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_policies/index.md +++ b/docs/google-docs/providers/google/beyondcorp/client_connector_services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/client_gateways/index.md b/docs/google-docs/providers/google/beyondcorp/client_gateways/index.md deleted file mode 100644 index 3537be4e68..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/client_gateways/index.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: client_gateways -hide_title: false -hide_table_of_contents: false -keywords: - - client_gateways - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameclient_gateways
TypeResource
Idgoogle.beyondcorp.client_gateways
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | Output only. A unique identifier for the instance generated by the system. | -| `name` | `string` | Required. name of resource. The name is ignored during creation. | -| `createTime` | `string` | Output only. [Output only] Create time stamp. | -| `state` | `string` | Output only. The operational state of the gateway. | -| `updateTime` | `string` | Output only. [Output only] Update time stamp. | -| `clientConnectorService` | `string` | Output only. The client connector service name that the client gateway is associated to. Client Connector Services, named as follows: `projects/{project_id}/locations/{location_id}/client_connector_services/{client_connector_service_id}`. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_clientGateways_get` | `SELECT` | `clientGatewaysId, locationsId, projectsId` | Gets details of a single ClientGateway. | -| `projects_locations_clientGateways_list` | `SELECT` | `locationsId, projectsId` | Lists ClientGateways in a given project and location. | -| `projects_locations_clientGateways_create` | `INSERT` | `locationsId, projectsId` | Creates a new ClientGateway in a given project and location. | -| `projects_locations_clientGateways_delete` | `DELETE` | `clientGatewaysId, locationsId, projectsId` | Deletes a single ClientGateway. | diff --git a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_audit_configs/index.md b/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_audit_configs/index.md deleted file mode 100644 index 29efdb72ee..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: client_gateways_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - client_gateways_iam_audit_configs - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameclient_gateways_iam_audit_configs
TypeResource
Idgoogle.beyondcorp.client_gateways_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_clientGateways_getIamPolicy` | `SELECT` | `clientGatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_bindings/index.md b/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_bindings/index.md deleted file mode 100644 index 5de742127b..0000000000 --- a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: client_gateways_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - client_gateways_iam_bindings - - beyondcorp - - 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 ---- - - - -## Overview - - - - -
Nameclient_gateways_iam_bindings
TypeResource
Idgoogle.beyondcorp.client_gateways_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_clientGateways_getIamPolicy` | `SELECT` | `clientGatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md b/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md index 6961883298..571e3b3f03 100644 --- a/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md +++ b/docs/google-docs/providers/google/beyondcorp/client_gateways_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/operations/index.md b/docs/google-docs/providers/google/beyondcorp/operations/index.md index e27c6fc809..358d77027d 100644 --- a/docs/google-docs/providers/google/beyondcorp/operations/index.md +++ b/docs/google-docs/providers/google/beyondcorp/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/datasets/index.md b/docs/google-docs/providers/google/bigquery/datasets/index.md index 50b1e1beb0..265a048950 100644 --- a/docs/google-docs/providers/google/bigquery/datasets/index.md +++ b/docs/google-docs/providers/google/bigquery/datasets/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The fully-qualified, unique, opaque ID of the dataset. | -| `friendlyName` | `string` | A descriptive name for the dataset, if one exists. | | `kind` | `string` | The resource type. This property always returns the value "bigquery#dataset". | | `labels` | `object` | The labels associated with this dataset. You can use these to organize and group your datasets. | | `location` | `string` | The geographic location where the data resides. | | `datasetReference` | `object` | | +| `friendlyName` | `string` | A descriptive name for the dataset, if one exists. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/jobs/index.md b/docs/google-docs/providers/google/bigquery/jobs/index.md index 2d49087ef0..8a1f318484 100644 --- a/docs/google-docs/providers/google/bigquery/jobs/index.md +++ b/docs/google-docs/providers/google/bigquery/jobs/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | Unique opaque ID of the job. | +| `configuration` | `object` | | +| `state` | `string` | Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed. | +| `jobReference` | `object` | | | `status` | `object` | | -| `statistics` | `object` | | +| `user_email` | `string` | [Full-projection-only] Email address of the user who ran the job. | | `errorResult` | `object` | | | `kind` | `string` | The resource type. | -| `user_email` | `string` | [Full-projection-only] Email address of the user who ran the job. | -| `configuration` | `object` | | -| `jobReference` | `object` | | -| `state` | `string` | Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed. | +| `statistics` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md b/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md index 73ac332a27..c56ceea8ac 100644 --- a/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md +++ b/docs/google-docs/providers/google/bigquery/jobs_query_results/index.md @@ -27,18 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `cacheHit` | `boolean` | Whether the query result was fetched from the query cache. | -| `totalBytesProcessed` | `string` | The total number of bytes processed for this query. | -| `etag` | `string` | A hash of this response. | -| `jobComplete` | `boolean` | Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. | -| `pageToken` | `string` | A token used for paging results. | -| `numDmlAffectedRows` | `string` | [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. | | `schema` | `object` | | -| `errors` | `array` | [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. | +| `jobComplete` | `boolean` | Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available. | | `jobReference` | `object` | | +| `totalBytesProcessed` | `string` | The total number of bytes processed for this query. | +| `errors` | `array` | [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful. | +| `pageToken` | `string` | A token used for paging results. | +| `rows` | `array` | An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. | +| `etag` | `string` | A hash of this response. | | `totalRows` | `string` | The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully. | +| `cacheHit` | `boolean` | Whether the query result was fetched from the query cache. | | `kind` | `string` | The resource type of the response. | -| `rows` | `array` | An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully. | +| `numDmlAffectedRows` | `string` | [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigquery/models/index.md b/docs/google-docs/providers/google/bigquery/models/index.md index 8e80c4c8f9..b2901323e8 100644 --- a/docs/google-docs/providers/google/bigquery/models/index.md +++ b/docs/google-docs/providers/google/bigquery/models/index.md @@ -28,26 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | Optional. A user-friendly description of this model. | -| `modelReference` | `object` | | -| `creationTime` | `string` | Output only. The time when this model was created, in millisecs since the epoch. | -| `hparamTrials` | `array` | Output only. Trials of a [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. | +| `etag` | `string` | Output only. A hash of this resource. | +| `modelType` | `string` | Output only. Type of the model resource. | | `defaultTrialId` | `string` | Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the best trial ID. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, this is the smallest trial ID among all Pareto optimal trials. | +| `labels` | `object` | The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. | +| `featureColumns` | `array` | Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause. | +| `friendlyName` | `string` | Optional. A descriptive name for this model. | +| `labelColumns` | `array` | Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns. | | `expirationTime` | `string` | Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models. | -| `hparamSearchSpaces` | `object` | Hyperparameter search spaces. These should be a subset of training_options. | +| `modelReference` | `object` | | | `location` | `string` | Output only. The geographic location where the model resides. This value is inherited from the dataset. | +| `lastModifiedTime` | `string` | Output only. The time when this model was last modified, in millisecs since the epoch. | | `optimalTrialIds` | `array` | Output only. For single-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it only contains the best trial. For multi-objective [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) models, it contains all Pareto optimal trials sorted by trial_id. | +| `remoteModelInfo` | `object` | Remote Model Info | +| `creationTime` | `string` | Output only. The time when this model was created, in millisecs since the epoch. | +| `encryptionConfiguration` | `object` | | +| `hparamSearchSpaces` | `object` | Hyperparameter search spaces. These should be a subset of training_options. | | `transformColumns` | `array` | Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model. | -| `friendlyName` | `string` | Optional. A descriptive name for this model. | | `bestTrialId` | `string` | The best trial_id across all training runs. | -| `labels` | `object` | The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key. | -| `featureColumns` | `array` | Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause. | -| `encryptionConfiguration` | `object` | | -| `remoteModelInfo` | `object` | Remote Model Info | +| `hparamTrials` | `array` | Output only. Trials of a [hyperparameter tuning](/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning-overview) model sorted by trial_id. | | `trainingRuns` | `array` | Information for all training runs in increasing order of start_time. | -| `labelColumns` | `array` | Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns. | -| `lastModifiedTime` | `string` | Output only. The time when this model was last modified, in millisecs since the epoch. | -| `modelType` | `string` | Output only. Type of the model resource. | -| `etag` | `string` | Output only. A hash of this resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/projects/index.md b/docs/google-docs/providers/google/bigquery/projects/index.md index 41e41b626c..2eafa88fe4 100644 --- a/docs/google-docs/providers/google/bigquery/projects/index.md +++ b/docs/google-docs/providers/google/bigquery/projects/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | An opaque ID of this project. | -| `friendlyName` | `string` | A descriptive name for this project. | | `kind` | `string` | The resource type. | | `numericId` | `string` | The numeric ID of this project. | | `projectReference` | `object` | | +| `friendlyName` | `string` | A descriptive name for this project. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigquery/projects_service_account/index.md b/docs/google-docs/providers/google/bigquery/projects_service_account/index.md deleted file mode 100644 index 730b4b752e..0000000000 --- a/docs/google-docs/providers/google/bigquery/projects_service_account/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: projects_service_account -hide_title: false -hide_table_of_contents: false -keywords: - - projects_service_account - - bigquery - - 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 ---- - - - -## Overview - - - - -
Nameprojects_service_account
TypeResource
Idgoogle.bigquery.projects_service_account
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `email` | `string` | The service account email address. | -| `kind` | `string` | The resource type of the response. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getServiceAccount` | `SELECT` | `projectId` | diff --git a/docs/google-docs/providers/google/bigquery/routines/index.md b/docs/google-docs/providers/google/bigquery/routines/index.md index b8e7924b04..b3a323fbb2 100644 --- a/docs/google-docs/providers/google/bigquery/routines/index.md +++ b/docs/google-docs/providers/google/bigquery/routines/index.md @@ -28,21 +28,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | Optional. The description of the routine, if defined. | -| `returnType` | `object` | The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } | -| `importedLibraries` | `array` | Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. | -| `language` | `string` | Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. | | `strictMode` | `boolean` | Optional. Can be set for procedures only. If true (default), the definition body will be validated in the creation and the updates of the procedure. For procedures with an argument of ANY TYPE, the definition body validtion is not supported at creation/update time, and thus this field must be set to false explicitly. | -| `returnTableType` | `object` | A table type | +| `arguments` | `array` | Optional. | +| `language` | `string` | Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. | | `routineType` | `string` | Required. The type of routine. | -| `definitionBody` | `string` | Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. | -| `lastModifiedTime` | `string` | Output only. The time when this routine was last modified, in milliseconds since the epoch. | -| `creationTime` | `string` | Output only. The time when this routine was created, in milliseconds since the epoch. | | `routineReference` | `object` | | +| `remoteFunctionOptions` | `object` | Options for a remote user-defined function. | +| `definitionBody` | `string` | Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))` The definition_body is `concat(x, "\n", y)` (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'` The definition_body is `return "\n";\n` Note that both \n are replaced with linebreaks. | +| `importedLibraries` | `array` | Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. | | `sparkOptions` | `object` | Options for a user-defined Spark routine. | -| `determinismLevel` | `string` | Optional. The determinism level of the JavaScript UDF, if defined. | +| `creationTime` | `string` | Output only. The time when this routine was created, in milliseconds since the epoch. | | `etag` | `string` | Output only. A hash of this resource. | -| `arguments` | `array` | Optional. | -| `remoteFunctionOptions` | `object` | Options for a remote user-defined function. | +| `lastModifiedTime` | `string` | Output only. The time when this routine was last modified, in milliseconds since the epoch. | +| `returnTableType` | `object` | A table type | +| `determinismLevel` | `string` | Optional. The determinism level of the JavaScript UDF, if defined. | +| `returnType` | `object` | The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/row_access_policies_iam_policies/index.md b/docs/google-docs/providers/google/bigquery/row_access_policies_iam_policies/index.md deleted file mode 100644 index b7e425fbdd..0000000000 --- a/docs/google-docs/providers/google/bigquery/row_access_policies_iam_policies/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: row_access_policies_iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - row_access_policies_iam_policies - - bigquery - - 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 ---- - - - -## Overview - - - - -
Namerow_access_policies_iam_policies
TypeResource
Idgoogle.bigquery.row_access_policies_iam_policies
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `get_iam_policy` | `EXEC` | `resource` | diff --git a/docs/google-docs/providers/google/bigquery/service_account/index.md b/docs/google-docs/providers/google/bigquery/service_account/index.md index ec13fc095e..3cff2c47bb 100644 --- a/docs/google-docs/providers/google/bigquery/service_account/index.md +++ b/docs/google-docs/providers/google/bigquery/service_account/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `email` | `string` | The service account email address. | | `kind` | `string` | The resource type of the response. | +| `email` | `string` | The service account email address. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigquery/tables/index.md b/docs/google-docs/providers/google/bigquery/tables/index.md index 263a4f3298..9c13308e98 100644 --- a/docs/google-docs/providers/google/bigquery/tables/index.md +++ b/docs/google-docs/providers/google/bigquery/tables/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | An opaque ID of the table | -| `kind` | `string` | The resource type. | -| `tableReference` | `object` | | -| `type` | `string` | The type of table. Possible values are: TABLE, VIEW. | | `expirationTime` | `string` | [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. | -| `friendlyName` | `string` | The user-friendly name for this table. | +| `kind` | `string` | The resource type. | | `timePartitioning` | `object` | | -| `view` | `object` | Additional details for a view. | +| `rangePartitioning` | `object` | | +| `type` | `string` | The type of table. Possible values are: TABLE, VIEW. | | `clustering` | `object` | | +| `view` | `object` | Additional details for a view. | +| `tableReference` | `object` | | | `creationTime` | `string` | The time when this table was created, in milliseconds since the epoch. | +| `friendlyName` | `string` | The user-friendly name for this table. | | `labels` | `object` | The labels associated with this table. You can use these to organize and group your tables. | -| `rangePartitioning` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryconnection/connections/index.md b/docs/google-docs/providers/google/bigqueryconnection/connections/index.md index 12a282494e..480a84a540 100644 --- a/docs/google-docs/providers/google/bigqueryconnection/connections/index.md +++ b/docs/google-docs/providers/google/bigqueryconnection/connections/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` | | `description` | `string` | User provided description. | +| `creationTime` | `string` | Output only. The creation timestamp of the connection. | | `friendlyName` | `string` | User provided display name for the connection. | | `hasCredential` | `boolean` | Output only. True, if credential is configured for this connection. | | `lastModifiedTime` | `string` | Output only. The last update timestamp of the connection. | | `cloudSql` | `object` | Connection properties specific to the Cloud SQL. | -| `creationTime` | `string` | Output only. The creation timestamp of the connection. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_audit_configs/index.md b/docs/google-docs/providers/google/bigqueryconnection/connections_iam_audit_configs/index.md deleted file mode 100644 index d8539ab817..0000000000 --- a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: connections_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - connections_iam_audit_configs - - bigqueryconnection - - 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 ---- - - - -## Overview - - - - -
Nameconnections_iam_audit_configs
TypeResource
Idgoogle.bigqueryconnection.connections_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_connections_getIamPolicy` | `SELECT` | `connectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_bindings/index.md b/docs/google-docs/providers/google/bigqueryconnection/connections_iam_bindings/index.md deleted file mode 100644 index b3d5a085ee..0000000000 --- a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: connections_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - connections_iam_bindings - - bigqueryconnection - - 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 ---- - - - -## Overview - - - - -
Nameconnections_iam_bindings
TypeResource
Idgoogle.bigqueryconnection.connections_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_connections_getIamPolicy` | `SELECT` | `connectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md b/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md index 54be12af0b..67647b47f3 100644 --- a/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/bigqueryconnection/connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md index 9f3bf0debd..de00eb3ede 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md @@ -29,22 +29,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Data source resource name. | | `description` | `string` | User friendly data source description string. | -| `defaultDataRefreshWindowDays` | `integer` | Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. | +| `supportsCustomSchedule` | `boolean` | Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule. | +| `supportsMultipleTransfers` | `boolean` | Deprecated. This field has no effect. | +| `scopes` | `array` | Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery | +| `clientId` | `string` | Data source client id which should be used to receive refresh token. | +| `minimumScheduleInterval` | `string` | The minimum interval for scheduler to schedule runs. | | `dataRefreshType` | `string` | Specifies whether the data source supports automatic data refresh for the past few days, and how it's supported. For some data sources, data might not be complete until a few days later, so it's useful to refresh data automatically. | +| `transferType` | `string` | Deprecated. This field has no effect. | +| `authorizationType` | `string` | Indicates the type of authorization. | | `parameters` | `array` | Data source parameters. | -| `manualRunsDisabled` | `boolean` | Disables backfilling and manual run scheduling for the data source. | | `dataSourceId` | `string` | Data source id. | -| `helpUrl` | `string` | Url for the help document for this data source. | -| `transferType` | `string` | Deprecated. This field has no effect. | -| `scopes` | `array` | Api auth scopes for which refresh token needs to be obtained. These are scopes needed by a data source to prepare data and ingest them into BigQuery, e.g., https://www.googleapis.com/auth/bigquery | -| `updateDeadlineSeconds` | `integer` | The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. | -| `supportsMultipleTransfers` | `boolean` | Deprecated. This field has no effect. | +| `manualRunsDisabled` | `boolean` | Disables backfilling and manual run scheduling for the data source. | | `defaultSchedule` | `string` | Default data transfer schedule. Examples of valid schedules include: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. | -| `minimumScheduleInterval` | `string` | The minimum interval for scheduler to schedule runs. | +| `defaultDataRefreshWindowDays` | `integer` | Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. | | `displayName` | `string` | User friendly data source name. | -| `authorizationType` | `string` | Indicates the type of authorization. | -| `supportsCustomSchedule` | `boolean` | Specifies whether the data source supports a user defined schedule, or operates on the default schedule. When set to `true`, user can override default schedule. | -| `clientId` | `string` | Data source client id which should be used to receive refresh token. | +| `updateDeadlineSeconds` | `integer` | The number of seconds to wait for an update from the data source before the Data Transfer Service marks the transfer as FAILED. | +| `helpUrl` | `string` | Url for the help document for this data source. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md index 35075fdecb..89813812dd 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the transfer run. Transfer run names have the form `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. The name is ignored when creating a transfer run. | | `notificationPubsubTopic` | `string` | Output only. Pub/Sub topic where a notification will be sent after this transfer run finishes. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` | -| `startTime` | `string` | Output only. Time when transfer run was started. Parameter ignored by server for input requests. | +| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | +| `state` | `string` | Data transfer run state. Ignored for input requests. | +| `runTime` | `string` | For batch transfer runs, specifies the date and time of the data should be ingested. | | `errorStatus` | `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). | +| `startTime` | `string` | Output only. Time when transfer run was started. Parameter ignored by server for input requests. | | `schedule` | `string` | Output only. Describes the schedule of this transfer run if it was created as part of a regular schedule. For batch transfer runs that are scheduled manually, this is empty. NOTE: the system might choose to delay the schedule depending on the current load, so `schedule_time` doesn't always match this. | | `dataSourceId` | `string` | Output only. Data source id. | -| `scheduleTime` | `string` | Minimum time after which a transfer run can be started. | -| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | | `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | -| `params` | `object` | Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq | | `endTime` | `string` | Output only. Time when transfer run ended. Parameter ignored by server for input requests. | -| `runTime` | `string` | For batch transfer runs, specifies the date and time of the data should be ingested. | -| `updateTime` | `string` | Output only. Last time the data transfer run state was updated. | +| `scheduleTime` | `string` | Minimum time after which a transfer run can be started. | | `destinationDatasetId` | `string` | Output only. The BigQuery target dataset id. | -| `state` | `string` | Data transfer run state. Ignored for input requests. | +| `updateTime` | `string` | Output only. Last time the data transfer run state was updated. | +| `params` | `object` | Output only. Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md index 217ed9436f..ca2090a1a8 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md @@ -28,23 +28,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the transfer config. Transfer config names have the form `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. Where `config_id` is usually a uuid, even though it is not guaranteed or required. The name is ignored when creating a transfer config. | -| `dataSourceId` | `string` | Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list | -| `datasetRegion` | `string` | Output only. Region in which BigQuery dataset is located. | -| `schedule` | `string` | Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source. | +| `params` | `object` | Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq | | `nextRunTime` | `string` | Output only. Next time when data transfer will run. | -| `dataRefreshWindowDays` | `integer` | The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. | -| `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | -| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | -| `notificationPubsubTopic` | `string` | Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` | -| `destinationDatasetId` | `string` | The BigQuery target dataset id. | -| `updateTime` | `string` | Output only. Data transfer modification time. Ignored by server on input. | +| `encryptionConfiguration` | `object` | Represents the encryption configuration for a transfer. | | `state` | `string` | Output only. State of the most recently updated transfer run. | +| `dataRefreshWindowDays` | `integer` | The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. | | `disabled` | `boolean` | Is this config disabled. When set to true, no runs are scheduled for a given transfer. | -| `ownerInfo` | `object` | Information about a user. | -| `encryptionConfiguration` | `object` | Represents the encryption configuration for a transfer. | | `displayName` | `string` | User specified display name for the data transfer. | -| `params` | `object` | Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq | +| `datasetRegion` | `string` | Output only. Region in which BigQuery dataset is located. | +| `updateTime` | `string` | Output only. Data transfer modification time. Ignored by server on input. | +| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | +| `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | +| `ownerInfo` | `object` | Information about a user. | +| `schedule` | `string` | Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: `1st,3rd monday of month 15:30`, `every wed,fri of jan,jun 13:15`, and `first sunday of quarter 00:00`. See more explanation about the format here: https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source. | +| `notificationPubsubTopic` | `string` | Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. The format for specifying a pubsub topic is: `projects/{project}/topics/{topic}` | +| `dataSourceId` | `string` | Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list | | `scheduleOptions` | `object` | Options customizing the data transfer schedule. | +| `destinationDatasetId` | `string` | The BigQuery target dataset id. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md index 150130e6c5..a2309c43b4 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_logs/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `severity` | `string` | Message severity. | | `messageText` | `string` | Message text. | | `messageTime` | `string` | Time when message was logged. | -| `severity` | `string` | Message severity. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md b/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md index f0c8c2dc55..a64887120a 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/assignments/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the resource. E.g.: `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The assignment_id must only contain lower case alphanumeric characters or dashes and the max length is 64 characters. | +| `jobType` | `string` | Which type of jobs will use the reservation. | | `state` | `string` | Output only. State of the assignment. | | `assignee` | `string` | The resource which will use the reservation. E.g. `projects/myproject`, `folders/123`, or `organizations/456`. | -| `jobType` | `string` | Which type of jobs will use the reservation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md b/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md index afc1c32c0c..5271358432 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/bi_reservation/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. | +| `preferredTables` | `array` | Preferred tables to use BI capacity for. | | `size` | `string` | Size of a reservation, in bytes. | | `updateTime` | `string` | Output only. The last update timestamp of a reservation. | -| `preferredTables` | `array` | Preferred tables to use BI capacity for. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md b/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md index f986379812..4d77b0cbf3 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the capacity commitment, e.g., `projects/myproject/locations/US/capacityCommitments/123` The commitment_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. | -| `edition` | `string` | Edition of the capacity commitment. | -| `failureStatus` | `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). | -| `multiRegionAuxiliary` | `boolean` | Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. | | `renewalPlan` | `string` | The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. | -| `commitmentStartTime` | `string` | Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. | -| `isFlatRate` | `boolean` | Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment. | | `slotCount` | `string` | Number of slots in this commitment. | -| `plan` | `string` | Capacity commitment commitment plan. | +| `isFlatRate` | `boolean` | Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment. | +| `failureStatus` | `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). | | `state` | `string` | Output only. State of the commitment. | | `commitmentEndTime` | `string` | Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. | +| `edition` | `string` | Edition of the capacity commitment. | +| `plan` | `string` | Capacity commitment commitment plan. | +| `commitmentStartTime` | `string` | Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. | +| `multiRegionAuxiliary` | `boolean` | Applicable only for commitments located within one of the BigQuery multi-regions (US or EU). If set to true, this commitment is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this commitment is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryreservation/locations_bi_reservation/index.md b/docs/google-docs/providers/google/bigqueryreservation/locations_bi_reservation/index.md deleted file mode 100644 index da719b751a..0000000000 --- a/docs/google-docs/providers/google/bigqueryreservation/locations_bi_reservation/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: locations_bi_reservation -hide_title: false -hide_table_of_contents: false -keywords: - - locations_bi_reservation - - bigqueryreservation - - 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 ---- - - - -## Overview - - - - -
Namelocations_bi_reservation
TypeResource
Idgoogle.bigqueryreservation.locations_bi_reservation
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the singleton BI reservation. Reservation names have the form `projects/{project_id}/locations/{location_id}/biReservation`. | -| `size` | `string` | Size of a reservation, in bytes. | -| `updateTime` | `string` | Output only. The last update timestamp of a reservation. | -| `preferredTables` | `array` | Preferred tables to use BI capacity for. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_getBiReservation` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md b/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md index 6b0a550264..673af9989f 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters. | +| `multiRegionAuxiliary` | `boolean` | Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. | +| `autoscale` | `object` | Auto scaling settings. | | `concurrency` | `string` | Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation. This is a soft target due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency target will be automatically computed by the system. NOTE: this field is exposed as `target_job_concurrency` in the Information Schema, DDL and BQ CLI. | -| `creationTime` | `string` | Output only. Creation time of the reservation. | | `edition` | `string` | Edition of the reservation. | -| `autoscale` | `object` | Auto scaling settings. | -| `multiRegionAuxiliary` | `boolean` | Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region. NOTE: this is a preview feature. Project must be allow-listed in order to set this field. | | `slotCapacity` | `string` | Baseline slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false, or autoscaling is enabled. If edition is EDITION_UNSPECIFIED and total slot_capacity of the reservation and its siblings exceeds the total slot_count of all capacity commitments, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. If edition is any value but EDITION_UNSPECIFIED, then the above requirement is not needed. The total slot_capacity of the reservation and its siblings may exceed the total slot_count of capacity commitments. In that case, the exceeding slots will be charged with the autoscale SKU. You can increase the number of baseline slots in a reservation every few minutes. If you want to decrease your baseline slots, you are limited to once an hour if you have recently changed your baseline slot capacity and your baseline slots exceed your committed slots. Otherwise, you can decrease your baseline slots every few minutes. | -| `updateTime` | `string` | Output only. Last update time of the reservation. | | `ignoreIdleSlots` | `boolean` | If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most. | +| `creationTime` | `string` | Output only. Creation time of the reservation. | +| `updateTime` | `string` | Output only. Last update time of the reservation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/backups/index.md b/docs/google-docs/providers/google/bigtableadmin/backups/index.md index 3b3745f0aa..b1287a7950 100644 --- a/docs/google-docs/providers/google/bigtableadmin/backups/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/backups/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | A globally unique identifier for the backup which cannot be changed. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/ backups/_a-zA-Z0-9*` The final segment of the name must be between 1 and 50 characters in length. The backup is stored in the cluster identified by the prefix of the backup name of the form `projects/{project}/instances/{instance}/clusters/{cluster}`. | -| `sizeBytes` | `string` | Output only. Size of the backup in bytes. | -| `endTime` | `string` | Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. | -| `startTime` | `string` | Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp. | -| `sourceBackup` | `string` | Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/. | -| `expireTime` | `string` | Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup. | -| `encryptionInfo` | `object` | Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. | | `sourceTable` | `string` | Required. Immutable. Name of the table from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects/{project}/instances/{instance}/tables/{source_table}`. | +| `expireTime` | `string` | Required. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 90 days from the time the request is received. Once the `expire_time` has passed, Cloud Bigtable will delete the backup and free the resources used by the backup. | +| `sourceBackup` | `string` | Output only. Name of the backup from which this backup was copied. If a backup is not created by copying a backup, this field will be empty. Values are of the form: projects//instances//backups/. | +| `startTime` | `string` | Output only. `start_time` is the time that the backup was started (i.e. approximately the time the CreateBackup request is received). The row data in this backup will be no older than this timestamp. | +| `sizeBytes` | `string` | Output only. Size of the backup in bytes. | | `state` | `string` | Output only. The current state of the backup. | +| `encryptionInfo` | `object` | Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service (Cloud KMS) key version is specified along with its status. | +| `endTime` | `string` | Output only. `end_time` is the time that the backup was finished. The row data in the backup will be no newer than this timestamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/backups_iam_audit_configs/index.md b/docs/google-docs/providers/google/bigtableadmin/backups_iam_audit_configs/index.md deleted file mode 100644 index f90422635c..0000000000 --- a/docs/google-docs/providers/google/bigtableadmin/backups_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: backups_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_audit_configs - - bigtableadmin - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_audit_configs
TypeResource
Idgoogle.bigtableadmin.backups_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_clusters_backups_getIamPolicy` | `SELECT` | `backupsId, clustersId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/bigtableadmin/backups_iam_bindings/index.md b/docs/google-docs/providers/google/bigtableadmin/backups_iam_bindings/index.md deleted file mode 100644 index 4f45d279d1..0000000000 --- a/docs/google-docs/providers/google/bigtableadmin/backups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: backups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_bindings - - bigtableadmin - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_bindings
TypeResource
Idgoogle.bigtableadmin.backups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_clusters_backups_getIamPolicy` | `SELECT` | `backupsId, clustersId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md b/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md index 27c6ac08ff..961121fa40 100644 --- a/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/backups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/clusters/index.md b/docs/google-docs/providers/google/bigtableadmin/clusters/index.md index f11fd6ff6a..f46cb01edf 100644 --- a/docs/google-docs/providers/google/bigtableadmin/clusters/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/clusters/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique name of the cluster. Values are of the form `projects/{project}/instances/{instance}/clusters/a-z*`. | -| `clusterConfig` | `object` | Configuration for a cluster. | -| `defaultStorageType` | `string` | Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. | | `encryptionConfig` | `object` | Cloud Key Management Service (Cloud KMS) settings for a CMEK-protected cluster. | | `location` | `string` | Immutable. The location where this cluster's nodes and storage reside. For best performance, clients should be located as close as possible to this cluster. Currently only zones are supported, so values should be of the form `projects/{project}/locations/{zone}`. | | `serveNodes` | `integer` | The number of nodes allocated to this cluster. More nodes enable higher throughput and more consistent performance. | | `state` | `string` | Output only. The current state of the cluster. | +| `clusterConfig` | `object` | Configuration for a cluster. | +| `defaultStorageType` | `string` | Immutable. The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md b/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md index 763af1aa50..fabf6f7426 100644 --- a/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique name of the hot tablet. Values are of the form `projects/{project}/instances/{instance}/clusters/{cluster}/hotTablets/[a-zA-Z0-9_-]*`. | -| `startTime` | `string` | Output only. The start time of the hot tablet. | -| `tableName` | `string` | Name of the table that contains the tablet. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. | -| `endKey` | `string` | Tablet End Key (inclusive). | | `endTime` | `string` | Output only. The end time of the hot tablet. | | `nodeCpuUsagePercent` | `number` | Output only. The average CPU usage spent by a node on this tablet over the start_time to end_time time range. The percentage is the amount of CPU used by the node to serve the tablet, from 0% (tablet was not interacted with) to 100% (the node spent all cycles serving the hot tablet). | | `startKey` | `string` | Tablet Start Key (inclusive). | +| `startTime` | `string` | Output only. The start time of the hot tablet. | +| `tableName` | `string` | Name of the table that contains the tablet. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. | +| `endKey` | `string` | Tablet End Key (inclusive). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/instances/index.md b/docs/google-docs/providers/google/bigtableadmin/instances/index.md index dee2f18ede..981b918d2c 100644 --- a/docs/google-docs/providers/google/bigtableadmin/instances/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/instances/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique name of the instance. Values are of the form `projects/{project}/instances/a-z+[a-z0-9]`. | -| `createTime` | `string` | Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. | -| `displayName` | `string` | Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. | -| `labels` | `object` | Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. | | `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | | `state` | `string` | Output only. The current state of the instance. | | `type` | `string` | The type of the instance. Defaults to `PRODUCTION`. | +| `createTime` | `string` | Output only. A commit timestamp representing when this Instance was created. For instances created before this field was added (August 2021), this value is `seconds: 0, nanos: 1`. | +| `displayName` | `string` | Required. The descriptive name for this instance as it appears in UIs. Can be changed at any time, but should be kept globally unique to avoid confusion. | +| `labels` | `object` | Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. They can be used to filter resources and aggregate metrics. * Label keys must be between 1 and 63 characters long and must conform to the regular expression: `\p{Ll}\p{Lo}{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression: `[\p{Ll}\p{Lo}\p{N}_-]{0,63}`. * No more than 64 labels can be associated with a given resource. * Keys and values must both be under 128 bytes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/instances_iam_audit_configs/index.md b/docs/google-docs/providers/google/bigtableadmin/instances_iam_audit_configs/index.md deleted file mode 100644 index 3452d1c33a..0000000000 --- a/docs/google-docs/providers/google/bigtableadmin/instances_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: instances_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_audit_configs - - bigtableadmin - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_audit_configs
TypeResource
Idgoogle.bigtableadmin.instances_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_getIamPolicy` | `SELECT` | `instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/bigtableadmin/instances_iam_bindings/index.md b/docs/google-docs/providers/google/bigtableadmin/instances_iam_bindings/index.md deleted file mode 100644 index 5914c6de01..0000000000 --- a/docs/google-docs/providers/google/bigtableadmin/instances_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instances_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_bindings - - bigtableadmin - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_bindings
TypeResource
Idgoogle.bigtableadmin.instances_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_getIamPolicy` | `SELECT` | `instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/bigtableadmin/locations/index.md b/docs/google-docs/providers/google/bigtableadmin/locations/index.md index 7270f53324..1242343a3e 100644 --- a/docs/google-docs/providers/google/bigtableadmin/locations/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/tables/index.md b/docs/google-docs/providers/google/bigtableadmin/tables/index.md index 1cb3f55615..1b7a10a3b9 100644 --- a/docs/google-docs/providers/google/bigtableadmin/tables/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/tables/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique name of the table. Values are of the form `projects/{project}/instances/{instance}/tables/_a-zA-Z0-9*`. Views: `NAME_ONLY`, `SCHEMA_VIEW`, `REPLICATION_VIEW`, `STATS_VIEW`, `FULL` | -| `columnFamilies` | `object` | The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL` | | `deletionProtection` | `boolean` | Set to true to make the table protected against data loss. i.e. deleting the following resources through Admin APIs are prohibited: * The table. * The column families in the table. * The instance containing the table. Note one can still delete the data stored in the table through Data APIs. | | `granularity` | `string` | Immutable. The granularity (i.e. `MILLIS`) at which timestamps are stored in this table. Timestamps not matching the granularity will be rejected. If unspecified at creation time, the value will be set to `MILLIS`. Views: `SCHEMA_VIEW`, `FULL`. | | `restoreInfo` | `object` | Information about a table restore. | | `stats` | `object` | Approximate statistics related to a table. These statistics are calculated infrequently, while simultaneously, data in the table can change rapidly. Thus the values reported here (e.g. row count) are very likely out-of date, even the instant they are received in this API. Thus, only treat these values as approximate. IMPORTANT: Everything below is approximate, unless otherwise specified. | | `changeStreamConfig` | `object` | Change stream configuration. | | `clusterStates` | `object` | Output only. Map from cluster ID to per-cluster table state. If it could not be determined whether or not the table has data in a particular cluster (for example, if its zone is unavailable), then there will be an entry for the cluster with UNKNOWN `replication_status`. Views: `REPLICATION_VIEW`, `ENCRYPTION_VIEW`, `FULL` | +| `columnFamilies` | `object` | The column families configured for this table, mapped by column family ID. Views: `SCHEMA_VIEW`, `STATS_VIEW`, `FULL` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/tables_iam_audit_configs/index.md b/docs/google-docs/providers/google/bigtableadmin/tables_iam_audit_configs/index.md deleted file mode 100644 index 1e81beee48..0000000000 --- a/docs/google-docs/providers/google/bigtableadmin/tables_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: tables_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - tables_iam_audit_configs - - bigtableadmin - - 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 ---- - - - -## Overview - - - - -
Nametables_iam_audit_configs
TypeResource
Idgoogle.bigtableadmin.tables_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_tables_getIamPolicy` | `SELECT` | `instancesId, projectsId, tablesId` | diff --git a/docs/google-docs/providers/google/bigtableadmin/tables_iam_bindings/index.md b/docs/google-docs/providers/google/bigtableadmin/tables_iam_bindings/index.md deleted file mode 100644 index e1452ae493..0000000000 --- a/docs/google-docs/providers/google/bigtableadmin/tables_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: tables_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - tables_iam_bindings - - bigtableadmin - - 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 ---- - - - -## Overview - - - - -
Nametables_iam_bindings
TypeResource
Idgoogle.bigtableadmin.tables_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_tables_getIamPolicy` | `SELECT` | `instancesId, projectsId, tablesId` | diff --git a/docs/google-docs/providers/google/binaryauthorization/attestors/index.md b/docs/google-docs/providers/google/binaryauthorization/attestors/index.md index 3596c06716..e79459a1c6 100644 --- a/docs/google-docs/providers/google/binaryauthorization/attestors/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/attestors/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The resource name, in the format: `projects/*/attestors/*`. This field may not be updated. | | `description` | `string` | Optional. A descriptive comment. This field may be updated. The field may be displayed in chooser dialogs. | -| `etag` | `string` | Optional. A checksum, returned by the server, that can be sent on update requests to ensure the attestor has an up-to-date value before attempting to update it. See https://google.aip.dev/154. | | `updateTime` | `string` | Output only. Time when the attestor was last updated. | | `userOwnedGrafeasNote` | `object` | An user owned Grafeas note references a Grafeas Attestation.Authority Note created by the user. | +| `etag` | `string` | Optional. A checksum, returned by the server, that can be sent on update requests to ensure the attestor has an up-to-date value before attempting to update it. See https://google.aip.dev/154. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/binaryauthorization/attestors_iam_bindings/index.md b/docs/google-docs/providers/google/binaryauthorization/attestors_iam_bindings/index.md deleted file mode 100644 index 8bf7c50c06..0000000000 --- a/docs/google-docs/providers/google/binaryauthorization/attestors_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: attestors_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - attestors_iam_bindings - - binaryauthorization - - 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 ---- - - - -## Overview - - - - -
Nameattestors_iam_bindings
TypeResource
Idgoogle.binaryauthorization.attestors_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_attestors_getIamPolicy` | `SELECT` | `attestorsId, projectsId` | diff --git a/docs/google-docs/providers/google/binaryauthorization/attestors_iam_policies/index.md b/docs/google-docs/providers/google/binaryauthorization/attestors_iam_policies/index.md index 5e36c4653c..266ddaecfd 100644 --- a/docs/google-docs/providers/google/binaryauthorization/attestors_iam_policies/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/attestors_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/binaryauthorization/policies/index.md b/docs/google-docs/providers/google/binaryauthorization/policies/index.md index 2dfaf75c27..086e951b51 100644 --- a/docs/google-docs/providers/google/binaryauthorization/policies/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/policies/index.md @@ -29,8 +29,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the BinAuthz platform policy, in the form of `projects/*/platforms/*/policies/*`. | | `description` | `string` | Optional. A description comment about the policy. | -| `gkePolicy` | `object` | A Binary Authorization policy for a GKE cluster. This is one type of policy that can occur as a `PlatformPolicy`. | | `updateTime` | `string` | Output only. Time when the policy was last updated. | +| `gkePolicy` | `object` | A Binary Authorization policy for a GKE cluster. This is one type of policy that can occur as a `PlatformPolicy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/binaryauthorization/policy_iam_bindings/index.md b/docs/google-docs/providers/google/binaryauthorization/policy_iam_bindings/index.md deleted file mode 100644 index f70b271487..0000000000 --- a/docs/google-docs/providers/google/binaryauthorization/policy_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: policy_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - policy_iam_bindings - - binaryauthorization - - 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 ---- - - - -## Overview - - - - -
Namepolicy_iam_bindings
TypeResource
Idgoogle.binaryauthorization.policy_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_policy_getIamPolicy` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/binaryauthorization/policy_iam_policies/index.md b/docs/google-docs/providers/google/binaryauthorization/policy_iam_policies/index.md index 0fcefc39a5..3f384f691a 100644 --- a/docs/google-docs/providers/google/binaryauthorization/policy_iam_policies/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/policy_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/binaryauthorization/projects/index.md b/docs/google-docs/providers/google/binaryauthorization/projects/index.md deleted file mode 100644 index 86ae470539..0000000000 --- a/docs/google-docs/providers/google/binaryauthorization/projects/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: projects -hide_title: false -hide_table_of_contents: false -keywords: - - projects - - binaryauthorization - - 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 ---- - - - -## Overview - - - - -
Nameprojects
TypeResource
Idgoogle.binaryauthorization.projects
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updatePolicy` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/binaryauthorization/projects_policy/index.md b/docs/google-docs/providers/google/binaryauthorization/projects_policy/index.md deleted file mode 100644 index e27d9c137b..0000000000 --- a/docs/google-docs/providers/google/binaryauthorization/projects_policy/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: projects_policy -hide_title: false -hide_table_of_contents: false -keywords: - - projects_policy - - binaryauthorization - - 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 ---- - - - -## Overview - - - - -
Nameprojects_policy
TypeResource
Idgoogle.binaryauthorization.projects_policy
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name, in the format `projects/*/policy`. There is at most one policy per project. | -| `description` | `string` | Optional. A descriptive comment. | -| `etag` | `string` | Optional. A checksum, returned by the server, that can be sent on update requests to ensure the policy has an up-to-date value before attempting to update it. See https://google.aip.dev/154. | -| `updateTime` | `string` | Output only. Time when the policy was last updated. | -| `istioServiceIdentityAdmissionRules` | `object` | Optional. Per-istio-service-identity admission rules. Istio service identity spec format: `spiffe:///ns//sa/` or `/ns//sa/` e.g. `spiffe://example.com/ns/test-ns/sa/default` | -| `defaultAdmissionRule` | `object` | An admission rule specifies either that all container images used in a pod creation request must be attested to by one or more attestors, that all pod creations will be allowed, or that all pod creations will be denied. Images matching an admission allowlist pattern are exempted from admission rules and will never block a pod creation. | -| `kubernetesServiceAccountAdmissionRules` | `object` | Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. `test-ns:default` | -| `globalPolicyEvaluationMode` | `string` | Optional. Controls the evaluation of a Google-maintained global admission policy for common system-level images. Images not covered by the global policy will be subject to the project admission policy. This setting has no effect when specified inside a global admission policy. | -| `admissionWhitelistPatterns` | `array` | Optional. Admission policy allowlisting. A matching admission request will always be permitted. This feature is typically used to exclude Google or third-party infrastructure images from Binary Authorization policies. | -| `kubernetesNamespaceAdmissionRules` | `object` | Optional. Per-kubernetes-namespace admission rules. K8s namespace spec format: `[a-z.-]+`, e.g. `some-namespace` | -| `clusterAdmissionRules` | `object` | Optional. Per-cluster admission rules. Cluster spec format: `location.clusterId`. There can be at most one admission rule per cluster spec. A `location` is either a compute zone (e.g. us-central1-a) or a region (e.g. us-central1). For `clusterId` syntax restrictions see https://cloud.google.com/container-engine/reference/rest/v1/projects.zones.clusters. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getPolicy` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md b/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md index a93675263f..873e507bd2 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/blockchain_nodes/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`. | +| `blockchainType` | `string` | Immutable. The blockchain type of the node. | +| `connectionInfo` | `object` | The connection information through which to interact with a blockchain node. | | `createTime` | `string` | Output only. The timestamp at which the blockchain node was first created. | | `ethereumDetails` | `object` | Ethereum-specific blockchain node details. | | `labels` | `object` | User-provided key-value pairs. | | `state` | `string` | Output only. A status representing the state of the node. | | `updateTime` | `string` | Output only. The timestamp at which the blockchain node was last updated. | -| `blockchainType` | `string` | Immutable. The blockchain type of the node. | -| `connectionInfo` | `object` | The connection information through which to interact with a blockchain node. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md b/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md index 395f18c1c0..9fa2a11d39 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | -| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md b/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md index f3e9b8c2d3..75000de598 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md b/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md index e18f7817ac..c06988edbd 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md @@ -30,12 +30,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | A user-defined name of the certificate issuance config. CertificateIssuanceConfig names must be unique globally and match pattern `projects/*/locations/*/certificateIssuanceConfigs/*`. | | `description` | `string` | One or more paragraphs of text description of a CertificateIssuanceConfig. | | `createTime` | `string` | Output only. The creation timestamp of a CertificateIssuanceConfig. | -| `rotationWindowPercentage` | `integer` | Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive. | | `keyAlgorithm` | `string` | Required. The key algorithm to use when generating the private key. | -| `labels` | `object` | Set of labels associated with a CertificateIssuanceConfig. | +| `rotationWindowPercentage` | `integer` | Required. Specifies the percentage of elapsed time of the certificate lifetime to wait before renewing the certificate. Must be a number between 1-99, inclusive. | | `lifetime` | `string` | Required. Workload certificate lifetime requested. | | `updateTime` | `string` | Output only. The last update timestamp of a CertificateIssuanceConfig. | | `certificateAuthorityConfig` | `object` | The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. | +| `labels` | `object` | Set of labels associated with a CertificateIssuanceConfig. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md b/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md index 3b97788d6b..6263cf0707 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificate_map_entries/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | A user-defined name of the Certificate Map Entry. Certificate Map Entry names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*/certificateMapEntries/*`. | | `description` | `string` | One or more paragraphs of text description of a certificate map entry. | -| `certificates` | `array` | A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`. | -| `labels` | `object` | Set of labels associated with a Certificate Map Entry. | -| `matcher` | `string` | A predefined matcher for particular cases, other than SNI selection. | | `state` | `string` | Output only. A serving state of this Certificate Map Entry. | | `updateTime` | `string` | Output only. The update timestamp of a Certificate Map Entry. | -| `hostname` | `string` | A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate. | +| `matcher` | `string` | A predefined matcher for particular cases, other than SNI selection. | | `createTime` | `string` | Output only. The creation timestamp of a Certificate Map Entry. | +| `hostname` | `string` | A Hostname (FQDN, e.g. `example.com`) or a wildcard hostname expression (`*.example.com`) for a set of hostnames with common suffix. Used as Server Name Indication (SNI) for selecting a proper certificate. | +| `labels` | `object` | Set of labels associated with a Certificate Map Entry. | +| `certificates` | `array` | A set of Certificates defines for the given `hostname`. There can be defined up to four certificates in each Certificate Map Entry. Each certificate must match pattern `projects/*/locations/*/certificates/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md b/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md index 49f9d586bf..7cef21733b 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificate_maps/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | A user-defined name of the Certificate Map. Certificate Map names must be unique globally and match pattern `projects/*/locations/*/certificateMaps/*`. | | `description` | `string` | One or more paragraphs of text description of a certificate map. | +| `updateTime` | `string` | Output only. The update timestamp of a Certificate Map. | | `createTime` | `string` | Output only. The creation timestamp of a Certificate Map. | | `gclbTargets` | `array` | Output only. A list of GCLB targets that use this Certificate Map. A Target Proxy is only present on this list if it's attached to a Forwarding Rule. | | `labels` | `object` | Set of labels associated with a Certificate Map. | -| `updateTime` | `string` | Output only. The update timestamp of a Certificate Map. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/certificates/index.md b/docs/google-docs/providers/google/certificatemanager/certificates/index.md index 5d415ed4f6..6535de0612 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificates/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificates/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | A user-defined name of the certificate. Certificate names must be unique globally and match pattern `projects/*/locations/*/certificates/*`. | | `description` | `string` | One or more paragraphs of text description of a certificate. | | `managed` | `object` | Configuration and state of a Managed Certificate. Certificate Manager provisions and renews Managed Certificates automatically, for as long as it's authorized to do so. | -| `expireTime` | `string` | Output only. The expiry timestamp of a Certificate. | +| `sanDnsnames` | `array` | Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field. | +| `labels` | `object` | Set of labels associated with a Certificate. | | `createTime` | `string` | Output only. The creation timestamp of a Certificate. | | `scope` | `string` | Immutable. The scope of the certificate. | -| `labels` | `object` | Set of labels associated with a Certificate. | | `pemCertificate` | `string` | Output only. The PEM-encoded certificate chain. | | `selfManaged` | `object` | Certificate data for a SelfManaged Certificate. SelfManaged Certificates are uploaded by the user. Updating such certificates before they expire remains the user's responsibility. | -| `sanDnsnames` | `array` | Output only. The list of Subject Alternative Names of dnsName type defined in the certificate (see RFC 5280 4.2.1.6). Managed certificates that haven't been provisioned yet have this field populated with a value of the managed.domains field. | | `updateTime` | `string` | Output only. The last update timestamp of a Certificate. | +| `expireTime` | `string` | Output only. The expiry timestamp of a Certificate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md b/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md index 5c8ea826f5..c6da98091a 100644 --- a/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md +++ b/docs/google-docs/providers/google/certificatemanager/dns_authorizations/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. | | `description` | `string` | One or more paragraphs of text description of a DnsAuthorization. | -| `dnsResourceRecord` | `object` | The structure describing the DNS Resource Record that needs to be added to DNS configuration for the authorization to be usable by certificate. | | `domain` | `string` | Required. Immutable. A domain that is being authorized. A DnsAuthorization resource covers a single domain and its wildcard, e.g. authorization for `example.com` can be used to issue certificates for `example.com` and `*.example.com`. | | `labels` | `object` | Set of labels associated with a DnsAuthorization. | | `updateTime` | `string` | Output only. The last update timestamp of a DnsAuthorization. | | `createTime` | `string` | Output only. The creation timestamp of a DnsAuthorization. | +| `dnsResourceRecord` | `object` | The structure describing the DNS Resource Record that needs to be added to DNS configuration for the authorization to be usable by certificate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/operations/index.md b/docs/google-docs/providers/google/certificatemanager/operations/index.md index 0fc7f399c7..62fb36a02d 100644 --- a/docs/google-docs/providers/google/certificatemanager/operations/index.md +++ b/docs/google-docs/providers/google/certificatemanager/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | -| `metadata` | `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. | | `response` | `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`. | | `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md b/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md index 3b566ff673..0be5bd08e6 100644 --- a/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md +++ b/docs/google-docs/providers/google/certificatemanager/trust_configs/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | A user-defined name of the trust config. TrustConfig names must be unique globally and match pattern `projects/*/locations/*/trustConfigs/*`. | | `description` | `string` | One or more paragraphs of text description of a TrustConfig. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `labels` | `object` | Set of labels associated with a TrustConfig. | | `trustStores` | `array` | Set of trust stores to perform validation against. This field is supported when TrustConfig is configured with Load Balancers, currently not supported for SPIFFE certificate validation. Only one TrustStore specified is currently allowed. | | `updateTime` | `string` | Output only. The last update timestamp of a TrustConfig. | | `createTime` | `string` | Output only. The creation timestamp of a TrustConfig. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `labels` | `object` | Set of labels associated with a TrustConfig. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudasset/assets/index.md b/docs/google-docs/providers/google/cloudasset/assets/index.md index d4def6d48d..da222a251a 100644 --- a/docs/google-docs/providers/google/cloudasset/assets/index.md +++ b/docs/google-docs/providers/google/cloudasset/assets/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The full name of the asset. Example: `//compute.googleapis.com/projects/my_project_123/zones/zone1/instances/instance1` See [Resource names](https://cloud.google.com/apis/design/resource_names#full_resource_name) for more information. | -| `iamPolicy` | `object` | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | -| `relatedAssets` | `object` | DEPRECATED. This message only presents for the purpose of backward-compatibility. The server will never populate this message in responses. The detailed related assets with the `relationship_type`. | -| `assetType` | `string` | The type of the asset. Example: `compute.googleapis.com/Disk` See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information. | +| `servicePerimeter` | `object` | `ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges. | +| `resource` | `object` | A representation of a Google Cloud resource. | | `accessLevel` | `object` | An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied. | | `accessPolicy` | `object` | `AccessPolicy` is a container for `AccessLevels` (which define the necessary attributes to use Google Cloud services) and `ServicePerimeters` (which define regions of services able to freely pass data within a perimeter). An access policy is globally visible within an organization, and the restrictions it specifies apply to all projects within an organization. | +| `relatedAssets` | `object` | DEPRECATED. This message only presents for the purpose of backward-compatibility. The server will never populate this message in responses. The detailed related assets with the `relationship_type`. | +| `assetType` | `string` | The type of the asset. Example: `compute.googleapis.com/Disk` See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information. | | `orgPolicy` | `array` | A representation of an [organization policy](https://cloud.google.com/resource-manager/docs/organization-policy/overview#organization_policy). There can be more than one organization policy with different constraints set on a given resource. | -| `relatedAsset` | `object` | An asset identifier in Google Cloud which contains its name, type and ancestors. An asset can be any resource in the Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy). See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information. | -| `ancestors` | `array` | The ancestry path of an asset in Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the asset is a project, folder, or organization, the ancestry path starts from the asset itself. Example: `["projects/123456789", "folders/5432", "organizations/1234"]` | +| `iamPolicy` | `object` | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | | `osInventory` | `object` | This API resource represents the available inventory data for a Compute Engine virtual machine (VM) instance at a given point in time. You can use this API resource to determine the inventory data of your VM. For more information, see [Information provided by OS inventory management](https://cloud.google.com/compute/docs/instances/os-inventory-management#data-collected). | -| `resource` | `object` | A representation of a Google Cloud resource. | -| `servicePerimeter` | `object` | `ServicePerimeter` describes a set of Google Cloud resources which can freely import and export data amongst themselves, but not export outside of the `ServicePerimeter`. If a request with a source within this `ServicePerimeter` has a target outside of the `ServicePerimeter`, the request will be blocked. Otherwise the request is allowed. There are two types of Service Perimeter - Regular and Bridge. Regular Service Perimeters cannot overlap, a single Google Cloud project or VPC network can only belong to a single regular Service Perimeter. Service Perimeter Bridges can contain only Google Cloud projects as members, a single Google Cloud project may belong to multiple Service Perimeter Bridges. | | `updateTime` | `string` | The last update timestamp of an asset. update_time is updated when create/update/delete operation is performed. | +| `ancestors` | `array` | The ancestry path of an asset in Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), represented as a list of relative resource names. An ancestry path starts with the closest ancestor in the hierarchy and ends at root. If the asset is a project, folder, or organization, the ancestry path starts from the asset itself. Example: `["projects/123456789", "folders/5432", "organizations/1234"]` | +| `relatedAsset` | `object` | An asset identifier in Google Cloud which contains its name, type and ancestors. An asset can be any resource in the Google Cloud [resource hierarchy](https://cloud.google.com/resource-manager/docs/cloud-platform-resource-hierarchy), a resource outside the Google Cloud resource hierarchy (such as Google Kubernetes Engine clusters and objects), or a policy (e.g. IAM policy). See [Supported asset types](https://cloud.google.com/asset-inventory/docs/supported-asset-types) for more information. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudasset/assets_history/index.md b/docs/google-docs/providers/google/cloudasset/assets_history/index.md deleted file mode 100644 index 406eab3ca8..0000000000 --- a/docs/google-docs/providers/google/cloudasset/assets_history/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: assets_history -hide_title: false -hide_table_of_contents: false -keywords: - - assets_history - - cloudasset - - 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 ---- - - - -## Overview - - - - -
Nameassets_history
TypeResource
Idgoogle.cloudasset.assets_history
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `batchGetAssetsHistory` | `SELECT` | `parent` | diff --git a/docs/google-docs/providers/google/cloudasset/iam_policies/index.md b/docs/google-docs/providers/google/cloudasset/iam_policies/index.md deleted file mode 100644 index fb7a0018f8..0000000000 --- a/docs/google-docs/providers/google/cloudasset/iam_policies/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - iam_policies - - cloudasset - - 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 ---- - - - -## Overview - - - - -
Nameiam_policies
TypeResource
Idgoogle.cloudasset.iam_policies
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `analyzeIamPolicyLongrunning` | `EXEC` | `scope` | diff --git a/docs/google-docs/providers/google/cloudasset/operations/index.md b/docs/google-docs/providers/google/cloudasset/operations/index.md deleted file mode 100644 index f00ca76ed4..0000000000 --- a/docs/google-docs/providers/google/cloudasset/operations/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: operations -hide_title: false -hide_table_of_contents: false -keywords: - - operations - - cloudasset - - 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 ---- - - - -## Overview - - - - -
Nameoperations
TypeResource
Idgoogle.cloudasset.operations
- -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `get` | `SELECT` | `name` | diff --git a/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md b/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md index 86dedcd45d..a51285f865 100644 --- a/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md +++ b/docs/google-docs/providers/google/cloudbilling/billing_accounts/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the billing account. The resource name has the form `billingAccounts/{billing_account_id}`. For example, `billingAccounts/012345-567890-ABCDEF` would be the resource name for billing account `012345-567890-ABCDEF`. | +| `open` | `boolean` | Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. | | `displayName` | `string` | The display name given to the billing account, such as `My Billing Account`. This name is displayed in the Google Cloud Console. | | `masterBillingAccount` | `string` | If this account is a [subaccount](https://cloud.google.com/billing/docs/concepts), then this will be the resource name of the parent billing account that it is being resold through. Otherwise this will be empty. | -| `open` | `boolean` | Output only. True if the billing account is open, and will therefore be charged for any usage on associated projects. False if the billing account is closed, and therefore projects associated with it will be unable to use paid services. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_audit_configs/index.md deleted file mode 100644 index c5c95ef262..0000000000 --- a/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: billing_accounts_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - billing_accounts_iam_audit_configs - - cloudbilling - - 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 ---- - - - -## Overview - - - - -
Namebilling_accounts_iam_audit_configs
TypeResource
Idgoogle.cloudbilling.billing_accounts_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `billingAccounts_getIamPolicy` | `SELECT` | `billingAccountsId` | diff --git a/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_bindings/index.md b/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_bindings/index.md deleted file mode 100644 index cd2738a2cd..0000000000 --- a/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: billing_accounts_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - billing_accounts_iam_bindings - - cloudbilling - - 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 ---- - - - -## Overview - - - - -
Namebilling_accounts_iam_bindings
TypeResource
Idgoogle.cloudbilling.billing_accounts_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `billingAccounts_getIamPolicy` | `SELECT` | `billingAccountsId` | diff --git a/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_policies/index.md b/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_policies/index.md index e825202dd8..8b8eacfb78 100644 --- a/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudbilling/billing_accounts_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbilling/billing_info/index.md b/docs/google-docs/providers/google/cloudbilling/billing_info/index.md index 11f772429f..4fd3254960 100644 --- a/docs/google-docs/providers/google/cloudbilling/billing_info/index.md +++ b/docs/google-docs/providers/google/cloudbilling/billing_info/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. | +| `projectId` | `string` | Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. | | `billingAccountName` | `string` | The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`. | | `billingEnabled` | `boolean` | Output only. True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. | -| `projectId` | `string` | Output only. The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbilling/projects_billing_info/index.md b/docs/google-docs/providers/google/cloudbilling/projects_billing_info/index.md deleted file mode 100644 index b5390a0d16..0000000000 --- a/docs/google-docs/providers/google/cloudbilling/projects_billing_info/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: projects_billing_info -hide_title: false -hide_table_of_contents: false -keywords: - - projects_billing_info - - cloudbilling - - 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 ---- - - - -## Overview - - - - -
Nameprojects_billing_info
TypeResource
Idgoogle.cloudbilling.projects_billing_info
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name for the `ProjectBillingInfo`; has the form `projects/{project_id}/billingInfo`. For example, the resource name for the billing information for project `tokyo-rain-123` would be `projects/tokyo-rain-123/billingInfo`. This field is read-only. | -| `billingAccountName` | `string` | The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`. | -| `billingEnabled` | `boolean` | True if the project is associated with an open billing account, to which usage on the project is charged. False if the project is associated with a closed billing account, or no billing account at all, and therefore cannot use paid services. This field is read-only. | -| `projectId` | `string` | The ID of the project that this `ProjectBillingInfo` represents, such as `tokyo-rain-123`. This is a convenience field so that you don't need to parse the `name` field to obtain a project ID. This field is read-only. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getBillingInfo` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/cloudbilling/services/index.md b/docs/google-docs/providers/google/cloudbilling/services/index.md index a3c370b8fc..c6a630fb00 100644 --- a/docs/google-docs/providers/google/cloudbilling/services/index.md +++ b/docs/google-docs/providers/google/cloudbilling/services/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the service. Example: "services/DA34-426B-A397" | -| `serviceId` | `string` | The identifier for the service. Example: "DA34-426B-A397" | | `businessEntityName` | `string` | The business under which the service is offered. Ex. "businessEntities/GCP", "businessEntities/Maps" | | `displayName` | `string` | A human readable display name for this service. | +| `serviceId` | `string` | The identifier for the service. Example: "DA34-426B-A397" | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudbilling/skus/index.md b/docs/google-docs/providers/google/cloudbilling/skus/index.md index 45ac8beb62..480a2a35bc 100644 --- a/docs/google-docs/providers/google/cloudbilling/skus/index.md +++ b/docs/google-docs/providers/google/cloudbilling/skus/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name for the SKU. Example: "services/DA34-426B-A397/skus/AA95-CD31-42FE" | | `description` | `string` | A human readable description of the SKU, has a maximum length of 256 characters. | -| `serviceProviderName` | `string` | Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform. | -| `serviceRegions` | `array` | List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/ | -| `skuId` | `string` | The identifier for the SKU. Example: "AA95-CD31-42FE" | | `category` | `object` | Represents the category hierarchy of a SKU. | | `geoTaxonomy` | `object` | Encapsulates the geographic taxonomy data for a sku. | | `pricingInfo` | `array` | A timeline of pricing info for this SKU in chronological order. | +| `serviceProviderName` | `string` | Identifies the service provider. This is 'Google' for first party services in Google Cloud Platform. | +| `serviceRegions` | `array` | List of service regions this SKU is offered at. Example: "asia-east1" Service regions can be found at https://cloud.google.com/about/locations/ | +| `skuId` | `string` | The identifier for the SKU. Example: "AA95-CD31-42FE" | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md b/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md index 56c77f7a9d..032f9c4f60 100644 --- a/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md +++ b/docs/google-docs/providers/google/cloudbuild/bitbucket_server_configs/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the config. | -| `createTime` | `string` | Time when the config was created. | -| `secrets` | `object` | BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. | -| `apiKey` | `string` | Required. Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. | +| `sslCa` | `string` | Optional. SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. | | `connectedRepositories` | `array` | Output only. Connected Bitbucket Server repositories for this config. | -| `peeredNetwork` | `string` | Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. | +| `createTime` | `string` | Time when the config was created. | | `username` | `string` | Username of the account Cloud Build will use on Bitbucket Server. | | `webhookKey` | `string` | Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config. | +| `peeredNetwork` | `string` | Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project. | +| `apiKey` | `string` | Required. Immutable. API Key that will be attached to webhook. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. | | `hostUri` | `string` | Required. Immutable. The URI of the Bitbucket Server host. Once this field has been set, it cannot be changed. If you need to change it, please create another BitbucketServerConfig. | -| `sslCa` | `string` | Optional. SSL certificate to use for requests to Bitbucket Server. The format should be PEM format but the extension can be one of .pem, .cer, or .crt. | +| `secrets` | `object` | BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbuild/builds/index.md b/docs/google-docs/providers/google/cloudbuild/builds/index.md index 9e504e5ef0..adf6afe5ec 100644 --- a/docs/google-docs/providers/google/cloudbuild/builds/index.md +++ b/docs/google-docs/providers/google/cloudbuild/builds/index.md @@ -30,32 +30,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Output only. Unique identifier of the build. | | `name` | `string` | Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service. | | `options` | `object` | Optional arguments to enable specific features of builds. | -| `warnings` | `array` | Output only. Non-fatal problems encountered during the execution of the build. | -| `buildTriggerId` | `string` | Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. | -| `projectId` | `string` | Output only. ID of the project. | -| `approval` | `object` | BuildApproval describes a build's approval configuration, state, and result. | -| `startTime` | `string` | Output only. Time at which execution of the build was started. | -| `timeout` | `string` | Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes. | | `images` | `array` | A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account's credentials. The digests of the pushed images will be stored in the `Build` resource's results field. If any of the images fail to be pushed, the build status is marked `FAILURE`. | +| `warnings` | `array` | Output only. Non-fatal problems encountered during the execution of the build. | +| `availableSecrets` | `object` | Secrets and secret environment variables. | +| `logUrl` | `string` | Output only. URL to logs for this build in Google Cloud Console. | +| `results` | `object` | Artifacts created by the build pipeline. | | `logsBucket` | `string` | Cloud Storage bucket where logs should be written (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)). Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`. | | `statusDetail` | `string` | Output only. Customer-readable message about the current status. | -| `sourceProvenance` | `object` | Provenance of the source. Ways to find the original source, or verify that some source was used for this build. | -| `source` | `object` | Location of the source in a supported storage service. | -| `logUrl` | `string` | Output only. URL to logs for this build in Google Cloud Console. | | `substitutions` | `object` | Substitutions data for `Build` resource. | -| `timing` | `object` | Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included. | -| `secrets` | `array` | Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets | +| `buildTriggerId` | `string` | Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically. | | `createTime` | `string` | Output only. Time at which the request to create the build was received. | -| `failureInfo` | `object` | A fatal problem encountered during the execution of the build. | -| `availableSecrets` | `object` | Secrets and secret environment variables. | -| `results` | `object` | Artifacts created by the build pipeline. | -| `status` | `string` | Output only. Status of the build. | -| `serviceAccount` | `string` | IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. | -| `finishTime` | `string` | Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. | | `queueTtl` | `string` | TTL in queue for this build. If provided and the build is enqueued longer than this value, the build will expire and the build status will be `EXPIRED`. The TTL starts ticking from create_time. | +| `startTime` | `string` | Output only. Time at which execution of the build was started. | +| `approval` | `object` | BuildApproval describes a build's approval configuration, state, and result. | | `artifacts` | `object` | Artifacts produced by a build that should be uploaded upon successful completion of all build steps. | -| `steps` | `array` | Required. The operations to be performed on the workspace. | +| `source` | `object` | Location of the source in a supported storage service. | +| `secrets` | `array` | Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is the recommended technique for managing sensitive data with Cloud Build. Use `available_secrets` to configure builds to access secrets from Secret Manager. For instructions, see: https://cloud.google.com/cloud-build/docs/securing-builds/use-secrets | +| `failureInfo` | `object` | A fatal problem encountered during the execution of the build. | +| `finishTime` | `string` | Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. | +| `sourceProvenance` | `object` | Provenance of the source. Ways to find the original source, or verify that some source was used for this build. | +| `timeout` | `string` | Amount of time that this build should be allowed to run, to second granularity. If this amount of time elapses, work on the build will cease and the build status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default time is 60 minutes. | | `tags` | `array` | Tags for annotation of a `Build`. These are not docker tags. | +| `serviceAccount` | `string` | IAM service account whose credentials will be used at build runtime. Must be of the format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`. ACCOUNT can be email address or uniqueId of the service account. | +| `steps` | `array` | Required. The operations to be performed on the workspace. | +| `timing` | `object` | Output only. Stores timing information for phases of the build. Valid keys are: * BUILD: time to execute all build steps. * PUSH: time to push all artifacts including docker images and non docker artifacts. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up build. If the build does not specify source or images, these keys will not be included. | +| `status` | `string` | Output only. Status of the build. | +| `projectId` | `string` | Output only. ID of the project. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbuild/git_lab_configs/index.md b/docs/google-docs/providers/google/cloudbuild/git_lab_configs/index.md deleted file mode 100644 index a36e4f4763..0000000000 --- a/docs/google-docs/providers/google/cloudbuild/git_lab_configs/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: git_lab_configs -hide_title: false -hide_table_of_contents: false -keywords: - - git_lab_configs - - cloudbuild - - 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 ---- - - - -## Overview - - - - -
Namegit_lab_configs
TypeResource
Idgoogle.cloudbuild.git_lab_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name for the config. | -| `username` | `string` | Username of the GitLab.com or GitLab Enterprise account Cloud Build will use. | -| `webhookKey` | `string` | Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config. | -| `connectedRepositories` | `array` | Connected GitLab.com or GitLabEnterprise repositories for this config. | -| `createTime` | `string` | Output only. Time when the config was created. | -| `enterpriseConfig` | `object` | GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. | -| `secrets` | `object` | GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_gitLabConfigs_get` | `SELECT` | `gitLabConfigsId, locationsId, projectsId` | Retrieves a `GitLabConfig`. This API is experimental | -| `projects_locations_gitLabConfigs_list` | `SELECT` | `locationsId, projectsId` | List all `GitLabConfigs` for a given project. This API is experimental | -| `projects_locations_gitLabConfigs_create` | `INSERT` | `locationsId, projectsId` | Creates a new `GitLabConfig`. This API is experimental | -| `projects_locations_gitLabConfigs_delete` | `DELETE` | `gitLabConfigsId, locationsId, projectsId` | Delete a `GitLabConfig`. This API is experimental | -| `projects_locations_gitLabConfigs_patch` | `EXEC` | `gitLabConfigsId, locationsId, projectsId` | Updates an existing `GitLabConfig`. This API is experimental | diff --git a/docs/google-docs/providers/google/cloudbuild/git_lab_configs_git_lab_connected_repository/index.md b/docs/google-docs/providers/google/cloudbuild/git_lab_configs_git_lab_connected_repository/index.md deleted file mode 100644 index dd92619976..0000000000 --- a/docs/google-docs/providers/google/cloudbuild/git_lab_configs_git_lab_connected_repository/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: git_lab_configs_git_lab_connected_repository -hide_title: false -hide_table_of_contents: false -keywords: - - git_lab_configs_git_lab_connected_repository - - cloudbuild - - 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 ---- - - - -## Overview - - - - -
Namegit_lab_configs_git_lab_connected_repository
TypeResource
Idgoogle.cloudbuild.git_lab_configs_git_lab_connected_repository
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_gitLabConfigs_removeGitLabConnectedRepository` | `DELETE` | `gitLabConfigsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudbuild/github_dot_com_webhook/index.md b/docs/google-docs/providers/google/cloudbuild/github_dot_com_webhook/index.md deleted file mode 100644 index 3032feb399..0000000000 --- a/docs/google-docs/providers/google/cloudbuild/github_dot_com_webhook/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: github_dot_com_webhook -hide_title: false -hide_table_of_contents: false -keywords: - - github_dot_com_webhook - - cloudbuild - - 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 ---- - - - -## Overview - - - - -
Namegithub_dot_com_webhook
TypeResource
Idgoogle.cloudbuild.github_dot_com_webhook
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `githubDotComWebhook_receive` | `EXEC` | | diff --git a/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md b/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md index aa1429e816..b61ef93dc5 100644 --- a/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md +++ b/docs/google-docs/providers/google/cloudbuild/gitlab_configs/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the config. | -| `secrets` | `object` | GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. | -| `username` | `string` | Username of the GitLab.com or GitLab Enterprise account Cloud Build will use. | | `webhookKey` | `string` | Output only. UUID included in webhook requests. The UUID is used to look up the corresponding config. | | `connectedRepositories` | `array` | Connected GitLab.com or GitLabEnterprise repositories for this config. | | `createTime` | `string` | Output only. Time when the config was created. | | `enterpriseConfig` | `object` | GitLabEnterpriseConfig represents the configuration for a GitLabEnterprise integration. | +| `secrets` | `object` | GitLabSecrets represents the secrets in Secret Manager for a GitLab integration. | +| `username` | `string` | Username of the GitLab.com or GitLab Enterprise account Cloud Build will use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbuild/repos/index.md b/docs/google-docs/providers/google/cloudbuild/repos/index.md deleted file mode 100644 index 68f29bf490..0000000000 --- a/docs/google-docs/providers/google/cloudbuild/repos/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: repos -hide_title: false -hide_table_of_contents: false -keywords: - - repos - - cloudbuild - - 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 ---- - - - -## Overview - - - - -
Namerepos
TypeResource
Idgoogle.cloudbuild.repos
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bitbucketServerRepositories` | `array` | List of Bitbucket Server repositories. | -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_bitbucket_server_configs_repos_list` | `SELECT` | `bitbucketServerConfigsId, locationsId, projectsId` | List all repositories for a given `BitbucketServerConfig`. This API is experimental. | -| `projects_locations_gitlab_configs_repos_list` | `SELECT` | `gitLabConfigsId, locationsId, projectsId` | List all repositories for a given `GitLabConfig`. This API is experimental | diff --git a/docs/google-docs/providers/google/cloudbuild/triggers/index.md b/docs/google-docs/providers/google/cloudbuild/triggers/index.md index eabc2505b7..82570b0b91 100644 --- a/docs/google-docs/providers/google/cloudbuild/triggers/index.md +++ b/docs/google-docs/providers/google/cloudbuild/triggers/index.md @@ -30,30 +30,30 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Output only. Unique identifier of the trigger. | | `name` | `string` | User-assigned name of the trigger. Must be unique within the project. Trigger names must meet the following requirements: + They must contain only alphanumeric characters and dashes. + They can be 1-64 characters long. + They must begin and end with an alphanumeric character. | | `description` | `string` | Human-readable description of this trigger. | -| `bitbucketServerTriggerConfig` | `object` | BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. | -| `createTime` | `string` | Output only. Time when the trigger was created. | +| `gitlabEnterpriseEventsConfig` | `object` | GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. | +| `build` | `object` | A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. | +| `serviceAccount` | `string` | The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` | | `includedFiles` | `array` | If any of the files altered in the commit pass the ignored_files filter and included_files is empty, then as far as this filter is concerned, we should trigger the build. If any of the files altered in the commit pass the ignored_files filter and included_files is not empty, then we make sure that at least one of those files matches a included_files glob. If not, then we do not trigger a build. | -| `filter` | `string` | A Common Expression Language string. | -| `approvalConfig` | `object` | ApprovalConfig describes configuration for manual approval of a build. | +| `ignoredFiles` | `array` | ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. | +| `includeBuildLogs` | `string` | If set to INCLUDE_BUILD_LOGS_WITH_STATUS, log url will be shown on GitHub page when build status is final. Setting this field to INCLUDE_BUILD_LOGS_WITH_STATUS for non GitHub triggers results in INVALID_ARGUMENT error. | +| `substitutions` | `object` | Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. | +| `createTime` | `string` | Output only. Time when the trigger was created. | | `gitFileSource` | `object` | GitFileSource describes a file within a (possibly remote) code repository. | -| `disabled` | `boolean` | If true, the trigger will never automatically execute a build. | -| `pubsubConfig` | `object` | PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. | +| `eventType` | `string` | EventType allows the user to explicitly set the type of event to which this BuildTrigger should respond. This field will be validated against the rest of the configuration if it is set. | | `github` | `object` | GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. | +| `webhookConfig` | `object` | WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. | | `repositoryEventConfig` | `object` | The configuration of a trigger that creates a build whenever an event from Repo API is received. | | `tags` | `array` | Tags for annotation of a `BuildTrigger` | -| `webhookConfig` | `object` | WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. | +| `bitbucketServerTriggerConfig` | `object` | BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. | | `triggerTemplate` | `object` | Location of the source in a Google Cloud Source Repository. | -| `build` | `object` | A build resource in the Cloud Build API. At a high level, a `Build` describes where to find source code, how to build it (for example, the builder image to run on the source), and where to store the built artifacts. Fields can include the following variables, which will be expanded when the build is created: - $PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the autogenerated ID of the build. - $REPO_NAME: the source repository name specified by RepoSource. - $BRANCH_NAME: the branch name specified by RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA. | -| `eventType` | `string` | EventType allows the user to explicitly set the type of event to which this BuildTrigger should respond. This field will be validated against the rest of the configuration if it is set. | -| `serviceAccount` | `string` | The service account used for all user-controlled operations including UpdateBuildTrigger, RunBuildTrigger, CreateBuild, and CancelBuild. If no service account is set, then the standard Cloud Build service account ([PROJECT_NUM]@system.gserviceaccount.com) will be used instead. Format: `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT_ID_OR_EMAIL}` | | `resourceName` | `string` | The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. | -| `sourceToBuild` | `object` | GitRepoSource describes a repo and ref of a code repository. | -| `substitutions` | `object` | Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. | -| `gitlabEnterpriseEventsConfig` | `object` | GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. | -| `autodetect` | `boolean` | Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers. | +| `disabled` | `boolean` | If true, the trigger will never automatically execute a build. | | `filename` | `string` | Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). | -| `ignoredFiles` | `array` | ignored_files and included_files are file glob matches using https://golang.org/pkg/path/filepath/#Match extended with support for "**". If ignored_files and changed files are both empty, then they are not used to determine whether or not to trigger a build. If ignored_files is not empty, then we ignore any files that match any of the ignored_file globs. If the change has no files that are outside of the ignored_files globs, then we do not trigger a build. | -| `includeBuildLogs` | `string` | If set to INCLUDE_BUILD_LOGS_WITH_STATUS, log url will be shown on GitHub page when build status is final. Setting this field to INCLUDE_BUILD_LOGS_WITH_STATUS for non GitHub triggers results in INVALID_ARGUMENT error. | +| `filter` | `string` | A Common Expression Language string. | +| `approvalConfig` | `object` | ApprovalConfig describes configuration for manual approval of a build. | +| `autodetect` | `boolean` | Autodetect build configuration. The following precedence is used (case insensitive): 1. cloudbuild.yaml 2. cloudbuild.yml 3. cloudbuild.json 4. Dockerfile Currently only available for GitHub App Triggers. | +| `sourceToBuild` | `object` | GitRepoSource describes a repo and ref of a code repository. | +| `pubsubConfig` | `object` | PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md b/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md index f86d1dd6e8..271267fa73 100644 --- a/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md +++ b/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the `WorkerPool`, with format `projects/{project}/locations/{location}/workerPools/{worker_pool}`. The value of `{worker_pool}` is provided by `worker_pool_id` in `CreateWorkerPool` request and the value of `{location}` is determined by the endpoint accessed. | +| `deleteTime` | `string` | Output only. Time at which the request to delete the `WorkerPool` was received. | | `state` | `string` | Output only. `WorkerPool` state. | -| `uid` | `string` | Output only. A unique identifier for the `WorkerPool`. | -| `displayName` | `string` | A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters. | | `createTime` | `string` | Output only. Time at which the request to create the `WorkerPool` was received. | +| `uid` | `string` | Output only. A unique identifier for the `WorkerPool`. | +| `etag` | `string` | Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. | +| `privatePoolV1Config` | `object` | Configuration for a V1 `PrivatePool`. | | `annotations` | `object` | User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | -| `deleteTime` | `string` | Output only. Time at which the request to delete the `WorkerPool` was received. | | `updateTime` | `string` | Output only. Time at which the request to update the `WorkerPool` was received. | -| `privatePoolV1Config` | `object` | Configuration for a V1 `PrivatePool`. | -| `etag` | `string` | Output only. Checksum computed by the server. May be sent on update and delete requests to ensure that the client has an up-to-date value before proceeding. | +| `displayName` | `string` | A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudchannel/accounts/index.md b/docs/google-docs/providers/google/cloudchannel/accounts/index.md deleted file mode 100644 index eb8779d6b9..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/accounts/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: accounts -hide_title: false -hide_table_of_contents: false -keywords: - - accounts - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameaccounts
TypeResource
Idgoogle.cloudchannel.accounts
- -## 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 -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `checkCloudIdentityAccountsExist` | `EXEC` | `accountsId` | Confirms the existence of Cloud Identity accounts based on the domain and if the Cloud Identity accounts are owned by the reseller. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INVALID_VALUE: Invalid domain value in the request. Return value: A list of CloudIdentityCustomerAccount resources for the domain (may be empty) Note: in the v1alpha1 version of the API, a NOT_FOUND error returns if no CloudIdentityCustomerAccount resources match the domain. | -| `register` | `EXEC` | `accountsId` | Registers a service account with subscriber privileges on the Cloud Pub/Sub topic for this Channel Services account. After you create a subscriber, you get the events through SubscriberEvent Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name with the registered service email address. | -| `unregister` | `EXEC` | `accountsId` | Unregisters a service account with subscriber privileges on the Cloud Pub/Sub topic created for this Channel Services account. If there are no service accounts left with subscriber privileges, this deletes the topic. You can call ListSubscribers to check for these accounts. Possible error codes: * PERMISSION_DENIED: The reseller account making the request and the provided reseller account are different, or the impersonated user is not a super admin. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The topic resource doesn't exist. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The topic name that unregistered the service email address. Returns a success response if the service email address wasn't registered with the topic. | diff --git a/docs/google-docs/providers/google/cloudchannel/accounts_subscribers/index.md b/docs/google-docs/providers/google/cloudchannel/accounts_subscribers/index.md deleted file mode 100644 index 7a5f0e5797..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/accounts_subscribers/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: accounts_subscribers -hide_title: false -hide_table_of_contents: false -keywords: - - accounts_subscribers - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameaccounts_subscribers
TypeResource
Idgoogle.cloudchannel.accounts_subscribers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `serviceAccounts` | `array` | List of service accounts which have subscriber access to the topic. | -| `topic` | `string` | Name of the topic registered with the reseller. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accounts_listSubscribers` | `SELECT` | `accountsId` | diff --git a/docs/google-docs/providers/google/cloudchannel/accounts_transferable_offers/index.md b/docs/google-docs/providers/google/cloudchannel/accounts_transferable_offers/index.md deleted file mode 100644 index 935e0aa2a6..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/accounts_transferable_offers/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: accounts_transferable_offers -hide_title: false -hide_table_of_contents: false -keywords: - - accounts_transferable_offers - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameaccounts_transferable_offers
TypeResource
Idgoogle.cloudchannel.accounts_transferable_offers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `transferableOffers` | `array` | Information about Offers for a customer that can be used for transfer. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. Pass to ListTransferableOffersRequest.page_token to obtain that page. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accounts_listTransferableOffers` | `SELECT` | `accountsId` | diff --git a/docs/google-docs/providers/google/cloudchannel/accounts_transferable_skus/index.md b/docs/google-docs/providers/google/cloudchannel/accounts_transferable_skus/index.md deleted file mode 100644 index 96c0d184bc..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/accounts_transferable_skus/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: accounts_transferable_skus -hide_title: false -hide_table_of_contents: false -keywords: - - accounts_transferable_skus - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameaccounts_transferable_skus
TypeResource
Idgoogle.cloudchannel.accounts_transferable_skus
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `transferableSkus` | `array` | Information about existing SKUs for a customer that needs a transfer. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. Pass to ListTransferableSkusRequest.page_token to obtain that page. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accounts_listTransferableSkus` | `SELECT` | `accountsId` | diff --git a/docs/google-docs/providers/google/cloudchannel/channel_partner_links/index.md b/docs/google-docs/providers/google/cloudchannel/channel_partner_links/index.md deleted file mode 100644 index 22bad10ac1..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/channel_partner_links/index.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: channel_partner_links -hide_title: false -hide_table_of_contents: false -keywords: - - channel_partner_links - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namechannel_partner_links
TypeResource
Idgoogle.cloudchannel.channel_partner_links
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Resource name for the channel partner link, in the format accounts/{account_id}/channelPartnerLinks/{id}. | -| `resellerCloudIdentityId` | `string` | Required. Cloud Identity ID of the linked reseller. | -| `updateTime` | `string` | Output only. Timestamp of when the channel partner link is updated. | -| `channelPartnerCloudIdentityInfo` | `object` | Cloud Identity information for the Cloud Channel Customer. | -| `createTime` | `string` | Output only. Timestamp of when the channel partner link is created. | -| `inviteLinkUri` | `string` | Output only. URI of the web page where partner accepts the link invitation. | -| `linkState` | `string` | Required. State of the channel partner link. | -| `publicId` | `string` | Output only. Public identifier that a customer must use to generate a transfer token to move to this distributor-reseller combination. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `accounts_channelPartnerLinks_get` | `SELECT` | `accountsId, channelPartnerLinksId` | Returns the requested ChannelPartnerLink resource. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: ChannelPartnerLink resource not found because of an invalid channel partner link name. Return value: The ChannelPartnerLink resource. | -| `accounts_channelPartnerLinks_list` | `SELECT` | `accountsId` | List ChannelPartnerLinks belonging to a distributor. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: The list of the distributor account's ChannelPartnerLink resources. | -| `accounts_channelPartnerLinks_create` | `INSERT` | `accountsId` | Initiates a channel partner link between a distributor and a reseller, or between resellers in an n-tier reseller channel. Invited partners need to follow the invite_link_uri provided in the response to accept. After accepting the invitation, a link is set up between the two parties. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * ALREADY_EXISTS: The ChannelPartnerLink sent in the request already exists. * NOT_FOUND: No Cloud Identity customer exists for provided domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The new ChannelPartnerLink resource. | -| `accounts_channelPartnerLinks_patch` | `EXEC` | `accountsId, channelPartnerLinksId` | Updates a channel partner link. Distributors call this method to change a link's status. For example, to suspend a partner link. You must be a distributor to call this method. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Link state cannot change from invited to active or suspended. * Cannot send reseller_cloud_identity_id, invite_url, or name in update mask. * NOT_FOUND: ChannelPartnerLink resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The updated ChannelPartnerLink resource. | diff --git a/docs/google-docs/providers/google/cloudchannel/channel_partner_repricing_configs/index.md b/docs/google-docs/providers/google/cloudchannel/channel_partner_repricing_configs/index.md deleted file mode 100644 index 76ecfe21b4..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/channel_partner_repricing_configs/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: channel_partner_repricing_configs -hide_title: false -hide_table_of_contents: false -keywords: - - channel_partner_repricing_configs - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namechannel_partner_repricing_configs
TypeResource
Idgoogle.cloudchannel.channel_partner_repricing_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Resource name of the ChannelPartnerRepricingConfig. Format: accounts/{account_id}/channelPartnerLinks/{channel_partner_id}/channelPartnerRepricingConfigs/{id}. | -| `updateTime` | `string` | Output only. Timestamp of an update to the repricing rule. If `update_time` is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month. | -| `repricingConfig` | `object` | Configuration for repricing a Google bill over a period of time. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `accounts_channelPartnerLinks_channelPartnerRepricingConfigs_get` | `SELECT` | `accountsId, channelPartnerLinksId, channelPartnerRepricingConfigsId` | Gets information about how a Distributor modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resource, otherwise returns an error. | -| `accounts_channelPartnerLinks_channelPartnerRepricingConfigs_list` | `SELECT` | `accountsId, channelPartnerLinksId` | Lists information about how a Reseller modifies their bill before sending it to a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the ChannelPartnerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * channel partner ID * RepricingConfig.effective_invoice_month * ChannelPartnerRepricingConfig.update_time If unsuccessful, returns an error. | -| `accounts_channelPartnerLinks_channelPartnerRepricingConfigs_create` | `INSERT` | `accountsId, channelPartnerLinksId` | Creates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any ChannelPartner or RepricingConfig.effective_invoice_month. * The contained ChannelPartnerRepricingConfig.repricing_config vaule must be different from the value used in the current config for a ChannelPartner. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error. | -| `accounts_channelPartnerLinks_channelPartnerRepricingConfigs_delete` | `DELETE` | `accountsId, channelPartnerLinksId, channelPartnerRepricingConfigsId` | Deletes the given ChannelPartnerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The ChannelPartnerRepricingConfig is active or in the past. * NOT_FOUND: No ChannelPartnerRepricingConfig found for the name in the request. | -| `accounts_channelPartnerLinks_channelPartnerRepricingConfigs_patch` | `EXEC` | `accountsId, channelPartnerLinksId, channelPartnerRepricingConfigsId` | Updates a ChannelPartnerRepricingConfig. Call this method to set modifications for a specific ChannelPartner's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateChannelPartnerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The ChannelPartnerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated ChannelPartnerRepricingConfig resource, otherwise returns an error. | diff --git a/docs/google-docs/providers/google/cloudchannel/customer_repricing_configs/index.md b/docs/google-docs/providers/google/cloudchannel/customer_repricing_configs/index.md deleted file mode 100644 index d8bc959e5f..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/customer_repricing_configs/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: customer_repricing_configs -hide_title: false -hide_table_of_contents: false -keywords: - - customer_repricing_configs - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namecustomer_repricing_configs
TypeResource
Idgoogle.cloudchannel.customer_repricing_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Resource name of the CustomerRepricingConfig. Format: accounts/{account_id}/customers/{customer_id}/customerRepricingConfigs/{id}. | -| `repricingConfig` | `object` | Configuration for repricing a Google bill over a period of time. | -| `updateTime` | `string` | Output only. Timestamp of an update to the repricing rule. If `update_time` is after RepricingConfig.effective_invoice_month then it indicates this was set mid-month. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `accounts_customers_customerRepricingConfigs_get` | `SELECT` | `accountsId, customerRepricingConfigsId, customersId` | Gets information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The CustomerRepricingConfig was not found. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resource, otherwise returns an error. | -| `accounts_customers_customerRepricingConfigs_list` | `SELECT` | `accountsId, customersId` | Lists information about how a Reseller modifies their bill before sending it to a Customer. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the CustomerRepricingConfig resources. The data for each resource is displayed in the ascending order of: * customer ID * RepricingConfig.EntitlementGranularity.entitlement * RepricingConfig.effective_invoice_month * CustomerRepricingConfig.update_time If unsuccessful, returns an error. | -| `accounts_customers_customerRepricingConfigs_create` | `INSERT` | `accountsId, customersId` | Creates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. You can only create configs if the RepricingConfig.effective_invoice_month is a future month. If needed, you can create a config for the current month, with some restrictions. When creating a config for a future month, make sure there are no existing configs for that RepricingConfig.effective_invoice_month. The following restrictions are for creating configs in the current month. * This functionality is reserved for recovering from an erroneous config, and should not be used for regular business cases. * The new config will not modify exports used with other configs. Changes to the config may be immediate, but may take up to 24 hours. * There is a limit of ten configs for any RepricingConfig.EntitlementGranularity.entitlement or RepricingConfig.effective_invoice_month. * The contained CustomerRepricingConfig.repricing_config vaule must be different from the value used in the current config for a RepricingConfig.EntitlementGranularity.entitlement. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error. | -| `accounts_customers_customerRepricingConfigs_delete` | `DELETE` | `accountsId, customerRepricingConfigsId, customersId` | Deletes the given CustomerRepricingConfig permanently. You can only delete configs if their RepricingConfig.effective_invoice_month is set to a date after the current month. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The CustomerRepricingConfig is active or in the past. * NOT_FOUND: No CustomerRepricingConfig found for the name in the request. | -| `accounts_customers_customerRepricingConfigs_patch` | `EXEC` | `accountsId, customerRepricingConfigsId, customersId` | Updates a CustomerRepricingConfig. Call this method to set modifications for a specific customer's bill. This method overwrites the existing CustomerRepricingConfig. You can only update configs if the RepricingConfig.effective_invoice_month is a future month. To make changes to configs for the current month, use CreateCustomerRepricingConfig, taking note of its restrictions. You cannot update the RepricingConfig.effective_invoice_month. When updating a config in the future: * This config must already exist. Possible Error Codes: * PERMISSION_DENIED: If the account making the request and the account being queried are different. * INVALID_ARGUMENT: Missing or invalid required parameters in the request. Also displays if the updated config is for the current month or past months. * NOT_FOUND: The CustomerRepricingConfig specified does not exist or is not associated with the given account. * INTERNAL: Any non-user error related to technical issues in the backend. In this case, contact Cloud Channel support. Return Value: If successful, the updated CustomerRepricingConfig resource, otherwise returns an error. | diff --git a/docs/google-docs/providers/google/cloudchannel/customers/index.md b/docs/google-docs/providers/google/cloudchannel/customers/index.md deleted file mode 100644 index 1aa04c6d43..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/customers/index.md +++ /dev/null @@ -1,59 +0,0 @@ ---- -title: customers -hide_title: false -hide_table_of_contents: false -keywords: - - customers - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namecustomers
TypeResource
Idgoogle.cloudchannel.customers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Resource name of the customer. Format: accounts/{account_id}/customers/{customer_id} | -| `domain` | `string` | Required. The customer's primary domain. Must match the primary contact email's domain. | -| `languageCode` | `string` | Optional. The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see https://www.unicode.org/reports/tr35/#Unicode_locale_identifier. | -| `cloudIdentityInfo` | `object` | Cloud Identity information for the Cloud Channel Customer. | -| `createTime` | `string` | Output only. Time when the customer was created. | -| `channelPartnerId` | `string` | Cloud Identity ID of the customer's channel partner. Populated only if a channel partner exists for this customer. | -| `cloudIdentityId` | `string` | Output only. The customer's Cloud Identity ID if the customer has a Cloud Identity resource. | -| `orgDisplayName` | `string` | Required. Name of the organization that the customer entity represents. | -| `orgPostalAddress` | `object` | Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 | -| `updateTime` | `string` | Output only. Time when the customer was updated. | -| `alternateEmail` | `string` | Secondary contact email. You need to provide an alternate email to create different domains if a primary contact email already exists. Users will receive a notification with credentials when you create an admin.google.com account. Secondary emails are also recovery email addresses. Alternate emails are optional when you create Team customers. | -| `primaryContactInfo` | `object` | Contact information for a customer account. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `accounts_channelPartnerLinks_customers_get` | `SELECT` | `accountsId, channelPartnerLinksId, customersId` | Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource. | -| `accounts_channelPartnerLinks_customers_list` | `SELECT` | `accountsId, channelPartnerLinksId` | List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers. | -| `accounts_customers_get` | `SELECT` | `accountsId, customersId` | Returns the requested Customer resource. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer resource doesn't exist. Usually the result of an invalid name parameter. Return value: The Customer resource. | -| `accounts_customers_list` | `SELECT` | `accountsId` | List Customers. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: List of Customers, or an empty list if there are no customers. | -| `accounts_channelPartnerLinks_customers_create` | `INSERT` | `accountsId, channelPartnerLinksId` | Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource. | -| `accounts_customers_create` | `INSERT` | `accountsId` | Creates a new Customer resource under the reseller or distributor account. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * Domain field value doesn't match the primary email domain. Return value: The newly created Customer resource. | -| `accounts_channelPartnerLinks_customers_delete` | `DELETE` | `accountsId, channelPartnerLinksId, customersId` | Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request. | -| `accounts_customers_delete` | `DELETE` | `accountsId, customersId` | Deletes the given Customer permanently. Possible error codes: * PERMISSION_DENIED: The account making the request does not own this customer. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * FAILED_PRECONDITION: The customer has existing entitlements. * NOT_FOUND: No Customer resource found for the name in the request. | -| `accounts_channelPartnerLinks_customers_import` | `EXEC` | `accountsId, channelPartnerLinksId` | Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer. | -| `accounts_channelPartnerLinks_customers_patch` | `EXEC` | `accountsId, channelPartnerLinksId, customersId` | Updates an existing Customer resource for the reseller or distributor. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource. | -| `accounts_customers_import` | `EXEC` | `accountsId` | Imports a Customer from the Cloud Identity associated with the provided Cloud Identity ID or domain before a TransferEntitlements call. If a linked Customer already exists and overwrite_if_exists is true, it will update that Customer's data. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * NOT_FOUND: Cloud Identity doesn't exist or was deleted. * INVALID_ARGUMENT: Required parameters are missing, or the auth_token is expired or invalid. * ALREADY_EXISTS: A customer already exists and has conflicting critical fields. Requires an overwrite. Return value: The Customer. | -| `accounts_customers_patch` | `EXEC` | `accountsId, customersId` | Updates an existing Customer resource for the reseller or distributor. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: No Customer resource found for the name in the request. Return value: The updated Customer resource. | -| `accounts_customers_provisionCloudIdentity` | `EXEC` | `accountsId, customersId` | Creates a Cloud Identity for the given customer using the customer's information, or the information provided here. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer was not found. * ALREADY_EXISTS: The customer's primary email already exists. Retry after changing the customer's primary contact email. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata. | -| `accounts_customers_transferEntitlements` | `EXEC` | `accountsId, customersId` | Transfers customer entitlements to new reseller. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * Specify all transferring entitlements. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_transferEntitlementsToGoogle` | `EXEC` | `accountsId, customersId` | Transfers customer entitlements from their current reseller to Google. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: The SKU was already transferred for the customer. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The SKU requires domain verification to transfer, but the domain is not verified. * An Add-On SKU (example, Vault or Drive) is missing the pre-requisite SKU (example, G Suite Basic). * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata. | diff --git a/docs/google-docs/providers/google/cloudchannel/customers_purchasable_offers/index.md b/docs/google-docs/providers/google/cloudchannel/customers_purchasable_offers/index.md deleted file mode 100644 index a51a78af85..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/customers_purchasable_offers/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: customers_purchasable_offers -hide_title: false -hide_table_of_contents: false -keywords: - - customers_purchasable_offers - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namecustomers_purchasable_offers
TypeResource
Idgoogle.cloudchannel.customers_purchasable_offers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. | -| `purchasableOffers` | `array` | The list of Offers requested. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accounts_customers_listPurchasableOffers` | `SELECT` | `accountsId, customersId` | diff --git a/docs/google-docs/providers/google/cloudchannel/customers_purchasable_skus/index.md b/docs/google-docs/providers/google/cloudchannel/customers_purchasable_skus/index.md deleted file mode 100644 index 6de69d2a54..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/customers_purchasable_skus/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: customers_purchasable_skus -hide_title: false -hide_table_of_contents: false -keywords: - - customers_purchasable_skus - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namecustomers_purchasable_skus
TypeResource
Idgoogle.cloudchannel.customers_purchasable_skus
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. | -| `purchasableSkus` | `array` | The list of SKUs requested. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accounts_customers_listPurchasableSkus` | `SELECT` | `accountsId, customersId` | diff --git a/docs/google-docs/providers/google/cloudchannel/entitlements/index.md b/docs/google-docs/providers/google/cloudchannel/entitlements/index.md deleted file mode 100644 index 4166783835..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/entitlements/index.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: entitlements -hide_title: false -hide_table_of_contents: false -keywords: - - entitlements - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameentitlements
TypeResource
Idgoogle.cloudchannel.entitlements
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Resource name of an entitlement in the form: accounts/{account_id}/customers/{customer_id}/entitlements/{entitlement_id}. | -| `parameters` | `array` | Extended entitlement parameters. When creating an entitlement, valid parameter names and values are defined in the Offer.parameter_definitions. The response may include the following output-only Parameters: - assigned_units: The number of licenses assigned to users. - max_units: The maximum assignable units for a flexible offer. - num_units: The total commitment for commitment-based offers. | -| `trialSettings` | `object` | Settings for trial offers. | -| `updateTime` | `string` | Output only. The time at which the entitlement is updated. | -| `associationInfo` | `object` | Association links that an entitlement has to other entitlements. | -| `purchaseOrderId` | `string` | Optional. This purchase order (PO) information is for resellers to use for their company tracking usage. If a purchaseOrderId value is given, it appears in the API responses and shows up in the invoice. The property accepts up to 80 plain text characters. This is only supported for Google Workspace entitlements. | -| `createTime` | `string` | Output only. The time at which the entitlement is created. | -| `offer` | `string` | Required. The offer resource name for which the entitlement is to be created. Takes the form: accounts/{account_id}/offers/{offer_id}. | -| `commitmentSettings` | `object` | Commitment settings for commitment-based offers. | -| `provisioningState` | `string` | Output only. Current provisioning state of the entitlement. | -| `provisionedService` | `object` | Service provisioned for an entitlement. | -| `suspensionReasons` | `array` | Output only. Enumerable of all current suspension reasons for an entitlement. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `accounts_customers_entitlements_get` | `SELECT` | `accountsId, customersId, entitlementsId` | Returns the requested Entitlement resource. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The customer entitlement was not found. Return value: The requested Entitlement resource. | -| `accounts_customers_entitlements_list` | `SELECT` | `accountsId, customersId` | Lists Entitlements belonging to a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. Return value: A list of the customer's Entitlements. | -| `accounts_customers_entitlements_create` | `INSERT` | `accountsId, customersId` | Creates an entitlement for a customer. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: * Required request parameters are missing or invalid. * There is already a customer entitlement for a SKU from the same product family. * INVALID_VALUE: Make sure the OfferId is valid. If it is, contact Google Channel support for further troubleshooting. * NOT_FOUND: The customer or offer resource was not found. * ALREADY_EXISTS: * The SKU was already purchased for the customer. * The customer's primary email already exists. Retry after changing the customer's primary contact email. * CONDITION_NOT_MET or FAILED_PRECONDITION: * The domain required for purchasing a SKU has not been verified. * A pre-requisite SKU required to purchase an Add-On SKU is missing. For example, Google Workspace Business Starter is required to purchase Vault or Drive. * (Developer accounts only) Reseller and resold domain must meet the following naming requirements: * Domain names must start with goog-test. * Domain names must include the reseller domain. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_entitlements_activate` | `EXEC` | `accountsId, customersId, entitlementsId` | Activates a previously suspended entitlement. Entitlements suspended for pending ToS acceptance can't be activated using this method. An entitlement activation is a long-running operation and it updates the state of the customer entitlement. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * SUSPENSION_NOT_RESELLER_INITIATED: Can only activate reseller-initiated suspensions and entitlements that have accepted the TOS. * NOT_SUSPENDED: Can only activate suspended entitlements not in an ACTIVE state. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_entitlements_cancel` | `EXEC` | `accountsId, customersId, entitlementsId` | Cancels a previously fulfilled entitlement. An entitlement cancellation is a long-running operation. Possible error codes: * PERMISSION_DENIED: The reseller account making the request is different from the reseller account in the API request. * FAILED_PRECONDITION: There are Google Cloud projects linked to the Google Cloud entitlement's Cloud Billing subaccount. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * DELETION_TYPE_NOT_ALLOWED: Cancel is only allowed for Google Workspace add-ons, or entitlements for Google Cloud's development platform. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The response will contain google.protobuf.Empty on success. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_entitlements_changeOffer` | `EXEC` | `accountsId, customersId, entitlementsId` | Updates the Offer for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Offer or Entitlement resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_entitlements_changeParameters` | `EXEC` | `accountsId, customersId, entitlementsId` | Change parameters of the entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. For example, the number of seats being changed is greater than the allowed number of max seats, or decreasing seats for a commitment based plan. * NOT_FOUND: Entitlement resource not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_entitlements_changeRenewalSettings` | `EXEC` | `accountsId, customersId, entitlementsId` | Updates the renewal settings for an existing customer entitlement. An entitlement update is a long-running operation and it updates the entitlement as a result of fulfillment. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_COMMITMENT_PLAN: Renewal Settings are only applicable for a commitment plan. Can't enable or disable renewals for non-commitment plans. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_entitlements_lookupOffer` | `EXEC` | `accountsId, customersId, entitlementsId` | Returns the requested Offer resource. Possible error codes: * PERMISSION_DENIED: The entitlement doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement or offer was not found. Return value: The Offer resource. | -| `accounts_customers_entitlements_startPaidService` | `EXEC` | `accountsId, customersId, entitlementsId` | Starts paid service for a trial entitlement. Starts paid service for a trial entitlement immediately. This method is only applicable if a plan is set up for a trial entitlement but has some trial days remaining. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * FAILED_PRECONDITION/NOT_IN_TRIAL: This method only works for entitlement on trial plans. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | -| `accounts_customers_entitlements_suspend` | `EXEC` | `accountsId, customersId, entitlementsId` | Suspends a previously fulfilled entitlement. An entitlement suspension is a long-running operation. Possible error codes: * PERMISSION_DENIED: The customer doesn't belong to the reseller. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: Entitlement resource not found. * NOT_ACTIVE: Entitlement is not active. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata will contain an instance of OperationMetadata. | diff --git a/docs/google-docs/providers/google/cloudchannel/index.md b/docs/google-docs/providers/google/cloudchannel/index.md deleted file mode 100644 index 62c5d575db..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/index.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -title: cloudchannel -hide_title: false -hide_table_of_contents: false -keywords: - - cloudchannel - - 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 ---- -The Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome. - -:::info Service Summary - -
-
-total resources: 17
-total selectable resources: 16
-total methods: 58
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.cloudchannel
TypeService
TitleCloud Channel API
DescriptionThe Cloud Channel API enables Google Cloud partners to have a single unified resale platform and APIs across all of Google Cloud including GCP, Workspace, Maps and Chrome.
Idcloudchannel:v23.05.00145
- -## Resources -
-
-accounts
-accounts_subscribers
-accounts_transferable_offers
-accounts_transferable_skus
-channel_partner_links
-channel_partner_repricing_configs
-customer_repricing_configs
-customers
-customers_purchasable_offers
-
-
-customers_purchasable_skus
-entitlements
-offers
-operations
-products
-report_jobs_report_results
-reports
-skus
-
-
diff --git a/docs/google-docs/providers/google/cloudchannel/offers/index.md b/docs/google-docs/providers/google/cloudchannel/offers/index.md deleted file mode 100644 index b613711111..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/offers/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: offers -hide_title: false -hide_table_of_contents: false -keywords: - - offers - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameoffers
TypeResource
Idgoogle.cloudchannel.offers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `offers` | `array` | The list of Offers requested. | -| `nextPageToken` | `string` | A token to retrieve the next page of results. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accounts_offers_list` | `SELECT` | `accountsId` | diff --git a/docs/google-docs/providers/google/cloudchannel/operations/index.md b/docs/google-docs/providers/google/cloudchannel/operations/index.md deleted file mode 100644 index 61c0491f65..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/operations/index.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: operations -hide_title: false -hide_table_of_contents: false -keywords: - - operations - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameoperations
TypeResource
Idgoogle.cloudchannel.operations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `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}`. | -| `done` | `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. | -| `error` | `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). | -| `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | -|:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `operationsId` | Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. | -| `list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id. | -| `delete` | `DELETE` | `operationsId` | 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`. | -| `cancel` | `EXEC` | `operationsId` | 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`. | diff --git a/docs/google-docs/providers/google/cloudchannel/products/index.md b/docs/google-docs/providers/google/cloudchannel/products/index.md deleted file mode 100644 index 2400c9eebb..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/products/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: products -hide_title: false -hide_table_of_contents: false -keywords: - - products - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameproducts
TypeResource
Idgoogle.cloudchannel.products
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. | -| `products` | `array` | List of Products requested. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `list` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudchannel/report_jobs_report_results/index.md b/docs/google-docs/providers/google/cloudchannel/report_jobs_report_results/index.md deleted file mode 100644 index deb2d8db40..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/report_jobs_report_results/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: report_jobs_report_results -hide_title: false -hide_table_of_contents: false -keywords: - - report_jobs_report_results - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namereport_jobs_report_results
TypeResource
Idgoogle.cloudchannel.report_jobs_report_results
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `rows` | `array` | The report's lists of values. Each row follows the settings and ordering of the columns from `report_metadata`. | -| `nextPageToken` | `string` | Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results. | -| `reportMetadata` | `object` | The features describing the data. Returned by CloudChannelReportsService.RunReportJob and CloudChannelReportsService.FetchReportResults. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `accounts_reportJobs_fetchReportResults` | `SELECT` | `accountsId, reportJobsId` | diff --git a/docs/google-docs/providers/google/cloudchannel/reports/index.md b/docs/google-docs/providers/google/cloudchannel/reports/index.md deleted file mode 100644 index 454a698645..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/reports/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: reports -hide_title: false -hide_table_of_contents: false -keywords: - - reports - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Namereports
TypeResource
Idgoogle.cloudchannel.reports
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | Pass this token to FetchReportResultsRequest.page_token to retrieve the next page of results. | -| `reports` | `array` | The reports available to the partner. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `accounts_reports_list` | `SELECT` | `accountsId` | Lists the reports that RunReportJob can run. These reports include an ID, a description, and the list of columns that will be in the result. | -| `accounts_reports_run` | `EXEC` | `accountsId, reportsId` | Begins generation of data for a given report. The report identifier is a UID (for example, `613bf59q`). Possible error codes: * PERMISSION_DENIED: The user doesn't have access to this report. * INVALID_ARGUMENT: Required request parameters are missing or invalid. * NOT_FOUND: The report identifier was not found. * INTERNAL: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. * UNKNOWN: Any non-user error related to a technical issue in the backend. Contact Cloud Channel support. Return value: The ID of a long-running operation. To get the results of the operation, call the GetOperation method of CloudChannelOperationsService. The Operation metadata contains an instance of OperationMetadata. To get the results of report generation, call CloudChannelReportsService.FetchReportResults with the RunReportJobResponse.report_job. | diff --git a/docs/google-docs/providers/google/cloudchannel/skus/index.md b/docs/google-docs/providers/google/cloudchannel/skus/index.md deleted file mode 100644 index 6a17b9a29d..0000000000 --- a/docs/google-docs/providers/google/cloudchannel/skus/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: skus -hide_title: false -hide_table_of_contents: false -keywords: - - skus - - cloudchannel - - 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 ---- - - - -## Overview - - - - -
Nameskus
TypeResource
Idgoogle.cloudchannel.skus
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token to retrieve the next page of results. | -| `skus` | `array` | The list of SKUs requested. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `products_skus_list` | `SELECT` | `productsId` | diff --git a/docs/google-docs/providers/google/clouddebugger/controller_debuggees/index.md b/docs/google-docs/providers/google/clouddebugger/controller_debuggees/index.md deleted file mode 100644 index 17042009aa..0000000000 --- a/docs/google-docs/providers/google/clouddebugger/controller_debuggees/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: controller_debuggees -hide_title: false -hide_table_of_contents: false -keywords: - - controller_debuggees - - clouddebugger - - 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 ---- - - - -## Overview - - - - -
Namecontroller_debuggees
TypeResource
Idgoogle.clouddebugger.controller_debuggees
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `register` | `EXEC` | | diff --git a/docs/google-docs/providers/google/clouddebugger/controller_debuggees_breakpoints/index.md b/docs/google-docs/providers/google/clouddebugger/controller_debuggees_breakpoints/index.md deleted file mode 100644 index ee08b83036..0000000000 --- a/docs/google-docs/providers/google/clouddebugger/controller_debuggees_breakpoints/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: controller_debuggees_breakpoints -hide_title: false -hide_table_of_contents: false -keywords: - - controller_debuggees_breakpoints - - clouddebugger - - 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 ---- - - - -## Overview - - - - -
Namecontroller_debuggees_breakpoints
TypeResource
Idgoogle.clouddebugger.controller_debuggees_breakpoints
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | Breakpoint identifier, unique in the scope of the debuggee. | -| `location` | `object` | Represents a location in the source code. | -| `createTime` | `string` | Time this breakpoint was created by the server in seconds resolution. | -| `state` | `string` | The current state of the breakpoint. | -| `finalTime` | `string` | Time this breakpoint was finalized as seen by the server in seconds resolution. | -| `stackFrames` | `array` | The stack at breakpoint time, where stack_frames[0] represents the most recently entered function. | -| `expressions` | `array` | List of read-only expressions to evaluate at the breakpoint location. The expressions are composed using expressions in the programming language at the source location. If the breakpoint action is `LOG`, the evaluated expressions are included in log statements. | -| `canaryExpireTime` | `string` | The deadline for the breakpoint to stay in CANARY_ACTIVE state. The value is meaningless when the breakpoint is not in CANARY_ACTIVE state. | -| `action` | `string` | Action that the agent should perform when the code at the breakpoint location is hit. | -| `userEmail` | `string` | E-mail address of the user that created this breakpoint | -| `logLevel` | `string` | Indicates the severity of the log. Only relevant when action is `LOG`. | -| `evaluatedExpressions` | `array` | Values of evaluated expressions at breakpoint time. The evaluated expressions appear in exactly the same order they are listed in the `expressions` field. The `name` field holds the original expression text, the `value` or `members` field holds the result of the evaluated expression. If the expression cannot be evaluated, the `status` inside the `Variable` will indicate an error and contain the error text. | -| `logMessageFormat` | `string` | Only relevant when action is `LOG`. Defines the message to log when the breakpoint hits. The message may include parameter placeholders `$0`, `$1`, etc. These placeholders are replaced with the evaluated value of the appropriate expression. Expressions not referenced in `log_message_format` are not logged. Example: `Message received, id = $0, count = $1` with `expressions` = `[ message.id, message.count ]`. | -| `status` | `object` | Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. | -| `isFinalState` | `boolean` | When true, indicates that this is a final result and the breakpoint state will not change from here on. | -| `labels` | `object` | A set of custom breakpoint properties, populated by the agent, to be displayed to the user. | -| `condition` | `string` | Condition that triggers the breakpoint. The condition is a compound boolean expression composed using expressions in a programming language at the source location. | -| `variableTable` | `array` | The `variable_table` exists to aid with computation, memory and network traffic optimization. It enables storing a variable once and reference it from multiple variables, including variables stored in the `variable_table` itself. For example, the same `this` object, which may appear at many levels of the stack, can have all of its data stored once in this table. The stack frame variables then would hold only a reference to it. The variable `var_table_index` field is an index into this repeated field. The stored objects are nameless and get their name from the referencing variable. The effective variable is a merge of the referencing variable and the referenced variable. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `list` | `SELECT` | `debuggeeId` | Returns the list of all active breakpoints for the debuggee. The breakpoint specification (`location`, `condition`, and `expressions` fields) is semantically immutable, although the field values may change. For example, an agent may update the location line number to reflect the actual line where the breakpoint was set, but this doesn't change the breakpoint semantics. This means that an agent does not need to check if a breakpoint has changed when it encounters the same breakpoint on a successive call. Moreover, an agent should remember the breakpoints that are completed until the controller removes them from the active list to avoid setting those breakpoints again. | -| `update` | `EXEC` | `debuggeeId, id` | Updates the breakpoint state or mutable fields. The entire Breakpoint message must be sent back to the controller service. Updates to active breakpoint fields are only allowed if the new value does not change the breakpoint specification. Updates to the `location`, `condition` and `expressions` fields should not alter the breakpoint semantics. These may only make changes such as canonicalizing a value or snapping the location to the correct line of code. | diff --git a/docs/google-docs/providers/google/clouddebugger/debugger_debuggees/index.md b/docs/google-docs/providers/google/clouddebugger/debugger_debuggees/index.md deleted file mode 100644 index fb328b23b2..0000000000 --- a/docs/google-docs/providers/google/clouddebugger/debugger_debuggees/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: debugger_debuggees -hide_title: false -hide_table_of_contents: false -keywords: - - debugger_debuggees - - clouddebugger - - 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 ---- - - - -## Overview - - - - -
Namedebugger_debuggees
TypeResource
Idgoogle.clouddebugger.debugger_debuggees
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | Unique identifier for the debuggee generated by the controller service. | -| `description` | `string` | Human readable description of the debuggee. Including a human-readable project name, environment name and version information is recommended. | -| `canaryMode` | `string` | Used when setting breakpoint canary for this debuggee. | -| `isDisabled` | `boolean` | If set to `true`, indicates that the agent should disable itself and detach from the debuggee. | -| `sourceContexts` | `array` | References to the locations and revisions of the source code used in the deployed application. | -| `uniquifier` | `string` | Uniquifier to further distinguish the application. It is possible that different applications might have identical values in the debuggee message, thus, incorrectly identified as a single application by the Controller service. This field adds salt to further distinguish the application. Agents should consider seeding this field with value that identifies the code, binary, configuration and environment. | -| `agentVersion` | `string` | Version ID of the agent. Schema: `domain/language-platform/vmajor.minor` (for example `google.com/java-gcp/v1.1`). | -| `status` | `object` | Represents a contextual status message. The message can indicate an error or informational status, and refer to specific parts of the containing object. For example, the `Breakpoint.status` field can indicate an error referring to the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`. | -| `labels` | `object` | A set of custom debuggee properties, populated by the agent, to be displayed to the user. | -| `extSourceContexts` | `array` | References to the locations and revisions of the source code used in the deployed application. | -| `project` | `string` | Project the debuggee is associated with. Use project number or id when registering a Google Cloud Platform project. | -| `isInactive` | `boolean` | If set to `true`, indicates that Controller service does not detect any activity from the debuggee agents and the application is possibly stopped. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `list` | `SELECT` | | diff --git a/docs/google-docs/providers/google/clouddebugger/debugger_debuggees_breakpoints/index.md b/docs/google-docs/providers/google/clouddebugger/debugger_debuggees_breakpoints/index.md deleted file mode 100644 index 9cc53895b1..0000000000 --- a/docs/google-docs/providers/google/clouddebugger/debugger_debuggees_breakpoints/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: debugger_debuggees_breakpoints -hide_title: false -hide_table_of_contents: false -keywords: - - debugger_debuggees_breakpoints - - clouddebugger - - 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 ---- - - - -## Overview - - - - -
Namedebugger_debuggees_breakpoints
TypeResource
Idgoogle.clouddebugger.debugger_debuggees_breakpoints
- -## Fields -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `breakpointId, debuggeeId` | Gets breakpoint information. | -| `list` | `SELECT` | `debuggeeId` | Lists all breakpoints for the debuggee. | -| `delete` | `DELETE` | `breakpointId, debuggeeId` | Deletes the breakpoint from the debuggee. | -| `set` | `EXEC` | `debuggeeId` | Sets the breakpoint to the debuggee. | diff --git a/docs/google-docs/providers/google/clouddebugger/index.md b/docs/google-docs/providers/google/clouddebugger/index.md deleted file mode 100644 index e5712c4499..0000000000 --- a/docs/google-docs/providers/google/clouddebugger/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: clouddebugger -hide_title: false -hide_table_of_contents: false -keywords: - - clouddebugger - - 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 ---- -Examines the call stack and variables of a running application without stopping or slowing it down. - -:::info Service Summary - -
-
-total resources: 4
-total selectable resources: 3
-total methods: 8
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.clouddebugger
TypeService
TitleCloud Debugger API
DescriptionExamines the call stack and variables of a running application without stopping or slowing it down.
Idclouddebugger:v23.05.00145
- -## Resources -
-
-controller_debuggees
-controller_debuggees_breakpoints
-
-
-debugger_debuggees
-debugger_debuggees_breakpoints
-
-
diff --git a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md index 50081c3daf..9947cc4f29 100644 --- a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md +++ b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Optional. Name of the `DeliveryPipeline`. Format is projects/{project}/ locations/{location}/deliveryPipelines/a-z{0,62}. | | `description` | `string` | Description of the `DeliveryPipeline`. Max length is 255 characters. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | +| `suspended` | `boolean` | When suspended, no new releases or rollouts can be created, but in-progress ones will complete. | | `serialPipeline` | `object` | SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. | -| `condition` | `object` | PipelineCondition contains all conditions relevant to a Delivery Pipeline. | +| `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | +| `createTime` | `string` | Output only. Time at which the pipeline was created. | | `uid` | `string` | Output only. Unique identifier of the `DeliveryPipeline`. | -| `suspended` | `boolean` | When suspended, no new releases or rollouts can be created, but in-progress ones will complete. | -| `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. | | `updateTime` | `string` | Output only. Most recent time at which the pipeline was updated. | -| `createTime` | `string` | Output only. Time at which the pipeline was created. | +| `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. | +| `condition` | `object` | PipelineCondition contains all conditions relevant to a Delivery Pipeline. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_audit_configs/index.md b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_audit_configs/index.md deleted file mode 100644 index 23cec262f2..0000000000 --- a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: delivery_pipelines_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - delivery_pipelines_iam_audit_configs - - clouddeploy - - 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 ---- - - - -## Overview - - - - -
Namedelivery_pipelines_iam_audit_configs
TypeResource
Idgoogle.clouddeploy.delivery_pipelines_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_deliveryPipelines_getIamPolicy` | `SELECT` | `deliveryPipelinesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_bindings/index.md b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_bindings/index.md deleted file mode 100644 index c281ed8264..0000000000 --- a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: delivery_pipelines_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - delivery_pipelines_iam_bindings - - clouddeploy - - 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 ---- - - - -## Overview - - - - -
Namedelivery_pipelines_iam_bindings
TypeResource
Idgoogle.clouddeploy.delivery_pipelines_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_deliveryPipelines_getIamPolicy` | `SELECT` | `deliveryPipelinesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md index 56affa6576..8b8ff359a8 100644 --- a/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md +++ b/docs/google-docs/providers/google/clouddeploy/delivery_pipelines_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/job_runs/index.md b/docs/google-docs/providers/google/clouddeploy/job_runs/index.md index 0dba00a21d..4db0f471e1 100644 --- a/docs/google-docs/providers/google/clouddeploy/job_runs/index.md +++ b/docs/google-docs/providers/google/clouddeploy/job_runs/index.md @@ -28,20 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Optional. Name of the `JobRun`. Format is projects/{project}/locations/{location}/ deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/ {rollouts}/jobRuns/{uuid}. | -| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `advanceChildRolloutJobRun` | `object` | AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`. | | `uid` | `string` | Output only. Unique identifier of the `JobRun`. | +| `postdeployJobRun` | `object` | PostdeployJobRun contains information specific to a postdeploy `JobRun`. | +| `jobId` | `string` | Output only. ID of the `Rollout` job this `JobRun` corresponds to. | | `createTime` | `string` | Output only. Time at which the `JobRun` was created. | -| `state` | `string` | Output only. The current state of the `JobRun`. | | `predeployJobRun` | `object` | PredeployJobRun contains information specific to a predeploy `JobRun`. | -| `advanceChildRolloutJobRun` | `object` | AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`. | -| `postdeployJobRun` | `object` | PostdeployJobRun contains information specific to a postdeploy `JobRun`. | -| `endTime` | `string` | Output only. Time at which the `JobRun` ended. | -| `verifyJobRun` | `object` | VerifyJobRun contains information specific to a verify `JobRun`. | | `phaseId` | `string` | Output only. ID of the `Rollout` phase this `JobRun` belongs in. | -| `jobId` | `string` | Output only. ID of the `Rollout` job this `JobRun` corresponds to. | | `createChildRolloutJobRun` | `object` | CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`. | -| `deployJobRun` | `object` | DeployJobRun contains information specific to a deploy `JobRun`. | +| `endTime` | `string` | Output only. Time at which the `JobRun` ended. | +| `state` | `string` | Output only. The current state of the `JobRun`. | | `startTime` | `string` | Output only. Time at which the `JobRun` was started. | +| `verifyJobRun` | `object` | VerifyJobRun contains information specific to a verify `JobRun`. | +| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `deployJobRun` | `object` | DeployJobRun contains information specific to a deploy `JobRun`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/locations/index.md b/docs/google-docs/providers/google/clouddeploy/locations/index.md index a6017e861d..e7cd23aa2b 100644 --- a/docs/google-docs/providers/google/clouddeploy/locations/index.md +++ b/docs/google-docs/providers/google/clouddeploy/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/locations_config/index.md b/docs/google-docs/providers/google/clouddeploy/locations_config/index.md deleted file mode 100644 index 6f64353f18..0000000000 --- a/docs/google-docs/providers/google/clouddeploy/locations_config/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: locations_config -hide_title: false -hide_table_of_contents: false -keywords: - - locations_config - - clouddeploy - - 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 ---- - - - -## Overview - - - - -
Namelocations_config
TypeResource
Idgoogle.clouddeploy.locations_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Name of the configuration. | -| `supportedVersions` | `array` | All supported versions of Skaffold. | -| `defaultSkaffoldVersion` | `string` | Default Skaffold version that is assigned when a Release is created without specifying a Skaffold version. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_getConfig` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/clouddeploy/releases/index.md b/docs/google-docs/providers/google/clouddeploy/releases/index.md index 5aa1b5eeab..94b9de84c3 100644 --- a/docs/google-docs/providers/google/clouddeploy/releases/index.md +++ b/docs/google-docs/providers/google/clouddeploy/releases/index.md @@ -29,25 +29,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Optional. Name of the `Release`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/a-z{0,62}. | | `description` | `string` | Description of the `Release`. Max length is 255 characters. | -| `renderStartTime` | `string` | Output only. Time at which the render began. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `skaffoldVersion` | `string` | The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used. | -| `skaffoldConfigPath` | `string` | Filepath of the Skaffold config inside of the config URI. | | `targetSnapshots` | `array` | Output only. Snapshot of the targets taken at release creation time. | -| `deployParameters` | `object` | Optional. The deploy parameters to use for all targets in this release. | -| `abandoned` | `boolean` | Output only. Indicates whether this is an abandoned release. | | `skaffoldConfigUri` | `string` | Cloud Storage URI of tar.gz archive containing Skaffold configuration. | -| `uid` | `string` | Output only. Unique identifier of the `Release`. | -| `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | -| `renderEndTime` | `string` | Output only. Time at which the render completed. | +| `skaffoldConfigPath` | `string` | Filepath of the Skaffold config inside of the config URI. | | `targetArtifacts` | `object` | Output only. Map from target ID to the target artifacts created during the render operation. | -| `buildArtifacts` | `array` | List of artifacts to pass through to Skaffold command. | -| `deliveryPipelineSnapshot` | `object` | A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `createTime` | `string` | Output only. Time at which the `Release` was created. | +| `renderStartTime` | `string` | Output only. Time at which the render began. | | `condition` | `object` | ReleaseCondition contains all conditions relevant to a Release. | +| `deployParameters` | `object` | Optional. The deploy parameters to use for all targets in this release. | +| `skaffoldVersion` | `string` | The Skaffold version to use when operating on this release, such as "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set of versions. If unset, the most recent supported Skaffold version will be used. | | `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | -| `targetRenders` | `object` | Output only. Map from target ID to details of the render operation for that target. | -| `createTime` | `string` | Output only. Time at which the `Release` was created. | +| `abandoned` | `boolean` | Output only. Indicates whether this is an abandoned release. | +| `buildArtifacts` | `array` | List of artifacts to pass through to Skaffold command. | +| `deliveryPipelineSnapshot` | `object` | A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. | +| `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | +| `uid` | `string` | Output only. Unique identifier of the `Release`. | +| `renderEndTime` | `string` | Output only. Time at which the render completed. | | `renderState` | `string` | Output only. Current state of the render operation. | +| `targetRenders` | `object` | Output only. Map from target ID to details of the render operation for that target. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/rollouts/index.md b/docs/google-docs/providers/google/clouddeploy/rollouts/index.md index e94b1e87f2..d4ac41a26e 100644 --- a/docs/google-docs/providers/google/clouddeploy/rollouts/index.md +++ b/docs/google-docs/providers/google/clouddeploy/rollouts/index.md @@ -29,24 +29,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Optional. Name of the `Rollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. | | `description` | `string` | Description of the `Rollout` for user purposes. Max length is 255 characters. | +| `deployEndTime` | `string` | Output only. Time at which the `Rollout` finished deploying. | | `phases` | `array` | Output only. The phases that represent the workflows of this `Rollout`. | +| `failureReason` | `string` | Output only. Additional information about the rollout failure, if available. | +| `controllerRollout` | `string` | Output only. Name of the `ControllerRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. | +| `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | | `labels` | `object` | Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | | `approveTime` | `string` | Output only. Time at which the `Rollout` was approved. | -| `state` | `string` | Output only. Current state of the `Rollout`. | -| `targetId` | `string` | Required. The ID of Target to which this `Rollout` is deploying. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | | `uid` | `string` | Output only. Unique identifier of the `Rollout`. | -| `metadata` | `object` | Metadata includes information associated with a `Rollout`. | -| `failureReason` | `string` | Output only. Additional information about the rollout failure, if available. | -| `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | -| `enqueueTime` | `string` | Output only. Time at which the `Rollout` was enqueued. | -| `controllerRollout` | `string` | Output only. Name of the `ControllerRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. | +| `state` | `string` | Output only. Current state of the `Rollout`. | +| `deployFailureCause` | `string` | Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress. | | `deployStartTime` | `string` | Output only. Time at which the `Rollout` started deploying. | +| `targetId` | `string` | Required. The ID of Target to which this `Rollout` is deploying. | +| `deployingBuild` | `string` | Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`. | | `createTime` | `string` | Output only. Time at which the `Rollout` was created. | -| `deployFailureCause` | `string` | Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress. | -| `deployEndTime` | `string` | Output only. Time at which the `Rollout` finished deploying. | +| `enqueueTime` | `string` | Output only. Time at which the `Rollout` was enqueued. | | `approvalState` | `string` | Output only. Approval state of the `Rollout`. | -| `deployingBuild` | `string` | Output only. The resource name of the Cloud Build `Build` object that is used to deploy the Rollout. Format is `projects/{project}/locations/{location}/builds/{build}`. | +| `metadata` | `object` | Metadata includes information associated with a `Rollout`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/targets/index.md b/docs/google-docs/providers/google/clouddeploy/targets/index.md index 0c6e349769..e515827b20 100644 --- a/docs/google-docs/providers/google/clouddeploy/targets/index.md +++ b/docs/google-docs/providers/google/clouddeploy/targets/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Optional. Name of the `Target`. Format is projects/{project}/locations/{location}/targets/a-z{0,62}. | | `description` | `string` | Optional. Description of the `Target`. Max length is 255 characters. | -| `annotations` | `object` | Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | -| `createTime` | `string` | Output only. Time at which the `Target` was created. | -| `run` | `object` | Information specifying where to deploy a Cloud Run Service. | +| `deployParameters` | `object` | Optional. The deploy parameters to use for this target. | | `labels` | `object` | Optional. Labels are attributes that can be set and used by both the user and by Cloud Deploy. Labels must meet the following constraints: * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. * All characters must use UTF-8 encoding, and international characters are allowed. * Keys must start with a lowercase letter or international character. * Each resource is limited to a maximum of 64 labels. Both keys and values are additionally constrained to be <= 128 bytes. | -| `multiTarget` | `object` | Information specifying a multiTarget. | -| `anthosCluster` | `object` | Information specifying an Anthos Cluster. | -| `targetId` | `string` | Output only. Resource id of the `Target`. | +| `updateTime` | `string` | Output only. Most recent time at which the `Target` was updated. | | `uid` | `string` | Output only. Unique identifier of the `Target`. | | `requireApproval` | `boolean` | Optional. Whether or not the `Target` requires approval. | -| `etag` | `string` | Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `executionConfigs` | `array` | Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`. | -| `updateTime` | `string` | Output only. Most recent time at which the `Target` was updated. | +| `run` | `object` | Information specifying where to deploy a Cloud Run Service. | | `gke` | `object` | Information specifying a GKE Cluster. | -| `deployParameters` | `object` | Optional. The deploy parameters to use for this target. | +| `executionConfigs` | `array` | Configurations for all execution that relates to this `Target`. Each `ExecutionEnvironmentUsage` value may only be used in a single configuration; using the same value multiple times is an error. When one or more configurations are specified, they must include the `RENDER` and `DEPLOY` `ExecutionEnvironmentUsage` values. When no configurations are specified, execution will use the default specified in `DefaultPool`. | +| `anthosCluster` | `object` | Information specifying an Anthos Cluster. | +| `multiTarget` | `object` | Information specifying a multiTarget. | +| `createTime` | `string` | Output only. Time at which the `Target` was created. | +| `annotations` | `object` | Optional. User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | +| `targetId` | `string` | Output only. Resource id of the `Target`. | +| `etag` | `string` | Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/targets_iam_audit_configs/index.md b/docs/google-docs/providers/google/clouddeploy/targets_iam_audit_configs/index.md deleted file mode 100644 index 0713a43e4b..0000000000 --- a/docs/google-docs/providers/google/clouddeploy/targets_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: targets_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - targets_iam_audit_configs - - clouddeploy - - 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 ---- - - - -## Overview - - - - -
Nametargets_iam_audit_configs
TypeResource
Idgoogle.clouddeploy.targets_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_targets_getIamPolicy` | `SELECT` | `locationsId, projectsId, targetsId` | diff --git a/docs/google-docs/providers/google/clouddeploy/targets_iam_bindings/index.md b/docs/google-docs/providers/google/clouddeploy/targets_iam_bindings/index.md deleted file mode 100644 index 3d0cd75285..0000000000 --- a/docs/google-docs/providers/google/clouddeploy/targets_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: targets_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - targets_iam_bindings - - clouddeploy - - 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 ---- - - - -## Overview - - - - -
Nametargets_iam_bindings
TypeResource
Idgoogle.clouddeploy.targets_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_targets_getIamPolicy` | `SELECT` | `locationsId, projectsId, targetsId` | diff --git a/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md b/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md index 7b7c9ee0d5..ab200ec18b 100644 --- a/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md +++ b/docs/google-docs/providers/google/clouddeploy/targets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouderrorreporting/events/index.md b/docs/google-docs/providers/google/clouderrorreporting/events/index.md index 16723f6269..1e24c9d1f9 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/events/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/events/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `eventTime` | `string` | Time when the event occurred as provided in the error report. If the report did not contain a timestamp, the time the error was received by the Error Reporting system is used. | | `message` | `string` | The stack trace that was reported or logged by the service. | | `serviceContext` | `object` | Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel. | | `context` | `object` | A description of the context in which an error occurred. This data should be provided by the application when reporting an error, unless the error report has been generated automatically from Google App Engine logs. | -| `eventTime` | `string` | Time when the event occurred as provided in the error report. If the report did not contain a timestamp, the time the error was received by the Error Reporting system is used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md b/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md index 8a345b3b73..f2e710f56e 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/group_stats/index.md @@ -27,15 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `count` | `string` | Approximate total number of events in the given group that match the filter criteria. | -| `affectedUsersCount` | `string` | Approximate number of affected users in the given group that match the filter criteria. Users are distinguished by data in the ErrorContext of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here. | | `representative` | `object` | An error event which is returned by the Error Reporting system. | -| `timedCounts` | `array` | Approximate number of occurrences over time. Timed counts returned by ListGroups are guaranteed to be: - Inside the requested time interval - Non-overlapping, and - Ordered by ascending time. | -| `group` | `object` | Description of a group of similar error events. | -| `lastSeenTime` | `string` | Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. | +| `numAffectedServices` | `integer` | The total number of services with a non-zero error count for the given filter criteria. | | `affectedServices` | `array` | Service contexts with a non-zero error count for the given filter criteria. This list can be truncated if multiple services are affected. Refer to `num_affected_services` for the total count. | +| `count` | `string` | Approximate total number of events in the given group that match the filter criteria. | +| `lastSeenTime` | `string` | Approximate last occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. | +| `timedCounts` | `array` | Approximate number of occurrences over time. Timed counts returned by ListGroups are guaranteed to be: - Inside the requested time interval - Non-overlapping, and - Ordered by ascending time. | +| `affectedUsersCount` | `string` | Approximate number of affected users in the given group that match the filter criteria. Users are distinguished by data in the ErrorContext of the individual error events, such as their login name or their remote IP address in case of HTTP requests. The number of affected users can be zero even if the number of errors is non-zero if no data was provided from which the affected user could be deduced. Users are counted based on data in the request context that was provided in the error report. If more users are implicitly affected, such as due to a crash of the whole service, this is not reflected here. | | `firstSeenTime` | `string` | Approximate first occurrence that was ever seen for this group and which matches the given filter criteria, ignoring the time_range that was specified in the request. | -| `numAffectedServices` | `integer` | The total number of services with a non-zero error count for the given filter criteria. | +| `group` | `object` | Description of a group of similar error events. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/clouderrorreporting/groups/index.md b/docs/google-docs/providers/google/clouderrorreporting/groups/index.md index 5d8d9add1e..7e38bda892 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/groups/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/groups/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The group resource name. Written as `projects/{projectID}/groups/{group_id}`. Example: `projects/my-project-123/groups/my-group` In the group resource name, the `group_id` is a unique identifier for a particular error group. The identifier is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see [Google Cloud Privacy Notice](https://cloud.google.com/terms/cloud-privacy-notice). | -| `groupId` | `string` | Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID. | | `resolutionStatus` | `string` | Error group's resolution status. An unspecified resolution status will be interpreted as OPEN | | `trackingIssues` | `array` | Associated tracking issues. | +| `groupId` | `string` | Group IDs are unique for a given project. If the same kind of error occurs in different service contexts, it will receive the same group ID. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouderrorreporting/projects_events/index.md b/docs/google-docs/providers/google/clouderrorreporting/projects_events/index.md deleted file mode 100644 index 392bca6f55..0000000000 --- a/docs/google-docs/providers/google/clouderrorreporting/projects_events/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: projects_events -hide_title: false -hide_table_of_contents: false -keywords: - - projects_events - - clouderrorreporting - - 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 ---- - - - -## Overview - - - - -
Nameprojects_events
TypeResource
Idgoogle.clouderrorreporting.projects_events
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_deleteEvents` | `DELETE` | `projectsId` | diff --git a/docs/google-docs/providers/google/cloudfunctions/functions/index.md b/docs/google-docs/providers/google/cloudfunctions/functions/index.md index 30c4c90a24..d3fd8fdd94 100644 --- a/docs/google-docs/providers/google/cloudfunctions/functions/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/functions/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*` | | `description` | `string` | User-provided description of a function. | | `kmsKeyName` | `string` | [Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. | -| `environment` | `string` | Describe whether the function is 1st Gen or 2nd Gen. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | | `serviceConfig` | `object` | Describes the Service being deployed. Currently Supported : Cloud Run (fully managed). | -| `state` | `string` | Output only. State of the function. | -| `buildConfig` | `object` | Describes the Build step of the function that builds a container from the given source. | +| `eventTrigger` | `object` | Describes EventTrigger, used to request events to be sent from another service. | | `labels` | `object` | Labels associated with this Cloud Function. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `buildConfig` | `object` | Describes the Build step of the function that builds a container from the given source. | +| `stateMessages` | `array` | Output only. State Messages for this Cloud Function. | | `url` | `string` | Output only. The deployed url for the function. | -| `eventTrigger` | `object` | Describes EventTrigger, used to request events to be sent from another service. | +| `environment` | `string` | Describe whether the function is 1st Gen or 2nd Gen. | +| `state` | `string` | Output only. State of the function. | | `updateTime` | `string` | Output only. The last update timestamp of a Cloud Function. | -| `stateMessages` | `array` | Output only. State Messages for this Cloud Function. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudfunctions/functions_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudfunctions/functions_iam_audit_configs/index.md deleted file mode 100644 index d705144fe5..0000000000 --- a/docs/google-docs/providers/google/cloudfunctions/functions_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: functions_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - functions_iam_audit_configs - - cloudfunctions - - 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 ---- - - - -## Overview - - - - -
Namefunctions_iam_audit_configs
TypeResource
Idgoogle.cloudfunctions.functions_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_functions_getIamPolicy` | `SELECT` | `functionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudfunctions/functions_iam_bindings/index.md b/docs/google-docs/providers/google/cloudfunctions/functions_iam_bindings/index.md deleted file mode 100644 index 040e3d5166..0000000000 --- a/docs/google-docs/providers/google/cloudfunctions/functions_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: functions_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - functions_iam_bindings - - cloudfunctions - - 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 ---- - - - -## Overview - - - - -
Namefunctions_iam_bindings
TypeResource
Idgoogle.cloudfunctions.functions_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_functions_getIamPolicy` | `SELECT` | `functionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md b/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md index 23eaaf89a0..d539f2d9ea 100644 --- a/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/functions_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudfunctions/operations/index.md b/docs/google-docs/providers/google/cloudfunctions/operations/index.md index 8cbb4d9b6e..03518f286f 100644 --- a/docs/google-docs/providers/google/cloudfunctions/operations/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/client_states/index.md b/docs/google-docs/providers/google/cloudidentity/client_states/index.md index 7252638d73..6b7a6a6f17 100644 --- a/docs/google-docs/providers/google/cloudidentity/client_states/index.md +++ b/docs/google-docs/providers/google/cloudidentity/client_states/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device}/deviceUsers/{device_user}/clientState/{partner}`, where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: `{customer}-suffix`, where `customer` is your customer ID. The *suffix* is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: `GET https://www.googleapis.com/admin/directory/v1/customers/my_customer` The `id` field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C') | -| `createTime` | `string` | Output only. The time the client state data was created. | | `managed` | `string` | The management state of the resource as specified by the API client. | -| `lastUpdateTime` | `string` | Output only. The time the client state data was last updated. | -| `ownerType` | `string` | Output only. The owner of the ClientState | | `scoreReason` | `string` | A descriptive cause of the health score. | -| `healthScore` | `string` | The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies. | -| `keyValuePairs` | `object` | The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map. | +| `ownerType` | `string` | Output only. The owner of the ClientState | +| `complianceState` | `string` | The compliance state of the resource as specified by the API client. | | `customId` | `string` | This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. | +| `healthScore` | `string` | The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies. | | `assetTags` | `array` | The caller can specify asset tags for this resource | -| `complianceState` | `string` | The compliance state of the resource as specified by the API client. | +| `createTime` | `string` | Output only. The time the client state data was created. | +| `lastUpdateTime` | `string` | Output only. The time the client state data was last updated. | | `etag` | `string` | The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest | +| `keyValuePairs` | `object` | The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/device_users/index.md b/docs/google-docs/providers/google/cloudidentity/device_users/index.md index e98b654969..d3cb3bd3a3 100644 --- a/docs/google-docs/providers/google/cloudidentity/device_users/index.md +++ b/docs/google-docs/providers/google/cloudidentity/device_users/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device}/deviceUsers/{device_user}`, where `device_user` uniquely identifies a user's use of a device. | -| `createTime` | `string` | When the user first signed in to the device | | `compromisedState` | `string` | Compromised State of the DeviceUser object | -| `managementState` | `string` | Output only. Management state of the user on the device. | | `userAgent` | `string` | Output only. User agent on the device for this specific user | | `userEmail` | `string` | Email address of the user registered on the device. | | `languageCode` | `string` | Output only. Default locale used on device, in IETF BCP-47 format. | | `lastSyncTime` | `string` | Output only. Last time when user synced with policies. | | `firstSyncTime` | `string` | Output only. Most recent time when user registered with this service. | +| `managementState` | `string` | Output only. Management state of the user on the device. | | `passwordState` | `string` | Password state of the DeviceUser object | +| `createTime` | `string` | When the user first signed in to the device | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/devices/index.md b/docs/google-docs/providers/google/cloudidentity/devices/index.md index 4c43ed5f35..33e53bbdf8 100644 --- a/docs/google-docs/providers/google/cloudidentity/devices/index.md +++ b/docs/google-docs/providers/google/cloudidentity/devices/index.md @@ -28,35 +28,35 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device}`, where device is the unique id assigned to the Device. | -| `deviceId` | `string` | Unique identifier for the device. | -| `wifiMacAddresses` | `array` | WiFi MAC addresses of device. | -| `hostname` | `string` | Host name of the device. | -| `securityPatchTime` | `string` | Output only. OS security patch update time on device. | -| `manufacturer` | `string` | Output only. Device manufacturer. Example: Motorola. | +| `createTime` | `string` | Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. | | `imei` | `string` | Output only. IMEI number of device if GSM device; empty otherwise. | +| `enabledUsbDebugging` | `boolean` | Output only. Whether USB debugging is enabled on device. | +| `manufacturer` | `string` | Output only. Device manufacturer. Example: Motorola. | +| `securityPatchTime` | `string` | Output only. OS security patch update time on device. | | `meid` | `string` | Output only. MEID number of device if CDMA device; empty otherwise. | -| `kernelVersion` | `string` | Output only. Kernel version of the device. | -| `lastSyncTime` | `string` | Most recent time when device synced with this service. | -| `brand` | `string` | Output only. Device brand. Example: Samsung. | -| `releaseVersion` | `string` | Output only. OS release version. Example: 6.0. | -| `serialNumber` | `string` | Serial Number of device. Example: HT82V1A01076. | -| `buildNumber` | `string` | Output only. Build number of the device. | +| `encryptionState` | `string` | Output only. Device encryption state. | | `deviceType` | `string` | Output only. Type of device. | -| `enabledUsbDebugging` | `boolean` | Output only. Whether USB debugging is enabled on device. | -| `managementState` | `string` | Output only. Management state of the device | -| `basebandVersion` | `string` | Output only. Baseband version of the device. | -| `assetTag` | `string` | Asset tag of the device. | -| `compromisedState` | `string` | Output only. Represents whether the Device is compromised. | -| `ownerType` | `string` | Output only. Whether the device is owned by the company or an individual | -| `createTime` | `string` | Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. | +| `hostname` | `string` | Host name of the device. | +| `kernelVersion` | `string` | Output only. Kernel version of the device. | | `osVersion` | `string` | Output only. OS version of the device. Example: Android 8.1.0. | | `otherAccounts` | `array` | Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if \|ownership_privilege\| is \|PROFILE_OWNER\| or \|DEVICE_OWNER\|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com". | -| `encryptionState` | `string` | Output only. Device encryption state. | -| `bootloaderVersion` | `string` | Output only. Device bootloader version. Example: 0.6.7. | +| `buildNumber` | `string` | Output only. Build number of the device. | +| `ownerType` | `string` | Output only. Whether the device is owned by the company or an individual | +| `compromisedState` | `string` | Output only. Represents whether the Device is compromised. | +| `assetTag` | `string` | Asset tag of the device. | +| `deviceId` | `string` | Unique identifier for the device. | +| `model` | `string` | Output only. Model name of device. Example: Pixel 3. | +| `lastSyncTime` | `string` | Most recent time when device synced with this service. | | `androidSpecificAttributes` | `object` | Resource representing the Android specific attributes of a Device. | -| `enabledDeveloperOptions` | `boolean` | Output only. Whether developer options is enabled on device. | +| `releaseVersion` | `string` | Output only. OS release version. Example: 6.0. | +| `bootloaderVersion` | `string` | Output only. Device bootloader version. Example: 0.6.7. | | `networkOperator` | `string` | Output only. Mobile or network operator of device, if available. | -| `model` | `string` | Output only. Model name of device. Example: Pixel 3. | +| `enabledDeveloperOptions` | `boolean` | Output only. Whether developer options is enabled on device. | +| `wifiMacAddresses` | `array` | WiFi MAC addresses of device. | +| `managementState` | `string` | Output only. Management state of the device | +| `brand` | `string` | Output only. Device brand. Example: Samsung. | +| `serialNumber` | `string` | Serial Number of device. Example: HT82V1A01076. | +| `basebandVersion` | `string` | Output only. Baseband version of the device. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/groups/index.md b/docs/google-docs/providers/google/cloudidentity/groups/index.md index ce9e5e2fc9..cf21a04c99 100644 --- a/docs/google-docs/providers/google/cloudidentity/groups/index.md +++ b/docs/google-docs/providers/google/cloudidentity/groups/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Group`. Shall be of the form `groups/{group}`. | | `description` | `string` | An extended description to help users determine the purpose of a `Group`. Must not be longer than 4,096 characters. | -| `labels` | `object` | Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. | -| `dynamicGroupMetadata` | `object` | Dynamic group metadata like queries and status. | +| `additionalGroupKeys` | `array` | Output only. Additional group keys associated with the Group. | +| `updateTime` | `string` | Output only. The time when the `Group` was last updated. | | `groupKey` | `object` | A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. | +| `dynamicGroupMetadata` | `object` | Dynamic group metadata like queries and status. | | `parent` | `string` | Required. Immutable. The resource name of the entity under which this `Group` resides in the Cloud Identity resource hierarchy. Must be of the form `identitysources/{identity_source}` for external [identity-mapped groups](https://support.google.com/a/answer/9039510) or `customers/{customer_id}` for Google Groups. The `customer_id` must begin with "C" (for example, 'C046psxkn'). [Find your customer ID.] (https://support.google.com/cloudidentity/answer/10070793) | +| `labels` | `object` | Required. One or more label entries that apply to the Group. Currently supported labels contain a key with an empty value. Google Groups are the default type of group and have a label with a key of `cloudidentity.googleapis.com/groups.discussion_forum` and an empty value. Existing Google Groups can have an additional label with a key of `cloudidentity.googleapis.com/groups.security` and an empty value added to them. **This is an immutable change and the security label cannot be removed once added.** Dynamic groups have a label with a key of `cloudidentity.googleapis.com/groups.dynamic`. Identity-mapped groups for Cloud Search have a label with a key of `system/groups/external` and an empty value. | | `createTime` | `string` | Output only. The time when the `Group` was created. | -| `additionalGroupKeys` | `array` | Output only. Additional group keys associated with the Group. | | `displayName` | `string` | The display name of the `Group`. | -| `updateTime` | `string` | Output only. The time when the `Group` was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md b/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md index c4e204173e..fa17d26219 100644 --- a/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md +++ b/docs/google-docs/providers/google/cloudidentity/inbound_saml_sso_profiles/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the SAML SSO profile. | -| `spConfig` | `object` | SAML SP (service provider) configuration. | | `customer` | `string` | Immutable. The customer. For example: `customers/C0123abc`. | | `displayName` | `string` | Human-readable name of the SAML SSO profile. | | `idpConfig` | `object` | SAML IDP (identity provider) configuration. | +| `spConfig` | `object` | SAML SP (service provider) configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md b/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md index b01d512279..394abdb150 100644 --- a/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md +++ b/docs/google-docs/providers/google/cloudidentity/inbound_sso_assignments/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment. | +| `rank` | `integer` | Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set. | +| `samlSsoInfo` | `object` | Details that are applicable when `sso_mode` == `SAML_SSO`. | +| `signInBehavior` | `object` | Controls sign-in behavior. | | `ssoMode` | `string` | Inbound SSO behavior. | | `targetGroup` | `string` | Immutable. Must be of the form `groups/{group}`. | | `targetOrgUnit` | `string` | Immutable. Must be of the form `orgUnits/{org_unit}`. | | `customer` | `string` | Immutable. The customer. For example: `customers/C0123abc`. | -| `rank` | `integer` | Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set. | -| `samlSsoInfo` | `object` | Details that are applicable when `sso_mode` == `SAML_SSO`. | -| `signInBehavior` | `object` | Controls sign-in behavior. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/memberships/index.md b/docs/google-docs/providers/google/cloudidentity/memberships/index.md index 21452ca687..640b2eeb6d 100644 --- a/docs/google-docs/providers/google/cloudidentity/memberships/index.md +++ b/docs/google-docs/providers/google/cloudidentity/memberships/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The [resource name](https://cloud.google.com/apis/design/resource_names) of the `Membership`. Shall be of the form `groups/{group}/memberships/{membership}`. | +| `roles` | `array` | The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`. | | `type` | `string` | Output only. The type of the membership. | | `updateTime` | `string` | Output only. The time when the `Membership` was last updated. | | `createTime` | `string` | Output only. The time when the `Membership` was created. | | `deliverySetting` | `string` | Output only. Delivery setting associated with the membership. | | `preferredMemberKey` | `object` | A unique identifier for an entity in the Cloud Identity Groups API. An entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s. | -| `roles` | `array` | The `MembershipRole`s that apply to the `Membership`. If unspecified, defaults to a single `MembershipRole` with `name` `MEMBER`. Must not contain duplicate `MembershipRole`s with the same `name`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md b/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md index 3fc753e214..f72f368e23 100644 --- a/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md +++ b/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Shall be of the form `customers/{customer}/userinvitations/{user_email_address}`. | -| `state` | `string` | State of the `UserInvitation`. | | `updateTime` | `string` | Time when the `UserInvitation` was last updated. | | `mailsSentCount` | `string` | Number of invitation emails sent to the user. | +| `state` | `string` | State of the `UserInvitation`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudiot/config_versions/index.md b/docs/google-docs/providers/google/cloudiot/config_versions/index.md deleted file mode 100644 index d744b6aba1..0000000000 --- a/docs/google-docs/providers/google/cloudiot/config_versions/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: config_versions -hide_title: false -hide_table_of_contents: false -keywords: - - config_versions - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Nameconfig_versions
TypeResource
Idgoogle.cloudiot.config_versions
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `deviceAckTime` | `string` | [Output only] The time at which Cloud IoT Core received the acknowledgment from the device, indicating that the device has received this configuration version. If this field is not present, the device has not yet acknowledged that it received this version. Note that when the config was sent to the device, many config versions may have been available in Cloud IoT Core while the device was disconnected, and on connection, only the latest version is sent to the device. Some versions may never be sent to the device, and therefore are never acknowledged. This timestamp is set by Cloud IoT Core. | -| `version` | `string` | [Output only] The version of this update. The version number is assigned by the server, and is always greater than 0 after device creation. The version must be 0 on the `CreateDevice` request if a `config` is specified; the response of `CreateDevice` will always have a value of 1. | -| `binaryData` | `string` | The device configuration data. | -| `cloudUpdateTime` | `string` | [Output only] The time at which this configuration version was updated in Cloud IoT Core. This timestamp is set by the server. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_registries_devices_configVersions_list` | `SELECT` | `devicesId, locationsId, projectsId, registriesId` | diff --git a/docs/google-docs/providers/google/cloudiot/devices/index.md b/docs/google-docs/providers/google/cloudiot/devices/index.md deleted file mode 100644 index 98f958db32..0000000000 --- a/docs/google-docs/providers/google/cloudiot/devices/index.md +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: devices -hide_title: false -hide_table_of_contents: false -keywords: - - devices - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Namedevices
TypeResource
Idgoogle.cloudiot.devices
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | The user-defined device identifier. The device ID must be unique within a device registry. | -| `name` | `string` | The resource path name. For example, `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`. When `name` is populated as a response from the service, it always ends in the device numeric ID. | -| `lastConfigSendTime` | `string` | [Output only] The last time a cloud-to-device config version was sent to the device. | -| `lastConfigAckTime` | `string` | [Output only] The last time a cloud-to-device config version acknowledgment was received from the device. This field is only for configurations sent through MQTT. | -| `credentials` | `array` | The credentials used to authenticate this device. To allow credential rotation without interruption, multiple device credentials can be bound to this device. No more than 3 credentials can be bound to a single device at a time. When new credentials are added to a device, they are verified against the registry credentials. For details, see the description of the `DeviceRegistry.credentials` field. | -| `lastEventTime` | `string` | [Output only] The last time a telemetry event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. | -| `gatewayConfig` | `object` | Gateway-related configuration and state. | -| `lastStateTime` | `string` | [Output only] The last time a state event was received. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. | -| `blocked` | `boolean` | If a device is blocked, connections or requests from this device will fail. Can be used to temporarily prevent the device from connecting if, for example, the sensor is generating bad data and needs maintenance. | -| `lastErrorStatus` | `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). | -| `config` | `object` | The device configuration. Eventually delivered to devices. | -| `state` | `object` | The device state, as reported by the device. | -| `lastErrorTime` | `string` | [Output only] The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. This field is the timestamp of 'last_error_status'. | -| `logLevel` | `string` | **Beta Feature** The logging verbosity for device activity. If unspecified, DeviceRegistry.log_level will be used. | -| `metadata` | `object` | The metadata key-value pairs assigned to the device. This metadata is not interpreted or indexed by Cloud IoT Core. It can be used to add contextual information for the device. Keys must conform to the regular expression a-zA-Z+ and be less than 128 bytes in length. Values are free-form strings. Each value must be less than or equal to 32 KB in size. The total size of all keys and values must be less than 256 KB, and the maximum number of key-value pairs is 500. | -| `lastHeartbeatTime` | `string` | [Output only] The last time an MQTT `PINGREQ` was received. This field applies only to devices connecting through MQTT. MQTT clients usually only send `PINGREQ` messages if the connection is idle, and no other messages have been sent. Timestamps are periodically collected and written to storage; they may be stale by a few minutes. | -| `numId` | `string` | [Output only] A server-defined unique numeric ID for the device. This is a more compact way to identify devices, and it is globally unique. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_registries_devices_get` | `SELECT` | `devicesId, locationsId, projectsId, registriesId` | Gets details about a device. | -| `projects_locations_registries_devices_list` | `SELECT` | `locationsId, projectsId, registriesId` | List devices in a device registry. | -| `projects_locations_registries_groups_devices_list` | `SELECT` | `groupsId, locationsId, projectsId, registriesId` | List devices in a device registry. | -| `projects_locations_registries_devices_create` | `INSERT` | `locationsId, projectsId, registriesId` | Creates a device in a device registry. | -| `projects_locations_registries_devices_delete` | `DELETE` | `devicesId, locationsId, projectsId, registriesId` | Deletes a device. | -| `projects_locations_registries_devices_modifyCloudToDeviceConfig` | `EXEC` | `devicesId, locationsId, projectsId, registriesId` | Modifies the configuration for the device, which is eventually sent from the Cloud IoT Core servers. Returns the modified configuration version and its metadata. | -| `projects_locations_registries_devices_patch` | `EXEC` | `devicesId, locationsId, projectsId, registriesId` | Updates a device. | -| `projects_locations_registries_devices_sendCommandToDevice` | `EXEC` | `devicesId, locationsId, projectsId, registriesId` | Sends a command to the specified device. In order for a device to be able to receive commands, it must: 1) be connected to Cloud IoT Core using the MQTT protocol, and 2) be subscribed to the group of MQTT topics specified by /devices/{device-id}/commands/#. This subscription will receive commands at the top-level topic /devices/{device-id}/commands as well as commands for subfolders, like /devices/{device-id}/commands/subfolder. Note that subscribing to specific subfolders is not supported. If the command could not be delivered to the device, this method will return an error; in particular, if the device is not subscribed, this method will return FAILED_PRECONDITION. Otherwise, this method will return OK. If the subscription is QoS 1, at least once delivery will be guaranteed; for QoS 0, no acknowledgment will be expected from the device. | diff --git a/docs/google-docs/providers/google/cloudiot/groups_iam_bindings/index.md b/docs/google-docs/providers/google/cloudiot/groups_iam_bindings/index.md deleted file mode 100644 index 70bbfeaed9..0000000000 --- a/docs/google-docs/providers/google/cloudiot/groups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: groups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - groups_iam_bindings - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Namegroups_iam_bindings
TypeResource
Idgoogle.cloudiot.groups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_registries_groups_getIamPolicy` | `SELECT` | `groupsId, locationsId, projectsId, registriesId` | diff --git a/docs/google-docs/providers/google/cloudiot/groups_iam_policies/index.md b/docs/google-docs/providers/google/cloudiot/groups_iam_policies/index.md deleted file mode 100644 index 1c1173a253..0000000000 --- a/docs/google-docs/providers/google/cloudiot/groups_iam_policies/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: groups_iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - groups_iam_policies - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Namegroups_iam_policies
TypeResource
Idgoogle.cloudiot.groups_iam_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_registries_groups_getIamPolicy` | `SELECT` | `groupsId, locationsId, projectsId, registriesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | -| `projects_locations_registries_groups_setIamPolicy` | `EXEC` | `groupsId, locationsId, projectsId, registriesId` | Sets the access control policy on the specified resource. Replaces any existing policy. | -| `projects_locations_registries_groups_testIamPermissions` | `EXEC` | `groupsId, locationsId, projectsId, registriesId` | 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. | diff --git a/docs/google-docs/providers/google/cloudiot/index.md b/docs/google-docs/providers/google/cloudiot/index.md deleted file mode 100644 index 3578c6a253..0000000000 --- a/docs/google-docs/providers/google/cloudiot/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: cloudiot -hide_title: false -hide_table_of_contents: false -keywords: - - cloudiot - - 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 ---- -Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. - -:::info Service Summary - -
-
-total resources: 8
-total selectable resources: 8
-total methods: 25
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.cloudiot
TypeService
TitleCloud IoT API
DescriptionRegisters and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.
Idcloudiot:v23.05.00145
- -## Resources -
-
-config_versions
-devices
-groups_iam_bindings
-groups_iam_policies
-
-
-registries
-registries_iam_bindings
-registries_iam_policies
-states
-
-
diff --git a/docs/google-docs/providers/google/cloudiot/registries/index.md b/docs/google-docs/providers/google/cloudiot/registries/index.md deleted file mode 100644 index e93e8f98cf..0000000000 --- a/docs/google-docs/providers/google/cloudiot/registries/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: registries -hide_title: false -hide_table_of_contents: false -keywords: - - registries - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Nameregistries
TypeResource
Idgoogle.cloudiot.registries
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | The identifier of this device registry. For example, `myRegistry`. | -| `name` | `string` | The resource path name. For example, `projects/example-project/locations/us-central1/registries/my-registry`. | -| `httpConfig` | `object` | The configuration of the HTTP bridge for a device registry. | -| `logLevel` | `string` | **Beta Feature** The default logging verbosity for activity from devices in this registry. The verbosity level can be overridden by Device.log_level. | -| `mqttConfig` | `object` | The configuration of MQTT for a device registry. | -| `stateNotificationConfig` | `object` | The configuration for notification of new states received from the device. | -| `credentials` | `array` | The credentials used to verify the device credentials. No more than 10 credentials can be bound to a single registry at a time. The verification process occurs at the time of device creation or update. If this field is empty, no verification is performed. Otherwise, the credentials of a newly created device or added credentials of an updated device should be signed with one of these registry credentials. Note, however, that existing devices will never be affected by modifications to this list of credentials: after a device has been successfully created in a registry, it should be able to connect even if its registry credentials are revoked, deleted, or modified. | -| `eventNotificationConfigs` | `array` | The configuration for notification of telemetry events received from the device. All telemetry events that were successfully published by the device and acknowledged by Cloud IoT Core are guaranteed to be delivered to Cloud Pub/Sub. If multiple configurations match a message, only the first matching configuration is used. If you try to publish a device telemetry event using MQTT without specifying a Cloud Pub/Sub topic for the device's registry, the connection closes automatically. If you try to do so using an HTTP connection, an error is returned. Up to 10 configurations may be provided. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_registries_get` | `SELECT` | `locationsId, projectsId, registriesId` | Gets a device registry configuration. | -| `projects_locations_registries_list` | `SELECT` | `locationsId, projectsId` | Lists device registries. | -| `projects_locations_registries_create` | `INSERT` | `locationsId, projectsId` | Creates a device registry that contains devices. | -| `projects_locations_registries_delete` | `DELETE` | `locationsId, projectsId, registriesId` | Deletes a device registry configuration. | -| `projects_locations_registries_bindDeviceToGateway` | `EXEC` | `locationsId, projectsId, registriesId` | Associates the device with the gateway. | -| `projects_locations_registries_patch` | `EXEC` | `locationsId, projectsId, registriesId` | Updates a device registry configuration. | -| `projects_locations_registries_unbindDeviceFromGateway` | `EXEC` | `locationsId, projectsId, registriesId` | Deletes the association between the device and the gateway. | diff --git a/docs/google-docs/providers/google/cloudiot/registries_iam_bindings/index.md b/docs/google-docs/providers/google/cloudiot/registries_iam_bindings/index.md deleted file mode 100644 index 21c3406981..0000000000 --- a/docs/google-docs/providers/google/cloudiot/registries_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: registries_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - registries_iam_bindings - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Nameregistries_iam_bindings
TypeResource
Idgoogle.cloudiot.registries_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_registries_getIamPolicy` | `SELECT` | `locationsId, projectsId, registriesId` | diff --git a/docs/google-docs/providers/google/cloudiot/registries_iam_policies/index.md b/docs/google-docs/providers/google/cloudiot/registries_iam_policies/index.md deleted file mode 100644 index 516a5f18ed..0000000000 --- a/docs/google-docs/providers/google/cloudiot/registries_iam_policies/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: registries_iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - registries_iam_policies - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Nameregistries_iam_policies
TypeResource
Idgoogle.cloudiot.registries_iam_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_registries_getIamPolicy` | `SELECT` | `locationsId, projectsId, registriesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | -| `projects_locations_registries_setIamPolicy` | `EXEC` | `locationsId, projectsId, registriesId` | Sets the access control policy on the specified resource. Replaces any existing policy. | -| `projects_locations_registries_testIamPermissions` | `EXEC` | `locationsId, projectsId, registriesId` | 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. | diff --git a/docs/google-docs/providers/google/cloudiot/states/index.md b/docs/google-docs/providers/google/cloudiot/states/index.md deleted file mode 100644 index 30f1c83436..0000000000 --- a/docs/google-docs/providers/google/cloudiot/states/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: states -hide_title: false -hide_table_of_contents: false -keywords: - - states - - cloudiot - - 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 ---- - - - -## Overview - - - - -
Namestates
TypeResource
Idgoogle.cloudiot.states
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `binaryData` | `string` | The device state data. | -| `updateTime` | `string` | [Output only] The time at which this state version was updated in Cloud IoT Core. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_registries_devices_states_list` | `SELECT` | `devicesId, locationsId, projectsId, registriesId` | diff --git a/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md b/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md index 3b59f45c8c..bf8c0c8179 100644 --- a/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md +++ b/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md @@ -28,21 +28,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this CryptoKeyVersion in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`. | -| `importJob` | `string` | Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. | -| `destroyTime` | `string` | Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. | +| `attestation` | `object` | Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). | | `externalDestructionFailureReason` | `string` | Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. | | `algorithm` | `string` | Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. | -| `destroyEventTime` | `string` | Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. | -| `generationFailureReason` | `string` | Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. | -| `createTime` | `string` | Output only. The time at which this CryptoKeyVersion was created. | -| `externalProtectionLevelOptions` | `object` | ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. | -| `state` | `string` | The current state of the CryptoKeyVersion. | | `importFailureReason` | `string` | Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. | -| `importTime` | `string` | Output only. The time at which this CryptoKeyVersion's key material was most recently imported. | -| `attestation` | `object` | Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). | -| `generateTime` | `string` | Output only. The time this CryptoKeyVersion's key material was generated. | | `reimportEligible` | `boolean` | Output only. Whether or not this key version is eligible for reimport, by being specified as a target in ImportCryptoKeyVersionRequest.crypto_key_version. | +| `importTime` | `string` | Output only. The time at which this CryptoKeyVersion's key material was most recently imported. | +| `state` | `string` | The current state of the CryptoKeyVersion. | | `protectionLevel` | `string` | Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. | +| `externalProtectionLevelOptions` | `object` | ExternalProtectionLevelOptions stores a group of additional fields for configuring a CryptoKeyVersion that are specific to the EXTERNAL protection level and EXTERNAL_VPC protection levels. | +| `generateTime` | `string` | Output only. The time this CryptoKeyVersion's key material was generated. | +| `generationFailureReason` | `string` | Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. | +| `createTime` | `string` | Output only. The time at which this CryptoKeyVersion was created. | +| `destroyEventTime` | `string` | Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. | +| `destroyTime` | `string` | Output only. The time this CryptoKeyVersion's key material is scheduled for destruction. Only present if state is DESTROY_SCHEDULED. | +| `importJob` | `string` | Output only. The name of the ImportJob used in the most recent import of this CryptoKeyVersion. Only present if the underlying key material was imported. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md b/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md index 8eea8b229b..6c875a5741 100644 --- a/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md +++ b/docs/google-docs/providers/google/cloudkms/crypto_key_versions_public_key/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the CryptoKeyVersion public key. Provided here for verification. NOTE: This field is in Beta. | +| `algorithm` | `string` | The Algorithm associated with this key. | | `pem` | `string` | The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info] (https://tools.ietf.org/html/rfc7468#section-13). | | `pemCrc32c` | `string` | Integrity verification field. A CRC32C checksum of the returned PublicKey.pem. An integrity check of PublicKey.pem can be performed by computing the CRC32C checksum of PublicKey.pem and comparing your results to this field. Discard the response in case of non-matching checksum values, and perform a limited number of retries. A persistent mismatch may indicate an issue in your computation of the CRC32C checksum. Note: This field is defined as int64 for reasons of compatibility across different languages. However, it is a non-negative integer, which will never exceed 2^32-1, and can be safely downconverted to uint32 in languages that support this type. NOTE: This field is in Beta. | | `protectionLevel` | `string` | The ProtectionLevel of the CryptoKeyVersion public key. | -| `algorithm` | `string` | The Algorithm associated with this key. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md b/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md index f5293163c5..aa154c31e1 100644 --- a/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md +++ b/docs/google-docs/providers/google/cloudkms/crypto_keys/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | -| `destroyScheduledDuration` | `string` | Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. | -| `rotationPeriod` | `string` | next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | -| `versionTemplate` | `object` | A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. | -| `labels` | `object` | Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). | -| `cryptoKeyBackend` | `string` | Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. | | `primary` | `object` | A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS. | | `createTime` | `string` | Output only. The time at which this CryptoKey was created. | -| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | +| `labels` | `object` | Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). | +| `versionTemplate` | `object` | A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. | +| `destroyScheduledDuration` | `string` | Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. | +| `cryptoKeyBackend` | `string` | Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. | | `nextRotationTime` | `string` | At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | | `purpose` | `string` | Immutable. The immutable purpose of this CryptoKey. | +| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | +| `rotationPeriod` | `string` | next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_audit_configs/index.md deleted file mode 100644 index 96f7b9a00b..0000000000 --- a/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: crypto_keys_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - crypto_keys_iam_audit_configs - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Namecrypto_keys_iam_audit_configs
TypeResource
Idgoogle.cloudkms.crypto_keys_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_keyRings_cryptoKeys_getIamPolicy` | `SELECT` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_bindings/index.md b/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_bindings/index.md deleted file mode 100644 index c05bba29f1..0000000000 --- a/docs/google-docs/providers/google/cloudkms/crypto_keys_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: crypto_keys_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - crypto_keys_iam_bindings - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Namecrypto_keys_iam_bindings
TypeResource
Idgoogle.cloudkms.crypto_keys_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_keyRings_cryptoKeys_getIamPolicy` | `SELECT` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/ekm_config_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudkms/ekm_config_iam_audit_configs/index.md deleted file mode 100644 index adf72238c9..0000000000 --- a/docs/google-docs/providers/google/cloudkms/ekm_config_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ekm_config_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - ekm_config_iam_audit_configs - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Nameekm_config_iam_audit_configs
TypeResource
Idgoogle.cloudkms.ekm_config_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_ekmConfig_getIamPolicy` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/ekm_config_iam_bindings/index.md b/docs/google-docs/providers/google/cloudkms/ekm_config_iam_bindings/index.md deleted file mode 100644 index f4dc974874..0000000000 --- a/docs/google-docs/providers/google/cloudkms/ekm_config_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ekm_config_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - ekm_config_iam_bindings - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Nameekm_config_iam_bindings
TypeResource
Idgoogle.cloudkms.ekm_config_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_ekmConfig_getIamPolicy` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md b/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md index 96b8127b6d..7dd2e41a96 100644 --- a/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md +++ b/docs/google-docs/providers/google/cloudkms/ekm_connections/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for the EkmConnection in the format `projects/*/locations/*/ekmConnections/*`. | -| `keyManagementMode` | `string` | Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. | -| `serviceResolvers` | `array` | A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. | | `createTime` | `string` | Output only. The time at which the EkmConnection was created. | | `cryptoSpacePath` | `string` | Optional. Identifies the EKM Crypto Space that this EkmConnection maps to. Note: This field is required if KeyManagementMode is CLOUD_KMS. | | `etag` | `string` | Optional. Etag of the currently stored EkmConnection. | +| `keyManagementMode` | `string` | Optional. Describes who can perform control plane operations on the EKM. If unset, this defaults to MANUAL. | +| `serviceResolvers` | `array` | A list of ServiceResolvers where the EKM can be reached. There should be one ServiceResolver per EKM replica. Currently, only a single ServiceResolver is supported. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_audit_configs/index.md deleted file mode 100644 index 05852777f6..0000000000 --- a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ekm_connections_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - ekm_connections_iam_audit_configs - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Nameekm_connections_iam_audit_configs
TypeResource
Idgoogle.cloudkms.ekm_connections_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_ekmConnections_getIamPolicy` | `SELECT` | `ekmConnectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_bindings/index.md b/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_bindings/index.md deleted file mode 100644 index 9a7899a3f8..0000000000 --- a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ekm_connections_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - ekm_connections_iam_bindings - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Nameekm_connections_iam_bindings
TypeResource
Idgoogle.cloudkms.ekm_connections_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_ekmConnections_getIamPolicy` | `SELECT` | `ekmConnectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md b/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md index 6ce005f8b9..975fdf9a04 100644 --- a/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudkms/ekm_connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/import_jobs/index.md b/docs/google-docs/providers/google/cloudkms/import_jobs/index.md index b788351739..667c7fb81b 100644 --- a/docs/google-docs/providers/google/cloudkms/import_jobs/index.md +++ b/docs/google-docs/providers/google/cloudkms/import_jobs/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this ImportJob in the format `projects/*/locations/*/keyRings/*/importJobs/*`. | -| `createTime` | `string` | Output only. The time at which this ImportJob was created. | +| `publicKey` | `object` | The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. | +| `importMethod` | `string` | Required. Immutable. The wrapping method to be used for incoming key material. | +| `generateTime` | `string` | Output only. The time this ImportJob's key material was generated. | | `attestation` | `object` | Contains an HSM-generated attestation about a key operation. For more information, see [Verifying attestations] (https://cloud.google.com/kms/docs/attest-key). | -| `state` | `string` | Output only. The current state of the ImportJob, indicating if it can be used. | +| `createTime` | `string` | Output only. The time at which this ImportJob was created. | | `protectionLevel` | `string` | Required. Immutable. The protection level of the ImportJob. This must match the protection_level of the version_template on the CryptoKey you attempt to import into. | | `expireTime` | `string` | Output only. The time at which this ImportJob is scheduled for expiration and can no longer be used to import key material. | -| `generateTime` | `string` | Output only. The time this ImportJob's key material was generated. | -| `importMethod` | `string` | Required. Immutable. The wrapping method to be used for incoming key material. | | `expireEventTime` | `string` | Output only. The time this ImportJob expired. Only present if state is EXPIRED. | -| `publicKey` | `object` | The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the ImportMethod. | +| `state` | `string` | Output only. The current state of the ImportJob, indicating if it can be used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudkms/import_jobs_iam_audit_configs/index.md deleted file mode 100644 index 1e860a5485..0000000000 --- a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: import_jobs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - import_jobs_iam_audit_configs - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Nameimport_jobs_iam_audit_configs
TypeResource
Idgoogle.cloudkms.import_jobs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_keyRings_importJobs_getIamPolicy` | `SELECT` | `importJobsId, keyRingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_bindings/index.md b/docs/google-docs/providers/google/cloudkms/import_jobs_iam_bindings/index.md deleted file mode 100644 index 740f09d00b..0000000000 --- a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: import_jobs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - import_jobs_iam_bindings - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Nameimport_jobs_iam_bindings
TypeResource
Idgoogle.cloudkms.import_jobs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_keyRings_importJobs_getIamPolicy` | `SELECT` | `importJobsId, keyRingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/key_rings_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudkms/key_rings_iam_audit_configs/index.md deleted file mode 100644 index 4b71e54430..0000000000 --- a/docs/google-docs/providers/google/cloudkms/key_rings_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: key_rings_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - key_rings_iam_audit_configs - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Namekey_rings_iam_audit_configs
TypeResource
Idgoogle.cloudkms.key_rings_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_keyRings_getIamPolicy` | `SELECT` | `keyRingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/key_rings_iam_bindings/index.md b/docs/google-docs/providers/google/cloudkms/key_rings_iam_bindings/index.md deleted file mode 100644 index a1bfcbdc0f..0000000000 --- a/docs/google-docs/providers/google/cloudkms/key_rings_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: key_rings_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - key_rings_iam_bindings - - cloudkms - - 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 ---- - - - -## Overview - - - - -
Namekey_rings_iam_bindings
TypeResource
Idgoogle.cloudkms.key_rings_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_keyRings_getIamPolicy` | `SELECT` | `keyRingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/cloudkms/key_rings_iam_policies/index.md b/docs/google-docs/providers/google/cloudkms/key_rings_iam_policies/index.md index f587510713..6cfaf581f1 100644 --- a/docs/google-docs/providers/google/cloudkms/key_rings_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudkms/key_rings_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/locations/index.md b/docs/google-docs/providers/google/cloudkms/locations/index.md index 0d08d66f5b..c3532913a8 100644 --- a/docs/google-docs/providers/google/cloudkms/locations/index.md +++ b/docs/google-docs/providers/google/cloudkms/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md b/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md index 5769e32280..fc52713c0d 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/effective_tags/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `inherited` | `boolean` | Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false. | -| `namespacedTagKey` | `string` | The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`. | | `namespacedTagValue` | `string` | The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`. | | `tagKey` | `string` | The name of the TagKey, in the format `tagKeys/{id}`, such as `tagKeys/123`. | | `tagKeyParentName` | `string` | The parent name of the tag key. Must be in the format `organizations/{organization_id}` or `projects/{project_number}` | | `tagValue` | `string` | Resource name for TagValue in the format `tagValues/456`. | +| `inherited` | `boolean` | Indicates the inheritance status of a tag value attached to the given resource. If the tag value is inherited from one of the resource's ancestors, inherited will be true. If false, then the tag value is directly attached to the resource, inherited will be false. | +| `namespacedTagKey` | `string` | The namespaced name of the TagKey. Can be in the form `{organization_id}/{tag_key_short_name}` or `{project_id}/{tag_key_short_name}` or `{project_number}/{tag_key_short_name}`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md b/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md index 56e9902a34..96a36e7586 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/folders/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the folder. Its format is `folders/{folder_id}`, for example: "folders/1234". | -| `state` | `string` | Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder. | -| `updateTime` | `string` | Output only. Timestamp when the folder was last modified. | | `createTime` | `string` | Output only. Timestamp when the folder was created. | | `deleteTime` | `string` | Output only. Timestamp when the folder was requested to be deleted. | | `displayName` | `string` | The folder's display name. A folder's display name must be unique amongst its siblings. For example, no two folders with the same parent can share the same display name. The display name must start and end with a letter or digit, may contain letters, digits, spaces, hyphens and underscores and can be no longer than 30 characters. This is captured by the regular expression: `[\p{L}\p{N}]([\p{L}\p{N}_- ]{0,28}[\p{L}\p{N}])?`. | | `etag` | `string` | Output only. A checksum computed by the server based on the current value of the folder resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | | `parent` | `string` | Required. The folder's parent's resource name. Updates to the folder's parent must be performed using MoveFolder. | +| `state` | `string` | Output only. The lifecycle state of the folder. Updates to the state must be performed using DeleteFolder and UndeleteFolder. | +| `updateTime` | `string` | Output only. Timestamp when the folder was last modified. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_audit_configs/index.md deleted file mode 100644 index 4c5a9b7c97..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: folders_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - folders_iam_audit_configs - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Namefolders_iam_audit_configs
TypeResource
Idgoogle.cloudresourcemanager.folders_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `folders_getIamPolicy` | `SELECT` | `foldersId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_bindings/index.md b/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_bindings/index.md deleted file mode 100644 index bed277dd65..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: folders_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - folders_iam_bindings - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Namefolders_iam_bindings
TypeResource
Idgoogle.cloudresourcemanager.folders_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `folders_getIamPolicy` | `SELECT` | `foldersId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md index 0ef76575a2..5477242963 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/folders_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md b/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md index fff86c191f..b36be11371 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/liens/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | A system-generated unique identifier for this Lien. Example: `liens/1234abcd` | -| `origin` | `string` | A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com' | | `parent` | `string` | A reference to the resource this Lien is attached to. The server will validate the parent against those for which Liens are supported. Example: `projects/1234` | | `reason` | `string` | Concise user-visible strings indicating why an action cannot be performed on a resource. Maximum length of 200 characters. Example: 'Holds production API key' | | `restrictions` | `array` | The types of operations which should be blocked as a result of this Lien. Each value should correspond to an IAM permission. The server will validate the permissions against those for which Liens are supported. An empty list is meaningless and will be rejected. Example: ['resourcemanager.projects.delete'] | | `createTime` | `string` | The creation time of this Lien. | +| `origin` | `string` | A stable, user-visible/meaningful string identifying the origin of the Lien, intended to be inspected programmatically. Maximum length of 200 characters. Example: 'compute.googleapis.com' | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md b/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md index d13b540656..5a4ee424af 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the organization. This is the organization's relative path in the API. Its format is "organizations/[organization_id]". For example, "organizations/1234". | +| `state` | `string` | Output only. The organization's current lifecycle state. | | `updateTime` | `string` | Output only. Timestamp when the Organization was last modified. | | `createTime` | `string` | Output only. Timestamp when the Organization was created. | | `deleteTime` | `string` | Output only. Timestamp when the Organization was requested for deletion. | | `directoryCustomerId` | `string` | Immutable. The G Suite / Workspace customer id used in the Directory API. | | `displayName` | `string` | Output only. A human-readable string that refers to the organization in the Google Cloud Console. This string is set by the server and cannot be changed. The string will be set to the primary domain (for example, "google.com") of the Google Workspace customer that owns the organization. | | `etag` | `string` | Output only. A checksum computed by the server based on the current value of the Organization resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `state` | `string` | Output only. The organization's current lifecycle state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_audit_configs/index.md deleted file mode 100644 index 0559873fac..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: organizations_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_iam_audit_configs - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_iam_audit_configs
TypeResource
Idgoogle.cloudresourcemanager.organizations_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getIamPolicy` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_bindings/index.md b/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_bindings/index.md deleted file mode 100644 index f20657aca4..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: organizations_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_iam_bindings - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_iam_bindings
TypeResource
Idgoogle.cloudresourcemanager.organizations_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getIamPolicy` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md index 2019d91098..2fd512fde7 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/organizations_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md b/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md index 36d9760979..6dcb2f14f7 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/projects/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique resource name of the project. It is an int64 generated number prefixed by "projects/". Example: `projects/415104041262` | -| `state` | `string` | Output only. The project lifecycle state. | +| `deleteTime` | `string` | Output only. The time at which this resource was requested for deletion. | | `labels` | `object` | Optional. The labels associated with this project. Label keys must be between 1 and 63 characters long and must conform to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?. Label values must be between 0 and 63 characters long and must conform to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. No more than 64 labels can be associated with a given resource. Clients should store labels in a representation such as JSON that does not depend on specific characters being disallowed. Example: `"myBusinessDimension" : "businessValue"` | -| `createTime` | `string` | Output only. Creation time. | -| `displayName` | `string` | Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` | | `parent` | `string` | Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`. | -| `updateTime` | `string` | Output only. The most recent time this resource was modified. | +| `createTime` | `string` | Output only. Creation time. | | `etag` | `string` | Output only. A checksum computed by the server based on the current value of the Project resource. This may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `updateTime` | `string` | Output only. The most recent time this resource was modified. | | `projectId` | `string` | Immutable. The unique, user-assigned id of the project. It must be 6 to 30 lowercase ASCII letters, digits, or hyphens. It must start with a letter. Trailing hyphens are prohibited. Example: `tokyo-rain-123` | -| `deleteTime` | `string` | Output only. The time at which this resource was requested for deletion. | +| `state` | `string` | Output only. The project lifecycle state. | +| `displayName` | `string` | Optional. A user-assigned display name of the project. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `My Project` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_audit_configs/index.md deleted file mode 100644 index c5b1be2a01..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: projects_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - projects_iam_audit_configs - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nameprojects_iam_audit_configs
TypeResource
Idgoogle.cloudresourcemanager.projects_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getIamPolicy` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_bindings/index.md b/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_bindings/index.md deleted file mode 100644 index d77cb2f529..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: projects_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - projects_iam_bindings - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nameprojects_iam_bindings
TypeResource
Idgoogle.cloudresourcemanager.projects_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getIamPolicy` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md index f2e3170880..79114b762e 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/projects_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md index 116bfbfbb1..60621453fa 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name for a TagKey. Must be in the format `tagKeys/{tag_key_id}`, where `tag_key_id` is the generated numeric id for the TagKey. | | `description` | `string` | Optional. User-assigned description of the TagKey. Must not exceed 256 characters. Read-write. | -| `purposeData` | `object` | Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set. | -| `updateTime` | `string` | Output only. Update time. | -| `namespacedName` | `string` | Output only. Immutable. Namespaced name of the TagKey. | -| `parent` | `string` | Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`. | | `shortName` | `string` | Required. Immutable. The user friendly name for a TagKey. The short name should be unique for TagKeys within the same tag namespace. The short name must be 1-63 characters, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | | `etag` | `string` | Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagKeyRequest for details. | +| `parent` | `string` | Immutable. The resource name of the TagKey's parent. A TagKey can be parented by an Organization or a Project. For a TagKey parented by an Organization, its parent must be in the form `organizations/{org_id}`. For a TagKey parented by a Project, its parent can be in the form `projects/{project_id}` or `projects/{project_number}`. | +| `updateTime` | `string` | Output only. Update time. | | `createTime` | `string` | Output only. Creation time. | +| `purposeData` | `object` | Optional. Purpose data corresponds to the policy system that the tag is intended for. See documentation for `Purpose` for formatting of this field. Purpose data cannot be changed once set. | +| `namespacedName` | `string` | Output only. Immutable. Namespaced name of the TagKey. | | `purpose` | `string` | Optional. A purpose denotes that this Tag is intended for use in policies of a specific policy engine, and will involve that policy engine in management operations involving this Tag. A purpose does not grant a policy engine exclusive rights to the Tag, and it may be referenced by other policy engines. A purpose cannot be changed once set. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_audit_configs/index.md deleted file mode 100644 index 05236d58eb..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: tag_keys_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - tag_keys_iam_audit_configs - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nametag_keys_iam_audit_configs
TypeResource
Idgoogle.cloudresourcemanager.tag_keys_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `tagKeys_getIamPolicy` | `SELECT` | `tagKeysId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_bindings/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_bindings/index.md deleted file mode 100644 index f8cbf087f2..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: tag_keys_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - tag_keys_iam_bindings - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nametag_keys_iam_bindings
TypeResource
Idgoogle.cloudresourcemanager.tag_keys_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `tagKeys_getIamPolicy` | `SELECT` | `tagKeysId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md index f127325863..68028d832c 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md index 40af15d359..f54bf47568 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_values/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. Resource name for TagValue in the format `tagValues/456`. | | `description` | `string` | Optional. User-assigned description of the TagValue. Must not exceed 256 characters. Read-write. | +| `shortName` | `string` | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | | `updateTime` | `string` | Output only. Update time. | | `createTime` | `string` | Output only. Creation time. | | `etag` | `string` | Optional. Entity tag which users can pass to prevent race conditions. This field is always set in server responses. See UpdateTagValueRequest for details. | | `namespacedName` | `string` | Output only. The namespaced name of the TagValue. Can be in the form `{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_id}/{tag_key_short_name}/{tag_value_short_name}` or `{project_number}/{tag_key_short_name}/{tag_value_short_name}`. | | `parent` | `string` | Immutable. The resource name of the new TagValue's parent TagKey. Must be of the form `tagKeys/{tag_key_id}`. | -| `shortName` | `string` | Required. Immutable. User-assigned short name for TagValue. The short name should be unique for TagValues within the same parent TagKey. The short name must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_audit_configs/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_audit_configs/index.md deleted file mode 100644 index 5cf9728162..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: tag_values_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - tag_values_iam_audit_configs - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nametag_values_iam_audit_configs
TypeResource
Idgoogle.cloudresourcemanager.tag_values_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `tagValues_getIamPolicy` | `SELECT` | `tagValuesId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_bindings/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_bindings/index.md deleted file mode 100644 index 9319694a11..0000000000 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: tag_values_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - tag_values_iam_bindings - - cloudresourcemanager - - 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 ---- - - - -## Overview - - - - -
Nametag_values_iam_bindings
TypeResource
Idgoogle.cloudresourcemanager.tag_values_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `tagValues_getIamPolicy` | `SELECT` | `tagValuesId` | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md index 99fbd6521f..06036fb10c 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudscheduler/jobs/index.md b/docs/google-docs/providers/google/cloudscheduler/jobs/index.md index 8d83d7f91c..00a5fc1725 100644 --- a/docs/google-docs/providers/google/cloudscheduler/jobs/index.md +++ b/docs/google-docs/providers/google/cloudscheduler/jobs/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. | | `description` | `string` | Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters. | | `status` | `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). | -| `pubsubTarget` | `object` | Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. | -| `timeZone` | `string` | Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). | | `retryConfig` | `object` | Settings that determine the retry behavior. By default, if a job does not complete successfully (meaning that an acknowledgement is not received from the handler, then it will be retried with exponential backoff according to the settings in RetryConfig. | -| `httpTarget` | `object` | Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. | -| `attemptDeadline` | `string` | The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. | -| `appEngineHttpTarget` | `object` | App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt. | -| `state` | `string` | Output only. State of the job. | -| `scheduleTime` | `string` | Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. | +| `timeZone` | `string` | Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). | | `lastAttemptTime` | `string` | Output only. The time the last job attempt started. | | `schedule` | `string` | Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. | +| `appEngineHttpTarget` | `object` | App Engine target. The job will be pushed to a job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. Error 503 is considered an App Engine system error instead of an application error. Requests returning error 503 will be retried regardless of retry configuration and not counted against retry counts. Any other response code, or a failure to receive a response before the deadline, constitutes a failed attempt. | | `userUpdateTime` | `string` | Output only. The creation time of the job. | +| `state` | `string` | Output only. State of the job. | +| `scheduleTime` | `string` | Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. | +| `attemptDeadline` | `string` | The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The default and the allowed values depend on the type of target: * For HTTP targets, the default is 3 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine HTTP targets, 0 indicates that the request has the default deadline. The default deadline depends on the scaling type of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is ignored. | +| `httpTarget` | `object` | Http target. The job will be pushed to the job handler by means of an HTTP request via an http_method such as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an HTTP response code in the range [200 - 299]. A failure to receive a response constitutes a failed execution. For a redirected request, the response returned by the redirected request is considered. | +| `pubsubTarget` | `object` | Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudsearch/cloudsearch/index.md b/docs/google-docs/providers/google/cloudsearch/cloudsearch/index.md deleted file mode 100644 index a73951ac9b..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/cloudsearch/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: cloudsearch -hide_title: false -hide_table_of_contents: false -keywords: - - cloudsearch - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namecloudsearch
TypeResource
Idgoogle.cloudsearch.cloudsearch
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `initializeCustomer` | `EXEC` | | diff --git a/docs/google-docs/providers/google/cloudsearch/datasources/index.md b/docs/google-docs/providers/google/cloudsearch/datasources/index.md deleted file mode 100644 index 76efc7c216..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/datasources/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: datasources -hide_title: false -hide_table_of_contents: false -keywords: - - datasources - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namedatasources
TypeResource
Idgoogle.cloudsearch.datasources
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource. | -| `indexingServiceAccounts` | `array` | List of service accounts that have indexing access. | -| `disableModifications` | `boolean` | If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data. | -| `itemsVisibility` | `array` | This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility. | -| `returnThumbnailUrls` | `boolean` | Can a user request to get thumbnail URI for Items indexed in this data source. | -| `operationIds` | `array` | IDs of the Long Running Operations (LROs) currently running for this schema. | -| `disableServing` | `boolean` | Disable serving any search or assist results. | -| `shortName` | `string` | A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is *<value>* then queries like *source:<value>* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters. | -| `displayName` | `string` | Required. Display name of the datasource The maximum length is 300 characters. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `settings_datasources_get` | `SELECT` | `datasourcesId` | Gets a datasource. **Note:** This API requires an admin account to execute. | -| `settings_datasources_list` | `SELECT` | | Lists datasources. **Note:** This API requires an admin account to execute. | -| `settings_datasources_create` | `INSERT` | | Creates a datasource. **Note:** This API requires an admin account to execute. | -| `settings_datasources_delete` | `DELETE` | `datasourcesId` | Deletes a datasource. **Note:** This API requires an admin account to execute. | -| `indexing_datasources_updateSchema` | `EXEC` | `datasourcesId` | Updates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema. **Note:** This API requires an admin or service account to execute. | -| `settings_datasources_patch` | `EXEC` | `datasourcesId` | Updates a datasource. **Note:** This API requires an admin account to execute. | -| `settings_datasources_update` | `EXEC` | `datasourcesId` | Updates a datasource. **Note:** This API requires an admin account to execute. | -| `stats_index_datasources_get` | `EXEC` | `datasourcesId` | Gets indexed item statistics for a single data source. **Note:** This API requires a standard end user account to execute. | diff --git a/docs/google-docs/providers/google/cloudsearch/datasources_schema/index.md b/docs/google-docs/providers/google/cloudsearch/datasources_schema/index.md deleted file mode 100644 index 14d4e922b7..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/datasources_schema/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: datasources_schema -hide_title: false -hide_table_of_contents: false -keywords: - - datasources_schema - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namedatasources_schema
TypeResource
Idgoogle.cloudsearch.datasources_schema
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `operationIds` | `array` | IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content. | -| `objectDefinitions` | `array` | The list of top-level objects for the data source. The maximum number of elements is 10. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `indexing_datasources_getSchema` | `SELECT` | `datasourcesId` | Gets the schema of a data source. **Note:** This API requires an admin or service account to execute. | -| `indexing_datasources_deleteSchema` | `DELETE` | `datasourcesId` | Deletes the schema of a data source. **Note:** This API requires an admin or service account to execute. | diff --git a/docs/google-docs/providers/google/cloudsearch/index.md b/docs/google-docs/providers/google/cloudsearch/index.md deleted file mode 100644 index ae8a9d2444..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/index.md +++ /dev/null @@ -1,65 +0,0 @@ ---- -title: cloudsearch -hide_title: false -hide_table_of_contents: false -keywords: - - cloudsearch - - 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 ---- -Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search. - -:::info Service Summary - -
-
-total resources: 20
-total selectable resources: 15
-total methods: 48
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.cloudsearch
TypeService
TitleCloud Search API
DescriptionCloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.
Idcloudsearch:v23.05.00145
- -## Resources -
-
-cloudsearch
-datasources
-datasources_schema
-items
-items_forunmappedidentity
-items_queue_items
-lro
-media
-operations
-query
-
-
-searchapplications
-settings
-settings_customer
-sources
-stats_index
-stats_query
-stats_searchapplication
-stats_session
-stats_user
-unmappedids
-
-
diff --git a/docs/google-docs/providers/google/cloudsearch/items/index.md b/docs/google-docs/providers/google/cloudsearch/items/index.md deleted file mode 100644 index a4723d6a8e..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/items/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: items -hide_title: false -hide_table_of_contents: false -keywords: - - items - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Nameitems
TypeResource
Idgoogle.cloudsearch.items
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters. | -| `queue` | `string` | Queue this item belongs to. The maximum length is 100 characters. | -| `content` | `object` | Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded. | -| `structuredData` | `object` | Available structured data fields for the item. | -| `acl` | `object` | Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls). | -| `itemType` | `string` | The type for this item. | -| `status` | `object` | This contains item's status and any errors. | -| `metadata` | `object` | Available metadata fields for the item. | -| `payload` | `string` | Additional state connector can store for this item. The maximum length is 10000 bytes. | -| `version` | `string` | Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations). | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `indexing_datasources_items_get` | `SELECT` | `datasourcesId, itemsId` | Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | -| `indexing_datasources_items_list` | `SELECT` | `datasourcesId` | Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | -| `indexing_datasources_items_delete` | `DELETE` | `datasourcesId, itemsId` | Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | -| `debug_datasources_items_checkAccess` | `EXEC` | `datasourcesId, itemsId` | Checks whether an item is accessible by specified principal. Principal must be a user; groups and domain values aren't supported. **Note:** This API requires an admin account to execute. | -| `debug_datasources_items_searchByViewUrl` | `EXEC` | `datasourcesId` | Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute. | -| `indexing_datasources_items_index` | `EXEC` | `datasourcesId, itemsId` | Updates Item ACL, metadata, and content. It will insert the Item if it does not exist. This method does not support partial updates. Fields with no provided values are cleared out in the Cloud Search index. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | -| `indexing_datasources_items_poll` | `EXEC` | `datasourcesId` | Polls for unreserved items from the indexing queue and marks a set as reserved, starting with items that have the oldest timestamp from the highest priority ItemStatus. The priority order is as follows: ERROR MODIFIED NEW_ITEM ACCEPTED Reserving items ensures that polling from other threads cannot create overlapping sets. After handling the reserved items, the client should put items back into the unreserved state, either by calling index, or by calling push with the type REQUEUE. Items automatically become available (unreserved) after 4 hours even if no update or push method is called. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | -| `indexing_datasources_items_push` | `EXEC` | `datasourcesId, itemsId` | Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | -| `indexing_datasources_items_unreserve` | `EXEC` | `datasourcesId` | Unreserves all items from a queue, making them all eligible to be polled. This method is useful for resetting the indexing queue after a connector has been restarted. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | -| `indexing_datasources_items_upload` | `EXEC` | `datasourcesId, itemsId` | Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source. | diff --git a/docs/google-docs/providers/google/cloudsearch/items_forunmappedidentity/index.md b/docs/google-docs/providers/google/cloudsearch/items_forunmappedidentity/index.md deleted file mode 100644 index 4ae6ce38f8..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/items_forunmappedidentity/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: items_forunmappedidentity -hide_title: false -hide_table_of_contents: false -keywords: - - items_forunmappedidentity - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Nameitems_forunmappedidentity
TypeResource
Idgoogle.cloudsearch.items_forunmappedidentity
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `debug_identitysources_items_listForunmappedidentity` | `SELECT` | `identitysourcesId` | diff --git a/docs/google-docs/providers/google/cloudsearch/items_queue_items/index.md b/docs/google-docs/providers/google/cloudsearch/items_queue_items/index.md deleted file mode 100644 index ec5571c4c2..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/items_queue_items/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: items_queue_items -hide_title: false -hide_table_of_contents: false -keywords: - - items_queue_items - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Nameitems_queue_items
TypeResource
Idgoogle.cloudsearch.items_queue_items
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `indexing_datasources_items_deleteQueueItems` | `DELETE` | `datasourcesId` | diff --git a/docs/google-docs/providers/google/cloudsearch/lro/index.md b/docs/google-docs/providers/google/cloudsearch/lro/index.md deleted file mode 100644 index 975ee4f9dd..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/lro/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: lro -hide_title: false -hide_table_of_contents: false -keywords: - - lro - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namelro
TypeResource
Idgoogle.cloudsearch.lro
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `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}`. | -| `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | -| `done` | `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. | -| `error` | `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). | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `operations_lro_list` | `SELECT` | `operationsId` | diff --git a/docs/google-docs/providers/google/cloudsearch/media/index.md b/docs/google-docs/providers/google/cloudsearch/media/index.md deleted file mode 100644 index 7bda30f05d..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/media/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: media -hide_title: false -hide_table_of_contents: false -keywords: - - media - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namemedia
TypeResource
Idgoogle.cloudsearch.media
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `upload` | `EXEC` | `mediaId` | diff --git a/docs/google-docs/providers/google/cloudsearch/operations/index.md b/docs/google-docs/providers/google/cloudsearch/operations/index.md deleted file mode 100644 index 19d7085355..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/operations/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: operations -hide_title: false -hide_table_of_contents: false -keywords: - - operations - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Nameoperations
TypeResource
Idgoogle.cloudsearch.operations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `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}`. | -| `error` | `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). | -| `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | -| `done` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `get` | `SELECT` | `operationsId` | diff --git a/docs/google-docs/providers/google/cloudsearch/query/index.md b/docs/google-docs/providers/google/cloudsearch/query/index.md deleted file mode 100644 index 3ee1e85200..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/query/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: query -hide_title: false -hide_table_of_contents: false -keywords: - - query - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namequery
TypeResource
Idgoogle.cloudsearch.query
- -## 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 -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `search` | `EXEC` | | The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). | -| `suggest` | `EXEC` | | Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up [Google Workspace domain-wide delegation of authority](https://developers.google.com/cloud-search/docs/guides/delegation/). | diff --git a/docs/google-docs/providers/google/cloudsearch/searchapplications/index.md b/docs/google-docs/providers/google/cloudsearch/searchapplications/index.md deleted file mode 100644 index ae279907f4..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/searchapplications/index.md +++ /dev/null @@ -1,53 +0,0 @@ ---- -title: searchapplications -hide_title: false -hide_table_of_contents: false -keywords: - - searchapplications - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namesearchapplications
TypeResource
Idgoogle.cloudsearch.searchapplications
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the Search Application. Format: searchapplications/{application_id}. | -| `defaultSortOptions` | `object` | | -| `operationIds` | `array` | Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field. | -| `enableAuditLog` | `boolean` | Indicates whether audit logging is on/off for requests made for the search application in query APIs. | -| `queryInterpretationConfig` | `object` | Default options to interpret user query. | -| `sourceConfig` | `array` | Configuration for a sources specified in data_source_restrictions. | -| `displayName` | `string` | Display name of the Search Application. The maximum length is 300 characters. | -| `dataSourceRestrictions` | `array` | Retrictions applied to the configurations. The maximum number of elements is 10. | -| `returnResultThumbnailUrls` | `boolean` | With each result we should return the URI for its thumbnail (when applicable) | -| `defaultFacetOptions` | `array` | The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above. | -| `scoringConfig` | `object` | Scoring configurations for a source while processing a Search or Suggest request. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `settings_searchapplications_get` | `SELECT` | `searchapplicationsId` | Gets the specified search application. **Note:** This API requires an admin account to execute. | -| `settings_searchapplications_list` | `SELECT` | | Lists all search applications. **Note:** This API requires an admin account to execute. | -| `settings_searchapplications_create` | `INSERT` | | Creates a search application. **Note:** This API requires an admin account to execute. | -| `settings_searchapplications_delete` | `DELETE` | `searchapplicationsId` | Deletes a search application. **Note:** This API requires an admin account to execute. | -| `settings_searchapplications_patch` | `EXEC` | `searchapplicationsId` | Updates a search application. **Note:** This API requires an admin account to execute. | -| `settings_searchapplications_reset` | `EXEC` | `searchapplicationsId` | Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute. | -| `settings_searchapplications_update` | `EXEC` | `searchapplicationsId` | Updates a search application. **Note:** This API requires an admin account to execute. | -| `stats_query_searchapplications_get` | `EXEC` | `searchapplicationsId` | Get the query statistics for search application. **Note:** This API requires a standard end user account to execute. | -| `stats_session_searchapplications_get` | `EXEC` | `searchapplicationsId` | Get the # of search sessions, % of successful sessions with a click query statistics for search application. **Note:** This API requires a standard end user account to execute. | -| `stats_user_searchapplications_get` | `EXEC` | `searchapplicationsId` | Get the users statistics for search application. **Note:** This API requires a standard end user account to execute. | diff --git a/docs/google-docs/providers/google/cloudsearch/settings/index.md b/docs/google-docs/providers/google/cloudsearch/settings/index.md deleted file mode 100644 index d9ee134a0a..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/settings/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: settings -hide_title: false -hide_table_of_contents: false -keywords: - - settings - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namesettings
TypeResource
Idgoogle.cloudsearch.settings
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateCustomer` | `EXEC` | | diff --git a/docs/google-docs/providers/google/cloudsearch/settings_customer/index.md b/docs/google-docs/providers/google/cloudsearch/settings_customer/index.md deleted file mode 100644 index 15cf5ca402..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/settings_customer/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: settings_customer -hide_title: false -hide_table_of_contents: false -keywords: - - settings_customer - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namesettings_customer
TypeResource
Idgoogle.cloudsearch.settings_customer
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLoggingSettings` | `object` | Represents the settings for Cloud audit logging | -| `vpcSettings` | `object` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `settings_getCustomer` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudsearch/sources/index.md b/docs/google-docs/providers/google/cloudsearch/sources/index.md deleted file mode 100644 index 8f20e1b0bc..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/sources/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: sources -hide_title: false -hide_table_of_contents: false -keywords: - - sources - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namesources
TypeResource
Idgoogle.cloudsearch.sources
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `shortName` | `string` | A short name or alias for the source. This value can be used with the 'source' operator. | -| `source` | `object` | Defines sources for the suggest/search APIs. | -| `displayName` | `string` | Display name of the data source. | -| `operators` | `array` | List of all operators applicable for this source. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `query_sources_list` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudsearch/stats_index/index.md b/docs/google-docs/providers/google/cloudsearch/stats_index/index.md deleted file mode 100644 index d8ae4cb33d..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/stats_index/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: stats_index -hide_title: false -hide_table_of_contents: false -keywords: - - stats_index - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namestats_index
TypeResource
Idgoogle.cloudsearch.stats_index
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `averageIndexedItemCount` | `string` | Average item count for the given date range for which billing is done. | -| `stats` | `array` | Summary of indexed item counts, one for each day in the requested range. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `stats_getIndex` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudsearch/stats_query/index.md b/docs/google-docs/providers/google/cloudsearch/stats_query/index.md deleted file mode 100644 index 8f8477e05f..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/stats_query/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: stats_query -hide_title: false -hide_table_of_contents: false -keywords: - - stats_query - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namestats_query
TypeResource
Idgoogle.cloudsearch.stats_query
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `stats` | `array` | | -| `totalQueryCount` | `string` | Total successful query count (status code 200) for the given date range. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `stats_getQuery` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudsearch/stats_searchapplication/index.md b/docs/google-docs/providers/google/cloudsearch/stats_searchapplication/index.md deleted file mode 100644 index c2bc4aa922..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/stats_searchapplication/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: stats_searchapplication -hide_title: false -hide_table_of_contents: false -keywords: - - stats_searchapplication - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namestats_searchapplication
TypeResource
Idgoogle.cloudsearch.stats_searchapplication
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `stats` | `array` | Search application stats by date. | -| `averageSearchApplicationCount` | `string` | Average search application count for the given date range. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `stats_getSearchapplication` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudsearch/stats_session/index.md b/docs/google-docs/providers/google/cloudsearch/stats_session/index.md deleted file mode 100644 index e2efe00273..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/stats_session/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: stats_session -hide_title: false -hide_table_of_contents: false -keywords: - - stats_session - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namestats_session
TypeResource
Idgoogle.cloudsearch.stats_session
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `stats_getSession` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudsearch/stats_user/index.md b/docs/google-docs/providers/google/cloudsearch/stats_user/index.md deleted file mode 100644 index a24dbeca44..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/stats_user/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: stats_user -hide_title: false -hide_table_of_contents: false -keywords: - - stats_user - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Namestats_user
TypeResource
Idgoogle.cloudsearch.stats_user
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `stats_getUser` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudsearch/unmappedids/index.md b/docs/google-docs/providers/google/cloudsearch/unmappedids/index.md deleted file mode 100644 index 0877a7f0fb..0000000000 --- a/docs/google-docs/providers/google/cloudsearch/unmappedids/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: unmappedids -hide_title: false -hide_table_of_contents: false -keywords: - - unmappedids - - cloudsearch - - 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 ---- - - - -## Overview - - - - -
Nameunmappedids
TypeResource
Idgoogle.cloudsearch.unmappedids
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `externalIdentity` | `object` | Reference to a user, group, or domain. | -| `resolutionStatusCode` | `string` | The resolution status for the external identity. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `debug_datasources_items_unmappedids_list` | `SELECT` | `datasourcesId, itemsId` | List all unmapped identities for a specific item. **Note:** This API requires an admin account to execute. | -| `debug_identitysources_unmappedids_list` | `SELECT` | `identitysourcesId` | Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute. | diff --git a/docs/google-docs/providers/google/cloudshell/environments/index.md b/docs/google-docs/providers/google/cloudshell/environments/index.md index e9de5524e2..20c105a249 100644 --- a/docs/google-docs/providers/google/cloudshell/environments/index.md +++ b/docs/google-docs/providers/google/cloudshell/environments/index.md @@ -32,10 +32,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `sshPort` | `integer` | Output only. Port to which clients can connect to initiate SSH sessions with the environment. | | `sshUsername` | `string` | Output only. Username that clients should use when initiating SSH sessions with the environment. | | `publicKeys` | `array` | Output only. Public keys associated with the environment. Clients can connect to this environment via SSH only if they possess a private key corresponding to at least one of these public keys. Keys can be added to or removed from the environment using the AddPublicKey and RemovePublicKey methods. | -| `dockerImage` | `string` | Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". | -| `state` | `string` | Output only. Current execution state of this environment. | -| `webHost` | `string` | Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. | | `sshHost` | `string` | Output only. Host to which clients can connect to initiate SSH sessions with the environment. | +| `webHost` | `string` | Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the environment. | +| `state` | `string` | Output only. Current execution state of this environment. | +| `dockerImage` | `string` | Required. Immutable. Full path to the Docker image used to run this environment, e.g. "gcr.io/dev-con/cloud-devshell:latest". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudshell/operations/index.md b/docs/google-docs/providers/google/cloudshell/operations/index.md index 33a72f9cd0..46047b478a 100644 --- a/docs/google-docs/providers/google/cloudshell/operations/index.md +++ b/docs/google-docs/providers/google/cloudshell/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | | `response` | `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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudsupport/attachments/index.md b/docs/google-docs/providers/google/cloudsupport/attachments/index.md index 072f104412..0eee002c9c 100644 --- a/docs/google-docs/providers/google/cloudsupport/attachments/index.md +++ b/docs/google-docs/providers/google/cloudsupport/attachments/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the attachment. | +| `filename` | `string` | The filename of the attachment (e.g. `"graph.jpg"`). | +| `mimeType` | `string` | Output only. The MIME type of the attachment (e.g. text/plain). | | `sizeBytes` | `string` | Output only. The size of the attachment in bytes. | | `createTime` | `string` | Output only. The time at which the attachment was created. | | `creator` | `object` | An object containing information about the effective user and authenticated principal responsible for an action. | -| `filename` | `string` | The filename of the attachment (e.g. `"graph.jpg"`). | -| `mimeType` | `string` | Output only. The MIME type of the attachment (e.g. text/plain). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudtasks/locations/index.md b/docs/google-docs/providers/google/cloudtasks/locations/index.md index 71c78c21c3..d652d8a88a 100644 --- a/docs/google-docs/providers/google/cloudtasks/locations/index.md +++ b/docs/google-docs/providers/google/cloudtasks/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | -| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudtasks/queues_iam_bindings/index.md b/docs/google-docs/providers/google/cloudtasks/queues_iam_bindings/index.md deleted file mode 100644 index 800b81c8fa..0000000000 --- a/docs/google-docs/providers/google/cloudtasks/queues_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: queues_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - queues_iam_bindings - - cloudtasks - - 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 ---- - - - -## Overview - - - - -
Namequeues_iam_bindings
TypeResource
Idgoogle.cloudtasks.queues_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_queues_getIamPolicy` | `SELECT` | `locationsId, projectsId, queuesId` | diff --git a/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md b/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md index c9712204b2..d688dfdb71 100644 --- a/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudtasks/queues_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudtasks/tasks/index.md b/docs/google-docs/providers/google/cloudtasks/tasks/index.md index e2241dd8e6..52ea2b1b34 100644 --- a/docs/google-docs/providers/google/cloudtasks/tasks/index.md +++ b/docs/google-docs/providers/google/cloudtasks/tasks/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. | -| `firstAttempt` | `object` | The status of a task attempt. | -| `appEngineHttpRequest` | `object` | App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. | -| `httpRequest` | `object` | HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). | +| `view` | `string` | Output only. The view specifies which subset of the Task has been returned. | +| `dispatchCount` | `integer` | Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. | | `dispatchDeadline` | `string` | The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listening for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline. | | `scheduleTime` | `string` | The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. | -| `createTime` | `string` | Output only. The time that the task was created. `create_time` will be truncated to the nearest second. | -| `dispatchCount` | `integer` | Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. | -| `view` | `string` | Output only. The view specifies which subset of the Task has been returned. | | `lastAttempt` | `object` | The status of a task attempt. | | `responseCount` | `integer` | Output only. The number of attempts which have received a response. | +| `appEngineHttpRequest` | `object` | App Engine HTTP request. The message defines the HTTP request that is sent to an App Engine app when the task is dispatched. Using AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) Google IAM permission for the project and the following scope: `https://www.googleapis.com/auth/cloud-platform` The task will be delivered to the App Engine app which belongs to the same project as the queue. For more information, see [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and how routing is affected by [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). Traffic is encrypted during transport and never leaves Google datacenters. Because this traffic is carried over a communication mechanism internal to Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). The request to the handler, however, will appear to have used the HTTP protocol. The AppEngineRouting used to construct the URL that the task is delivered to can be set at the queue-level or task-level: * If app_engine_routing_override is set on the queue, this value is used for all tasks in the queue, no matter what the setting is for the task-level app_engine_routing. The `url` that the task will be sent to is: * `url =` host `+` relative_uri Tasks can be dispatched to secure app handlers, unsecure app handlers, and URIs restricted with [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). Because tasks are not run as any user, they cannot be dispatched to URIs restricted with [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) Task dispatches also do not follow redirects. The task attempt has succeeded if the app's request handler returns an HTTP response code in the range [`200` - `299`]. The task attempt has failed if the app's handler returns a non-2xx response code or Cloud Tasks does not receive response before the deadline. Failed tasks will be retried according to the retry configuration. `503` (Service Unavailable) is considered an App Engine system error instead of an application error and will cause Cloud Tasks' traffic congestion control to temporarily throttle the queue's dispatches. Unlike other types of task targets, a `429` (Too Many Requests) response from an app handler does not cause traffic congestion control to throttle the queue. | +| `httpRequest` | `object` | HTTP request. The task will be pushed to the worker as an HTTP request. If the worker or the redirected worker acknowledges the task by returning a successful HTTP response code ([`200` - `299`]), the task will be removed from the queue. If any other HTTP response code is returned or no response is received, the task will be retried according to the following: * User-specified throttling: retry configuration, rate limits, and the queue's state. * System throttling: To prevent the worker from overloading, Cloud Tasks may temporarily reduce the queue's effective rate. User-specified settings will not be changed. System throttling happens because: * Cloud Tasks backs off on all errors. Normally the backoff specified in rate limits will be used. But if the worker returns `429` (Too Many Requests), `503` (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a higher backoff rate. The retry specified in the `Retry-After` HTTP response header is considered. * To prevent traffic spikes and to smooth sudden increases in traffic, dispatches ramp up slowly when the queue is newly created or idle and if large numbers of tasks suddenly become available to dispatch (due to spikes in create task rates, the queue being unpaused, or many tasks that are scheduled at the same time). | +| `createTime` | `string` | Output only. The time that the task was created. `create_time` will be truncated to the nearest second. | +| `firstAttempt` | `object` | The status of a task attempt. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/composer/environments/index.md b/docs/google-docs/providers/google/composer/environments/index.md index 1215b07000..c8ef9ded6a 100644 --- a/docs/google-docs/providers/google/composer/environments/index.md +++ b/docs/google-docs/providers/google/composer/environments/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. | -| `createTime` | `string` | Output only. The time at which this environment was created. | -| `labels` | `object` | Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. | | `state` | `string` | The current state of the environment. | | `updateTime` | `string` | Output only. The time at which this environment was last modified. | | `uuid` | `string` | Output only. The UUID (Universally Unique IDentifier) associated with this environment. This value is generated when the environment is created. | | `config` | `object` | Configuration information for an environment. | +| `createTime` | `string` | Output only. The time at which this environment was created. | +| `labels` | `object` | Optional. User-defined labels for this environment. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/composer/operations/index.md b/docs/google-docs/providers/google/composer/operations/index.md index 49c736096d..3545b78450 100644 --- a/docs/google-docs/providers/google/composer/operations/index.md +++ b/docs/google-docs/providers/google/composer/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/accelerator_types/index.md b/docs/google-docs/providers/google/compute/accelerator_types/index.md index 2c68f53a85..d42e98cae3 100644 --- a/docs/google-docs/providers/google/compute/accelerator_types/index.md +++ b/docs/google-docs/providers/google/compute/accelerator_types/index.md @@ -30,12 +30,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional textual description of the resource. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. | -| `selfLink` | `string` | [Output Only] Server-defined, fully qualified URL for this resource. | -| `maximumCardsPerInstance` | `integer` | [Output Only] Maximum number of accelerator cards allowed per instance. | | `deprecated` | `object` | Deprecation status for a public resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zone` | `string` | [Output Only] The name of the zone where the accelerator type resides, such as us-central1-a. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `selfLink` | `string` | [Output Only] Server-defined, fully qualified URL for this resource. | +| `maximumCardsPerInstance` | `integer` | [Output Only] Maximum number of accelerator cards allowed per instance. | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/addresses/index.md b/docs/google-docs/providers/google/compute/addresses/index.md index c55607984d..7786e8ad8f 100644 --- a/docs/google-docs/providers/google/compute/addresses/index.md +++ b/docs/google-docs/providers/google/compute/addresses/index.md @@ -30,23 +30,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | -| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | -| `purpose` | `string` | The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. | -| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | +| `address` | `string` | The static IP address represented by this resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | | `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | -| `ipVersion` | `string` | The IP version that will be used by this address. Valid options are IPV4 or IPV6. | -| `networkTier` | `string` | This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. | -| `region` | `string` | [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.* | -| `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. | +| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `purpose` | `string` | The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. | +| `network` | `string` | The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. | +| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | +| `region` | `string` | [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.* | +| `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | +| `ipVersion` | `string` | The IP version that will be used by this address. Valid options are IPV4 or IPV6. | | `ipv6EndpointType` | `string` | The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. | +| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | -| `address` | `string` | The static IP address represented by this resource. | -| `network` | `string` | The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. | +| `networkTier` | `string` | This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/autoscalers/index.md b/docs/google-docs/providers/google/compute/autoscalers/index.md index dc7f8ef1f8..94773c519c 100644 --- a/docs/google-docs/providers/google/compute/autoscalers/index.md +++ b/docs/google-docs/providers/google/compute/autoscalers/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `recommendedSize` | `integer` | [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. | +| `statusDetails` | `array` | [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `recommendedSize` | `integer` | [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. | +| `region` | `string` | [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). | +| `zone` | `string` | [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). | +| `status` | `string` | [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. | | `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | -| `statusDetails` | `array` | [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. | +| `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | -| `zone` | `string` | [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). | | `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | -| `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | -| `region` | `string` | [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). | -| `status` | `string` | [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/backend_buckets/index.md b/docs/google-docs/providers/google/compute/backend_buckets/index.md index 993e4b5529..03cc84b193 100644 --- a/docs/google-docs/providers/google/compute/backend_buckets/index.md +++ b/docs/google-docs/providers/google/compute/backend_buckets/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] Unique identifier for the resource; defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional textual description of the resource; provided by the client when the resource is created. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend bucket. | +| `bucketName` | `string` | Cloud Storage bucket name. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend bucket. | | `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | -| `enableCdn` | `boolean` | If true, enable Cloud CDN for this BackendBucket. | | `kind` | `string` | Type of the resource. | -| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend bucket. | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend bucket. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `customResponseHeaders` | `array` | Headers that the Application Load Balancer should add to proxied responses. | -| `bucketName` | `string` | Cloud Storage bucket name. | +| `enableCdn` | `boolean` | If true, enable Cloud CDN for this BackendBucket. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/backend_services/index.md b/docs/google-docs/providers/google/compute/backend_services/index.md index ef147b8868..ccbc73bd18 100644 --- a/docs/google-docs/providers/google/compute/backend_services/index.md +++ b/docs/google-docs/providers/google/compute/backend_services/index.md @@ -30,42 +30,42 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | -| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | -| `iap` | `object` | Identity-Aware Proxy | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. | | `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | +| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | +| `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | | `region` | `string` | [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | -| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | | `failoverPolicy` | `object` | For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). | -| `port` | `integer` | Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | -| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | -| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | -| `backends` | `array` | The list of backends that serve this BackendService. | -| `portName` | `string` | A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. | -| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | -| `connectionDraining` | `object` | Message containing connection draining configuration. | -| `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. | | `serviceBindings` | `array` | URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. | -| `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | -| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | -| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | +| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | | `sessionAffinity` | `string` | Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | +| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | | `loadBalancingScheme` | `string` | Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. | -| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | -| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | -| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | | `affinityCookieTtlSec` | `integer` | Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | -| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | +| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | +| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | +| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | | `healthChecks` | `array` | The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. | +| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | +| `connectionDraining` | `object` | Message containing connection draining configuration. | +| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | +| `iap` | `object` | Identity-Aware Proxy | +| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | | `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `portName` | `string` | A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. | +| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | +| `backends` | `array` | The list of backends that serve this BackendService. | +| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | +| `port` | `integer` | Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. | +| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | | `localityLbPolicies` | `array` | A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/compute/backend_services_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/backend_services_iam_audit_configs/index.md deleted file mode 100644 index af782a3168..0000000000 --- a/docs/google-docs/providers/google/compute/backend_services_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: backend_services_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - backend_services_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namebackend_services_iam_audit_configs
TypeResource
Idgoogle.compute.backend_services_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `backendServices_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/backend_services_iam_bindings/index.md b/docs/google-docs/providers/google/compute/backend_services_iam_bindings/index.md deleted file mode 100644 index 4313a57e32..0000000000 --- a/docs/google-docs/providers/google/compute/backend_services_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: backend_services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - backend_services_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namebackend_services_iam_bindings
TypeResource
Idgoogle.compute.backend_services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `backendServices_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md b/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md index e755486856..8c87528c45 100644 --- a/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/backend_services_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/disk_types/index.md b/docs/google-docs/providers/google/compute/disk_types/index.md index cd9d45c135..4d4fce7dce 100644 --- a/docs/google-docs/providers/google/compute/disk_types/index.md +++ b/docs/google-docs/providers/google/compute/disk_types/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of this resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `validDiskSize` | `string` | [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". | -| `deprecated` | `object` | Deprecation status for a public resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | | `zone` | `string` | [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `deprecated` | `object` | Deprecation status for a public resource. | | `region` | `string` | [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | +| `validDiskSize` | `string` | [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/disks/index.md b/docs/google-docs/providers/google/compute/disks/index.md index 360b0d2934..ea13003a96 100644 --- a/docs/google-docs/providers/google/compute/disks/index.md +++ b/docs/google-docs/providers/google/compute/disks/index.md @@ -30,47 +30,47 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `sizeGb` | `string` | Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. | -| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `type` | `string` | URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. | +| `sourceSnapshot` | `string` | The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot | +| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | +| `lastDetachTimestamp` | `string` | [Output Only] Last detach timestamp in RFC3339 text format. | +| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | | `sourceImageEncryptionKey` | `object` | | | `sourceDisk` | `string` | The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | -| `resourceStatus` | `object` | | -| `sourceSnapshot` | `string` | The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot | -| `zone` | `string` | [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | -| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | -| `diskEncryptionKey` | `object` | | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. | | `provisionedIops` | `string` | Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | +| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | +| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | +| `sourceSnapshotEncryptionKey` | `object` | | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | +| `zone` | `string` | [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `sourceDiskId` | `string` | [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. | -| `params` | `object` | Additional disk params. | -| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | -| `sourceStorageObject` | `string` | The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. | | `region` | `string` | [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `lastDetachTimestamp` | `string` | [Output Only] Last detach timestamp in RFC3339 text format. | -| `asyncPrimaryDisk` | `object` | | +| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | +| `sourceImage` | `string` | The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family | +| `options` | `string` | Internal use only. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. | +| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | +| `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | +| `diskEncryptionKey` | `object` | | +| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | +| `locationHint` | `string` | An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. | | `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | -| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | -| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | +| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. | +| `sizeGb` | `string` | Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. | | `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | +| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | +| `resourceStatus` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | | `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | -| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `sourceImage` | `string` | The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family | -| `type` | `string` | URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. | -| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. | -| `sourceSnapshotEncryptionKey` | `object` | | +| `params` | `object` | Additional disk params. | | `provisionedThroughput` | `string` | Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. | -| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | -| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | -| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | -| `locationHint` | `string` | An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. | -| `options` | `string` | Internal use only. | +| `sourceStorageObject` | `string` | The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. | +| `asyncPrimaryDisk` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/disks_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/disks_iam_audit_configs/index.md deleted file mode 100644 index 6cea62f540..0000000000 --- a/docs/google-docs/providers/google/compute/disks_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: disks_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - disks_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namedisks_iam_audit_configs
TypeResource
Idgoogle.compute.disks_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `disks_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/disks_iam_bindings/index.md b/docs/google-docs/providers/google/compute/disks_iam_bindings/index.md deleted file mode 100644 index ee91786535..0000000000 --- a/docs/google-docs/providers/google/compute/disks_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: disks_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - disks_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namedisks_iam_bindings
TypeResource
Idgoogle.compute.disks_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `disks_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/disks_iam_policies/index.md b/docs/google-docs/providers/google/compute/disks_iam_policies/index.md index a991feec2a..121730dd8c 100644 --- a/docs/google-docs/providers/google/compute/disks_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/disks_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `rules` | `array` | This is deprecated and has no effect. Do not use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md b/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md index 1db8abcc5b..c1b947c48e 100644 --- a/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md +++ b/docs/google-docs/providers/google/compute/external_vpn_gateways/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `interfaces` | `array` | A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this ExternalVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an ExternalVpnGateway. | +| `interfaces` | `array` | A list of interfaces for this external VPN gateway. If your peer-side gateway is an on-premises gateway and non-AWS cloud providers' gateway, at most two interfaces can be provided for an external VPN gateway. If your peer side is an AWS virtual private gateway, four interfaces should be provided for an external VPN gateway. | | `redundancyType` | `string` | Indicates the user-supplied redundancy type of this external VPN gateway. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/firewall_policies/index.md b/docs/google-docs/providers/google/compute/firewall_policies/index.md index 2a1ea4c62c..6062b73eab 100644 --- a/docs/google-docs/providers/google/compute/firewall_policies/index.md +++ b/docs/google-docs/providers/google/compute/firewall_policies/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | -| `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | | `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | +| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | +| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | | `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | +| `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `associations` | `array` | A list of associations that belong to this firewall policy. | +| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/firewall_policies_association/index.md b/docs/google-docs/providers/google/compute/firewall_policies_association/index.md index cae7017e28..d2c7ec97ba 100644 --- a/docs/google-docs/providers/google/compute/firewall_policies_association/index.md +++ b/docs/google-docs/providers/google/compute/firewall_policies_association/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name for an association. | +| `firewallPolicyId` | `string` | [Output Only] The firewall policy ID of the association. | | `shortName` | `string` | [Output Only] The short name of the firewall policy of the association. | | `attachmentTarget` | `string` | The target that the firewall policy is attached to. | | `displayName` | `string` | [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. | -| `firewallPolicyId` | `string` | [Output Only] The firewall policy ID of the association. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/firewall_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/firewall_policies_iam_audit_configs/index.md deleted file mode 100644 index 5c0533293f..0000000000 --- a/docs/google-docs/providers/google/compute/firewall_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: firewall_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - firewall_policies_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namefirewall_policies_iam_audit_configs
TypeResource
Idgoogle.compute.firewall_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `firewallPolicies_getIamPolicy` | `SELECT` | `resource` | diff --git a/docs/google-docs/providers/google/compute/firewall_policies_iam_bindings/index.md b/docs/google-docs/providers/google/compute/firewall_policies_iam_bindings/index.md deleted file mode 100644 index 0814e6b6e1..0000000000 --- a/docs/google-docs/providers/google/compute/firewall_policies_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: firewall_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - firewall_policies_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namefirewall_policies_iam_bindings
TypeResource
Idgoogle.compute.firewall_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `firewallPolicies_getIamPolicy` | `SELECT` | `resource` | diff --git a/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md index f287562e59..a258eee226 100644 --- a/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/firewall_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md b/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md index b849a54050..3b504ac8e9 100644 --- a/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/firewall_policies_rule/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | An optional description for this resource. | -| `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | -| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | -| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | | `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | -| `direction` | `string` | The direction in which this rule applies. | -| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | -| `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | -| `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | | `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | | `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | +| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | | `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | +| `direction` | `string` | The direction in which this rule applies. | +| `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | +| `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | +| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | +| `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/firewalls/index.md b/docs/google-docs/providers/google/compute/firewalls/index.md index e6e394f32c..2f69915835 100644 --- a/docs/google-docs/providers/google/compute/firewalls/index.md +++ b/docs/google-docs/providers/google/compute/firewalls/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | -| `direction` | `string` | Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields. | +| `sourceTags` | `array` | If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. | +| `targetServiceAccounts` | `array` | A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. | +| `allowed` | `array` | The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. | | `priority` | `integer` | Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#firewall for firewall rules. | -| `sourceTags` | `array` | If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. | -| `sourceServiceAccounts` | `array` | If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. | -| `targetTags` | `array` | A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. | | `network` | `string` | URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: global/networks/default If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network - projects/myproject/global/networks/my-network - global/networks/default | -| `logConfig` | `object` | The available logging options for a firewall rule. | -| `allowed` | `array` | The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. | -| `sourceRanges` | `array` | If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `sourceServiceAccounts` | `array` | If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. | +| `denied` | `array` | The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. | | `disabled` | `boolean` | Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. | | `destinationRanges` | `array` | If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Both IPv4 and IPv6 are supported. | -| `denied` | `array` | The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. | -| `targetServiceAccounts` | `array` | A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. | +| `direction` | `string` | Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `EGRESS` traffic, you cannot specify the sourceTags fields. | +| `sourceRanges` | `array` | If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Both IPv4 and IPv6 are supported. | +| `targetTags` | `array` | A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `logConfig` | `object` | The available logging options for a firewall rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/forwarding_rules/index.md b/docs/google-docs/providers/google/compute/forwarding_rules/index.md index edb63a1f83..2a704f24dd 100644 --- a/docs/google-docs/providers/google/compute/forwarding_rules/index.md +++ b/docs/google-docs/providers/google/compute/forwarding_rules/index.md @@ -30,37 +30,37 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | +| `noAutomateDnsZone` | `boolean` | This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | | `sourceIpRanges` | `array` | If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). | -| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | -| `subnetwork` | `string` | This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. | -| `baseForwardingRule` | `string` | [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified. | -| `serviceLabel` | `string` | An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. | -| `network` | `string` | This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided. | -| `allowGlobalAccess` | `boolean` | This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created. | -| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | | `IPProtocol` | `string` | The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | +| `allowGlobalAccess` | `boolean` | This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created. | +| `subnetwork` | `string` | This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. | | `portRange` | `string` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)? | -| `region` | `string` | [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `backendService` | `string` | Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. | +| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | -| `metadataFilters` | `array` | Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. | -| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | -| `pscConnectionStatus` | `string` | | -| `noAutomateDnsZone` | `boolean` | This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | | `target` | `string` | The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. | -| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | -| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | -| `allowPscGlobalAccess` | `boolean` | This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. | | `networkTier` | `string` | This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | -| `isMirroringCollector` | `boolean` | Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `allowPscGlobalAccess` | `boolean` | This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `allPorts` | `boolean` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. | +| `network` | `string` | This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | +| `pscConnectionStatus` | `string` | | +| `serviceLabel` | `string` | An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. | +| `metadataFilters` | `array` | Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. | +| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | +| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | +| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | | `IPAddress` | `string` | IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | +| `allPorts` | `boolean` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. | +| `baseForwardingRule` | `string` | [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified. | +| `isMirroringCollector` | `boolean` | Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. | +| `region` | `string` | [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/global_addresses/index.md b/docs/google-docs/providers/google/compute/global_addresses/index.md index af04abc340..f5d21805bf 100644 --- a/docs/google-docs/providers/google/compute/global_addresses/index.md +++ b/docs/google-docs/providers/google/compute/global_addresses/index.md @@ -30,23 +30,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | +| `ipVersion` | `string` | The IP version that will be used by this address. Valid options are IPV4 or IPV6. | +| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | +| `ipv6EndpointType` | `string` | The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. | +| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | +| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | | `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | -| `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. | | `networkTier` | `string` | This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD. Internal IP addresses are always Premium Tier; global external IP addresses are always Premium Tier; regional external IP addresses can be either Standard or Premium Tier. If this field is not specified, it is assumed to be PREMIUM. | -| `status` | `string` | [Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. | -| `subnetwork` | `string` | The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. This field can only be used with INTERNAL type with a GCE_ENDPOINT or DNS_RESOLVER purpose. | -| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | -| `region` | `string` | [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.* | -| `ipv6EndpointType` | `string` | The endpoint type of this address, which should be VM or NETLB. This is used for deciding which type of endpoint this address can be used after the external IPv6 address reservation. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `purpose` | `string` | The purpose of this resource, which can be one of the following values: - GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses (regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges. - NAT_AUTO for the regional external IP addresses used by Cloud NAT when allocating addresses using automatic NAT IP address allocation. - IPSEC_INTERCONNECT for addresses created from a private IP range that are reserved for a VLAN attachment in an *HA VPN over Cloud Interconnect* configuration. These addresses are regional resources. - `SHARED_LOADBALANCER_VIP` for an internal IP address that is assigned to multiple internal forwarding rules. - `PRIVATE_SERVICE_CONNECT` for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. | +| `region` | `string` | [Output Only] The URL of the region where a regional address resides. For regional addresses, you must specify the region as a path parameter in the HTTP request URL. *This field is not applicable to global addresses.* | | `address` | `string` | The static IP address represented by this resource. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `ipVersion` | `string` | The IP version that will be used by this address. Valid options are IPV4 or IPV6. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Address. | | `network` | `string` | The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with the VPC_PEERING purpose. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md b/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md index e248b8e6c8..745ed20bf7 100644 --- a/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md +++ b/docs/google-docs/providers/google/compute/global_forwarding_rules/index.md @@ -30,37 +30,37 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For Private Service Connect forwarding rules that forward traffic to Google APIs, the forwarding rule name must be a 1-20 characters string with lowercase letters and numbers and must start with a letter. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `isMirroringCollector` | `boolean` | Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. | -| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | +| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | +| `region` | `string` | [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | +| `network` | `string` | This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided. | | `pscConnectionStatus` | `string` | | +| `portRange` | `string` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)? | +| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `noAutomateDnsZone` | `boolean` | This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable. | +| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | | `serviceLabel` | `string` | An optional prefix to the service name for this Forwarding Rule. If specified, the prefix is the first label of the fully qualified service name. The label must be 1-63 characters long, and comply with RFC1035. Specifically, the label must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. This field is only used for internal load balancing. | -| `baseForwardingRule` | `string` | [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified. | | `metadataFilters` | `array` | Opaque filter criteria used by load balancer to restrict routing configuration to a limited set of xDS compliant clients. In their xDS requests to load balancer, xDS clients present node metadata. When there is a match, the relevant configuration is made available to those proxies. Otherwise, all the resources (e.g. TargetHttpProxy, UrlMap) referenced by the ForwardingRule are not visible to those proxies. For each metadataFilter in this list, if its filterMatchCriteria is set to MATCH_ANY, at least one of the filterLabels must match the corresponding label provided in the metadata. If its filterMatchCriteria is set to MATCH_ALL, then all of its filterLabels must match with corresponding labels provided in the metadata. If multiple metadataFilters are specified, all of them need to be satisfied in order to be considered a match. metadataFilters specified here will be applifed before those specified in the UrlMap that this ForwardingRule references. metadataFilters only applies to Loadbalancers that have their loadBalancingScheme set to INTERNAL_SELF_MANAGED. | -| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | -| `IPAddress` | `string` | IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number. | -| `IPProtocol` | `string` | The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `target` | `string` | The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | -| `networkTier` | `string` | This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. | -| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | -| `ports` | `array` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal protocol forwarding. You can specify a list of up to five ports by number, separated by commas. The ports can be contiguous or discontiguous. Only packets addressed to these ports will be forwarded to the backends configured with this forwarding rule. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot share any values defined in ports. The ports, port_range, and allPorts fields are mutually exclusive. @pattern: \\d+(?:-\\d+)? | | `subnetwork` | `string` | This field identifies the subnetwork that the load balanced IP should belong to for this Forwarding Rule, used in internal load balancing and network load balancing with IPv6. If the network specified is in auto subnet mode, this field is optional. However, a subnetwork must be specified if the network is in custom subnet mode or when creating external forwarding rule with IPv6. | -| `backendService` | `string` | Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this resource, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | -| `network` | `string` | This field is not used for external load balancing. For Internal TCP/UDP Load Balancing, this field identifies the network that the load balanced IP should belong to for this Forwarding Rule. If the subnetwork is specified, the network of the subnetwork will be used. If neither subnetwork nor this field is specified, the default network will be used. For Private Service Connect forwarding rules that forward traffic to Google APIs, a network must be provided. | -| `sourceIpRanges` | `array` | If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `region` | `string` | [Output Only] URL of the region where the regional forwarding rule resides. This field is not applicable to global forwarding rules. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `IPProtocol` | `string` | The IP protocol to which this rule applies. For protocol forwarding, valid options are TCP, UDP, ESP, AH, SCTP, ICMP and L3_DEFAULT. The valid IP protocols are different for different load balancing products as described in [Load balancing features](https://cloud.google.com/load-balancing/docs/features#protocols_from_the_load_balancer_to_the_backends). | +| `isMirroringCollector` | `boolean` | Indicates whether or not this load balancer can be used as a collector for packet mirroring. To prevent mirroring loops, instances behind this load balancer will not have their traffic mirrored even if a PacketMirroring rule applies to them. This can only be set to true for load balancers that have their loadBalancingScheme set to INTERNAL. | | `allPorts` | `boolean` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By internal TCP/UDP load balancers, backend service-based network load balancers, and internal and external protocol forwarding. Set this field to true to allow packets addressed to any port or packets lacking destination port information (for example, UDP fragments after the first fragment) to be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | -| `portRange` | `string` | This field can only be used: - If IPProtocol is one of TCP, UDP, or SCTP. - By backend service-based network load balancers, target pool-based network load balancers, internal proxy load balancers, external proxy load balancers, Traffic Director, external protocol forwarding, and Classic VPN. Some products have restrictions on what ports can be used. See port specifications for details. Only packets addressed to ports in the specified range will be forwarded to the backends configured with this forwarding rule. The ports, port_range, and allPorts fields are mutually exclusive. For external forwarding rules, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. For internal forwarding rules within the same VPC network, two or more forwarding rules cannot use the same [IPAddress, IPProtocol] pair, and cannot have overlapping portRanges. @pattern: \\d+(?:-\\d+)? | -| `target` | `string` | The URL of the target resource to receive the matched traffic. For regional forwarding rules, this target must be in the same region as the forwarding rule. For global forwarding rules, this target must be a global load balancing resource. The forwarded traffic must be of a type appropriate to the target object. - For load balancers, see the "Target" column in [Port specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). - For Private Service Connect forwarding rules that forward traffic to Google APIs, provide the name of a supported Google API bundle: - vpc-sc - APIs that support VPC Service Controls. - all-apis - All supported Google APIs. - For Private Service Connect forwarding rules that forward traffic to managed services, the target must be a service attachment. The target is not mutable once set as a service attachment. | -| `noAutomateDnsZone` | `boolean` | This is used in PSC consumer ForwardingRule to control whether it should try to auto-generate a DNS zone or not. Non-PSC forwarding rules do not use this field. Once set, this field is not mutable. | +| `baseForwardingRule` | `string` | [Output Only] The URL for the corresponding base Forwarding Rule. By base Forwarding Rule, we mean the Forwarding Rule that has the same IP address, protocol, and port settings with the current Forwarding Rule, but without sourceIPRanges specified. Always empty if the current Forwarding Rule does not have sourceIPRanges specified. | +| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | +| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | +| `backendService` | `string` | Identifies the backend service to which the forwarding rule sends traffic. Required for Internal TCP/UDP Load Balancing and Network Load Balancing; must be omitted for all other load balancer types. | +| `networkTier` | `string` | This signifies the networking tier used for configuring this load balancer and can only take the following values: PREMIUM, STANDARD. For regional ForwardingRule, the valid values are PREMIUM and STANDARD. For GlobalForwardingRule, the valid value is PREMIUM. If this field is not specified, it is assumed to be PREMIUM. If IPAddress is specified, this value must be equal to the networkTier of the Address. | +| `IPAddress` | `string` | IP address for which this forwarding rule accepts traffic. When a client sends traffic to this IP address, the forwarding rule directs the traffic to the referenced target or backendService. While creating a forwarding rule, specifying an IPAddress is required under the following circumstances: - When the target is set to targetGrpcProxy and validateForProxyless is set to true, the IPAddress should be set to 0.0.0.0. - When the target is a Private Service Connect Google APIs bundle, you must specify an IPAddress. Otherwise, you can optionally specify an IP address that references an existing static (reserved) IP address resource. When omitted, Google Cloud assigns an ephemeral IP address. Use one of the following formats to specify an IP address while creating a forwarding rule: * IP address number, as in `100.1.2.3` * IPv6 address range, as in `2600:1234::/96` * Full resource URL, as in https://www.googleapis.com/compute/v1/projects/ project_id/regions/region/addresses/address-name * Partial URL or by name, as in: - projects/project_id/regions/region/addresses/address-name - regions/region/addresses/address-name - global/addresses/address-name - address-name The forwarding rule's target or backendService, and in most cases, also the loadBalancingScheme, determine the type of IP address that you can use. For detailed information, see [IP address specifications](https://cloud.google.com/load-balancing/docs/forwarding-rule-concepts#ip_address_specifications). When reading an IPAddress, the API always returns the IP address number. | | `allowPscGlobalAccess` | `boolean` | This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. | +| `sourceIpRanges` | `array` | If not empty, this Forwarding Rule will only forward the traffic when the source IP address matches one of the IP addresses or CIDR ranges set here. Note that a Forwarding Rule can only have up to 64 source IP ranges, and this field can only be used with a regional Forwarding Rule whose scheme is EXTERNAL. Each source_ip_range entry should be either an IP address (for example, 1.2.3.4) or a CIDR range (for example, 1.2.3.0/24). | | `allowGlobalAccess` | `boolean` | This field is used along with the backend_service field for internal load balancing or with the target field for internal TargetInstance. If set to true, clients can access the Internal TCP/UDP Load Balancer, Internal HTTP(S) and TCP Proxy Load Balancer from all regions. If false, only allows access from the local region the load balancer is located at. Note that for INTERNAL_MANAGED forwarding rules, this field cannot be changed after the forwarding rule is created. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ForwardingRule. Include the fingerprint in patch request to ensure that you do not overwrite changes that were applied from another concurrent request. To see the latest fingerprint, make a get() request to retrieve a ForwardingRule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md b/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md index 61bd1177d0..7b20411410 100644 --- a/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md +++ b/docs/google-docs/providers/google/compute/global_network_endpoint_groups/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | -| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | +| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | | `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | +| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | | `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | -| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | +| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | +| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | +| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | | `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | | `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | -| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | -| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | -| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | -| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/global_operations/index.md b/docs/google-docs/providers/google/compute/global_operations/index.md index 8fb42348e2..e50654f862 100644 --- a/docs/google-docs/providers/google/compute/global_operations/index.md +++ b/docs/google-docs/providers/google/compute/global_operations/index.md @@ -30,28 +30,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | -| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | | `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | | `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | -| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | | `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | | `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | | `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | +| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | +| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | +| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/global_organization_operations/index.md b/docs/google-docs/providers/google/compute/global_organization_operations/index.md index 8845203c5a..53f28aa056 100644 --- a/docs/google-docs/providers/google/compute/global_organization_operations/index.md +++ b/docs/google-docs/providers/google/compute/global_organization_operations/index.md @@ -30,28 +30,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | | `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | | `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | | `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | | `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | | `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | | `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | | `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md b/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md index 0584d4faf9..f03cab9fd7 100644 --- a/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md +++ b/docs/google-docs/providers/google/compute/global_public_delegated_prefixes/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | -| `parentPrefix` | `string` | The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. | -| `publicDelegatedSubPrefixs` | `array` | The list of sub public delegated prefixes that exist for this public delegated prefix. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `isLiveMigration` | `boolean` | If true, the prefix will be live migrated. | +| `region` | `string` | [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. | | `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by this public delegated prefix. | | `status` | `string` | [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. | -| `region` | `string` | [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `parentPrefix` | `string` | The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. | +| `isLiveMigration` | `boolean` | If true, the prefix will be live migrated. | +| `publicDelegatedSubPrefixs` | `array` | The list of sub public delegated prefixes that exist for this public delegated prefix. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/health_checks/index.md b/docs/google-docs/providers/google/compute/health_checks/index.md index 5378f1dd91..10f937a64a 100644 --- a/docs/google-docs/providers/google/compute/health_checks/index.md +++ b/docs/google-docs/providers/google/compute/health_checks/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `httpsHealthCheck` | `object` | | -| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | -| `type` | `string` | Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. | -| `grpcHealthCheck` | `object` | | +| `httpHealthCheck` | `object` | | | `sslHealthCheck` | `object` | | | `logConfig` | `object` | Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. | -| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | | `tcpHealthCheck` | `object` | | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | -| `httpHealthCheck` | `object` | | | `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | -| `http2HealthCheck` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `grpcHealthCheck` | `object` | | | `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | | `kind` | `string` | Type of the resource. | +| `http2HealthCheck` | `object` | | +| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `type` | `string` | Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | +| `httpsHealthCheck` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/http_health_checks/index.md b/docs/google-docs/providers/google/compute/http_health_checks/index.md index 9bc9c6dda1..f41fe778b9 100644 --- a/docs/google-docs/providers/google/compute/http_health_checks/index.md +++ b/docs/google-docs/providers/google/compute/http_health_checks/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `port` | `integer` | The TCP port number for the HTTP health check request. The default value is 80. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `host` | `string` | The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | | `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. | | `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | -| `port` | `integer` | The TCP port number for the HTTP health check request. The default value is 80. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | | `requestPath` | `string` | The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986. | -| `host` | `string` | The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/https_health_checks/index.md b/docs/google-docs/providers/google/compute/https_health_checks/index.md index de91fbfcdd..e18f128169 100644 --- a/docs/google-docs/providers/google/compute/https_health_checks/index.md +++ b/docs/google-docs/providers/google/compute/https_health_checks/index.md @@ -31,15 +31,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have a greater value than checkIntervalSec. | -| `host` | `string` | The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | -| `kind` | `string` | Type of the resource. | -| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | -| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `requestPath` | `string` | The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | | `port` | `integer` | The TCP port number for the HTTPS health check request. The default value is 443. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | Type of the resource. | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `host` | `string` | The value of the host header in the HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/images/index.md b/docs/google-docs/providers/google/compute/images/index.md index 05c87e7ff1..7f8856293d 100644 --- a/docs/google-docs/providers/google/compute/images/index.md +++ b/docs/google-docs/providers/google/compute/images/index.md @@ -30,35 +30,35 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `imageEncryptionKey` | `object` | | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#image for images. | -| `sourceSnapshotEncryptionKey` | `object` | | -| `archiveSizeBytes` | `string` | Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). | -| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. | -| `deprecated` | `object` | Deprecation status for a public resource. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `family` | `string` | The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. | -| `diskSizeGb` | `string` | Size of the image when restored onto a persistent disk (in GB). | -| `sourceSnapshotId` | `string` | [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. | +| `licenses` | `array` | Any applicable license URI. | | `sourceDisk` | `string` | URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | -| `shieldedInstanceInitialState` | `object` | Initial State for shielded instance, these are public keys which are safe to store in public | -| `sourceImage` | `string` | URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | -| `storageLocations` | `array` | Cloud Storage bucket storage location of the image (regional or multi-regional). | -| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. | | `labels` | `object` | Labels to apply to this image. These can be later modified by the setLabels method. | -| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. | -| `licenses` | `array` | Any applicable license URI. | +| `sourceImageEncryptionKey` | `object` | | | `rawDisk` | `object` | The parameters of the raw disk image. | -| `status` | `string` | [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. | | `sourceDiskEncryptionKey` | `object` | | -| `sourceType` | `string` | The type of the image used to create this disk. The default and only valid value is RAW. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this image. | +| `family` | `string` | The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. | +| `status` | `string` | [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. | +| `sourceImage` | `string` | URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | +| `deprecated` | `object` | Deprecation status for a public resource. | +| `storageLocations` | `array` | Cloud Storage bucket storage location of the image (regional or multi-regional). | +| `sourceSnapshotId` | `string` | [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `sourceSnapshot` | `string` | URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | +| `sourceSnapshotEncryptionKey` | `object` | | | `architecture` | `string` | The architecture of the image. Valid values are ARM64 or X86_64. | -| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this image. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an image. | -| `sourceImageEncryptionKey` | `object` | | +| `shieldedInstanceInitialState` | `object` | Initial State for shielded instance, these are public keys which are safe to store in public | +| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. | +| `archiveSizeBytes` | `string` | Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). | +| `imageEncryptionKey` | `object` | | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#image for images. | +| `diskSizeGb` | `string` | Size of the image when restored onto a persistent disk (in GB). | +| `sourceSnapshot` | `string` | URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL | +| `sourceType` | `string` | The type of the image used to create this disk. The default and only valid value is RAW. | +| `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/images_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/images_iam_audit_configs/index.md deleted file mode 100644 index fab5e1dfa0..0000000000 --- a/docs/google-docs/providers/google/compute/images_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: images_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - images_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameimages_iam_audit_configs
TypeResource
Idgoogle.compute.images_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `images_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/images_iam_bindings/index.md b/docs/google-docs/providers/google/compute/images_iam_bindings/index.md deleted file mode 100644 index 5c1c3f6cb1..0000000000 --- a/docs/google-docs/providers/google/compute/images_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: images_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - images_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameimages_iam_bindings
TypeResource
Idgoogle.compute.images_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `images_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/images_iam_policies/index.md b/docs/google-docs/providers/google/compute/images_iam_policies/index.md index 345e67f7da..d0700b5b0a 100644 --- a/docs/google-docs/providers/google/compute/images_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/images_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instance_group_managers/index.md b/docs/google-docs/providers/google/compute/instance_group_managers/index.md index 992726f4e2..7eacf53360 100644 --- a/docs/google-docs/providers/google/compute/instance_group_managers/index.md +++ b/docs/google-docs/providers/google/compute/instance_group_managers/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this resource type. The server generates this identifier. | | `name` | `string` | The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. | -| `instanceLifecyclePolicy` | `object` | | -| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | -| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | -| `status` | `object` | | -| `updatePolicy` | `object` | | -| `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | -| `statefulPolicy` | `object` | | -| `distributionPolicy` | `object` | | | `currentActions` | `object` | | | `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | +| `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | | `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | -| `targetSize` | `integer` | The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. | +| `targetPools` | `array` | The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. | +| `distributionPolicy` | `object` | | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | -| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | | `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | -| `targetPools` | `array` | The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. | -| `baseInstanceName` | `string` | The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. | +| `statefulPolicy` | `object` | | +| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | +| `targetSize` | `integer` | The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. | | `fingerprint` | `string` | Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. | +| `instanceLifecyclePolicy` | `object` | | +| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | +| `updatePolicy` | `object` | | | `instanceTemplate` | `string` | The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. | +| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | | `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | +| `baseInstanceName` | `string` | The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. | +| `status` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md b/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md index 741ee1bad1..5b5350ae42 100644 --- a/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md +++ b/docs/google-docs/providers/google/compute/instance_group_managers_errors/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `timestamp` | `string` | [Output Only] The time that this error occurred. This value is in RFC3339 text format. | | `error` | `object` | | | `instanceActionDetails` | `object` | | +| `timestamp` | `string` | [Output Only] The time that this error occurred. This value is in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instance_groups/index.md b/docs/google-docs/providers/google/compute/instance_groups/index.md index 9f94a0e867..f536d00421 100644 --- a/docs/google-docs/providers/google/compute/instance_groups/index.md +++ b/docs/google-docs/providers/google/compute/instance_groups/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this instance group, generated by the server. | | `name` | `string` | The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `namedPorts` | `array` | Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. | -| `selfLink` | `string` | [Output Only] The URL for this instance group. The server generates this URL. | -| `size` | `integer` | [Output Only] The total number of instances in the instance group. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | +| `network` | `string` | [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | | `subnetwork` | `string` | [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | -| `zone` | `string` | [Output Only] The URL of the zone where the instance group is located (for zonal resources). | -| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | -| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroup for instance groups. | | `region` | `string` | [Output Only] The URL of the region where the instance group is located (for regional resources). | -| `network` | `string` | [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | +| `size` | `integer` | [Output Only] The total number of instances in the instance group. | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroup for instance groups. | +| `namedPorts` | `array` | Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. | +| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | +| `zone` | `string` | [Output Only] The URL of the zone where the instance group is located (for zonal resources). | +| `selfLink` | `string` | [Output Only] The URL for this instance group. The server generates this URL. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instance_templates/index.md b/docs/google-docs/providers/google/compute/instance_templates/index.md index ee9e9fdede..61034b9bde 100644 --- a/docs/google-docs/providers/google/compute/instance_templates/index.md +++ b/docs/google-docs/providers/google/compute/instance_templates/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this instance template. The server defines this identifier. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `region` | `string` | [Output Only] URL of the region where the instance template resides. Only applicable for regional resources. | | `selfLink` | `string` | [Output Only] The URL for this instance template. The server defines this URL. | | `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance template in RFC3339 text format. | +| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | +| `region` | `string` | [Output Only] URL of the region where the instance template resides. Only applicable for regional resources. | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. | -| `properties` | `object` | | | `sourceInstance` | `string` | The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | -| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | +| `properties` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instance_templates_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/instance_templates_iam_audit_configs/index.md deleted file mode 100644 index fd6cd9481d..0000000000 --- a/docs/google-docs/providers/google/compute/instance_templates_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instance_templates_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - instance_templates_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameinstance_templates_iam_audit_configs
TypeResource
Idgoogle.compute.instance_templates_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instanceTemplates_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/instance_templates_iam_bindings/index.md b/docs/google-docs/providers/google/compute/instance_templates_iam_bindings/index.md deleted file mode 100644 index 51ccd4a441..0000000000 --- a/docs/google-docs/providers/google/compute/instance_templates_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: instance_templates_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - instance_templates_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameinstance_templates_iam_bindings
TypeResource
Idgoogle.compute.instance_templates_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instanceTemplates_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md b/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md index e143672c13..2c60929495 100644 --- a/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/instance_templates_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instances/index.md b/docs/google-docs/providers/google/compute/instances/index.md index 0d9c560bb4..9f73a609c0 100644 --- a/docs/google-docs/providers/google/compute/instances/index.md +++ b/docs/google-docs/providers/google/compute/instances/index.md @@ -31,47 +31,47 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | -| `metadata` | `object` | A metadata key/value entry. | -| `canIpForward` | `boolean` | Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding . | -| `advancedMachineFeatures` | `object` | Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). | -| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | -| `zone` | `string` | [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `displayDevice` | `object` | A set of Display Device options | -| `confidentialInstanceConfig` | `object` | A set of Confidential Instance options. | -| `disks` | `array` | Array of disks associated with this instance. Persistent disks must be created before you can assign them. | -| `resourceStatus` | `object` | Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. | -| `reservationAffinity` | `object` | Specifies the reservations that this instance can consume from. | -| `labelFingerprint` | `string` | A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. | -| `resourcePolicies` | `array` | Resource policies applied to this instance. | +| `guestAccelerators` | `array` | A list of the type and count of accelerator cards attached to the instance. | +| `lastSuspendedTimestamp` | `string` | [Output Only] Last suspended timestamp in RFC3339 text format. | +| `privateIpv6GoogleAccess` | `string` | The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. | | `networkPerformanceConfig` | `object` | | +| `shieldedInstanceIntegrityPolicy` | `object` | The policy describes the baseline against which Instance boot integrity is measured. | +| `metadata` | `object` | A metadata key/value entry. | +| `lastStartTimestamp` | `string` | [Output Only] Last start timestamp in RFC3339 text format. | +| `instanceEncryptionKey` | `object` | | +| `networkInterfaces` | `array` | An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. | | `serviceAccounts` | `array` | A list of service accounts, with their specified scopes, authorized for this instance. Only one service account per VM instance is supported. Service accounts generate access tokens that can be accessed through the metadata server and used to authenticate applications on the instance. See Service Accounts for more information. | -| `status` | `string` | [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. | -| `startRestricted` | `boolean` | [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. | -| `privateIpv6GoogleAccess` | `string` | The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. | -| `hostname` | `string` | Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. | -| `lastStopTimestamp` | `string` | [Output Only] Last stop timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#instance for instances. | -| `minCpuPlatform` | `string` | Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". | | `tags` | `object` | A set of instance tags. | -| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | -| `networkInterfaces` | `array` | An array of network configurations for this instance. These specify how interfaces are configured to interact with other network services, such as connecting to the internet. Multiple interfaces are supported per instance. | -| `sourceMachineImage` | `string` | Source machine image | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `machineType` | `string` | Full or partial URL of the machine type resource to use for this instance, in the format: zones/zone/machineTypes/machine-type. This is provided by the client when the instance is created. For example, the following is a valid partial url to a predefined machine type: zones/us-central1-f/machineTypes/n1-standard-1 To create a custom machine type, provide a URL to a machine type in the following format, where CPUS is 1 or an even number up to 32 (2, 4, 6, ... 24, etc), and MEMORY is the total memory for this instance. Memory must be a multiple of 256 MB and must be supplied in MB (e.g. 5 GB of memory is 5120 MB): zones/zone/machineTypes/custom-CPUS-MEMORY For example: zones/us-central1-f/machineTypes/custom-4-5120 For a full list of restrictions, read the Specifications for custom machine types. | -| `instanceEncryptionKey` | `object` | | -| `guestAccelerators` | `array` | A list of the type and count of accelerator cards attached to the instance. | -| `sourceMachineImageEncryptionKey` | `object` | | -| `params` | `object` | Additional instance params. | -| `keyRevocationActionType` | `string` | KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. | +| `labelFingerprint` | `string` | A fingerprint for this request, which is essentially a hash of the label's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the instance. | +| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | +| `confidentialInstanceConfig` | `object` | A set of Confidential Instance options. | +| `startRestricted` | `boolean` | [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. | | `labels` | `object` | Labels to apply to this instance. These can be later modified by the setLabels method. | -| `lastStartTimestamp` | `string` | [Output Only] Last start timestamp in RFC3339 text format. | -| `scheduling` | `object` | Sets the scheduling options for an Instance. | -| `lastSuspendedTimestamp` | `string` | [Output Only] Last suspended timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#instance for instances. | +| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the instance's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update the instance. You must always provide an up-to-date fingerprint hash in order to update the instance. To see the latest fingerprint, make get() request to the instance. | -| `shieldedInstanceIntegrityPolicy` | `object` | The policy describes the baseline against which Instance boot integrity is measured. | +| `sourceMachineImage` | `string` | Source machine image | +| `scheduling` | `object` | Sets the scheduling options for an Instance. | +| `resourcePolicies` | `array` | Resource policies applied to this instance. | +| `hostname` | `string` | Specifies the hostname of the instance. The specified hostname must be RFC1035 compliant. If hostname is not specified, the default hostname is [INSTANCE_NAME].c.[PROJECT_ID].internal when using the global DNS, and [INSTANCE_NAME].[ZONE].c.[PROJECT_ID].internal when using zonal DNS. | +| `deletionProtection` | `boolean` | Whether the resource should be protected against deletion. | +| `status` | `string` | [Output Only] The status of the instance. One of the following values: PROVISIONING, STAGING, RUNNING, STOPPING, SUSPENDING, SUSPENDED, REPAIRING, and TERMINATED. For more information about the status of the instance, see Instance life cycle. | +| `zone` | `string` | [Output Only] URL of the zone where the instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `keyRevocationActionType` | `string` | KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `params` | `object` | Additional instance params. | +| `sourceMachineImageEncryptionKey` | `object` | | +| `canIpForward` | `boolean` | Allows this instance to send and receive packets with non-matching destination or source IPs. This is required if you plan to use this instance to forward routes. For more information, see Enabling IP Forwarding . | +| `advancedMachineFeatures` | `object` | Specifies options for controlling advanced machine features. Options that would traditionally be configured in a BIOS belong here. Features that require operating system support may have corresponding entries in the GuestOsFeatures of an Image (e.g., whether or not the OS in the Image supports nested virtualization being enabled or disabled). | | `cpuPlatform` | `string` | [Output Only] The CPU platform used by this instance. | -| `deletionProtection` | `boolean` | Whether the resource should be protected against deletion. | +| `displayDevice` | `object` | A set of Display Device options | +| `lastStopTimestamp` | `string` | [Output Only] Last stop timestamp in RFC3339 text format. | +| `disks` | `array` | Array of disks associated with this instance. Persistent disks must be created before you can assign them. | +| `resourceStatus` | `object` | Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. | +| `reservationAffinity` | `object` | Specifies the reservations that this instance can consume from. | +| `minCpuPlatform` | `string` | Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instances_batch/index.md b/docs/google-docs/providers/google/compute/instances_batch/index.md deleted file mode 100644 index d569decc06..0000000000 --- a/docs/google-docs/providers/google/compute/instances_batch/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: instances_batch -hide_title: false -hide_table_of_contents: false -keywords: - - instances_batch - - compute - - 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 ---- - - - -## Overview - - - - -
Nameinstances_batch
TypeResource
Idgoogle.compute.instances_batch
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instances_bulkInsert` | `INSERT` | `project, zone` | diff --git a/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md b/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md index 38e9f20cdf..975649b3ed 100644 --- a/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md +++ b/docs/google-docs/providers/google/compute/instances_effective_firewalls/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `firewalls` | `array` | Effective firewalls on the instance. | | `firewallPolicys` | `array` | Effective firewalls from firewall policies. | +| `firewalls` | `array` | Effective firewalls on the instance. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md b/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md index 979afbbf57..3ae953ba04 100644 --- a/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md +++ b/docs/google-docs/providers/google/compute/instances_guest_attributes/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `variableValue` | `string` | [Output Only] The value found for the requested key. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. | | `queryPath` | `string` | The path to be queried. This can be the default namespace ('') or a nested namespace ('\/') or a specified key ('\/\'). | | `queryValue` | `object` | Array of guest attribute namespace/key/value tuples. | | `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | | `variableKey` | `string` | The key to search for. | +| `variableValue` | `string` | [Output Only] The value found for the requested key. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#guestAttributes for guest attributes entry. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instances_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/instances_iam_audit_configs/index.md deleted file mode 100644 index f55e154db9..0000000000 --- a/docs/google-docs/providers/google/compute/instances_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instances_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_audit_configs
TypeResource
Idgoogle.compute.instances_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instances_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/instances_iam_bindings/index.md b/docs/google-docs/providers/google/compute/instances_iam_bindings/index.md deleted file mode 100644 index 0d961353ff..0000000000 --- a/docs/google-docs/providers/google/compute/instances_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: instances_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_bindings
TypeResource
Idgoogle.compute.instances_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `instances_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/instances_iam_policies/index.md b/docs/google-docs/providers/google/compute/instances_iam_policies/index.md index 08ebac30a8..9eeea62b3a 100644 --- a/docs/google-docs/providers/google/compute/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/instances_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `rules` | `array` | This is deprecated and has no effect. Do not use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instances_screenshot/index.md b/docs/google-docs/providers/google/compute/instances_screenshot/index.md index 4c1dd577cf..51901e0561 100644 --- a/docs/google-docs/providers/google/compute/instances_screenshot/index.md +++ b/docs/google-docs/providers/google/compute/instances_screenshot/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `contents` | `string` | [Output Only] The Base64-encoded screenshot data. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#screenshot for the screenshots. | +| `contents` | `string` | [Output Only] The Base64-encoded screenshot data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md b/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md index 6093f91062..49d6b1b60a 100644 --- a/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md +++ b/docs/google-docs/providers/google/compute/instances_serial_port_output/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | | `start` | `string` | The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer (1 MB), older output is overwritten by newer content. The output start value will indicate the byte position of the output that was returned, which might be different than the `start` value that was specified in the request. | | `contents` | `string` | [Output Only] The contents of the console output. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output. | | `next` | `string` | [Output Only] The position of the next byte of content, regardless of whether the content exists, following the output returned in the `contents` property. Use this value in the next request as the start parameter. | +| `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/interconnect_attachments/index.md b/docs/google-docs/providers/google/compute/interconnect_attachments/index.md index 00130368b1..088ff9f4ed 100644 --- a/docs/google-docs/providers/google/compute/interconnect_attachments/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_attachments/index.md @@ -30,43 +30,43 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. | -| `encryption` | `string` | Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `candidateIpv6Subnets` | `array` | This field is not available. | +| `customerRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `customerRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | +| `subnetLength` | `integer` | Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. | +| `cloudRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | +| `edgeAvailabilityDomain` | `string` | Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. | +| `cloudRouterIpv6InterfaceId` | `string` | This field is not available. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. | +| `bandwidth` | `string` | Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s | +| `region` | `string` | [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `mtu` | `integer` | Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. | +| `state` | `string` | [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. | +| `privateInterconnectInfo` | `object` | Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. | +| `ipsecInternalAddresses` | `array` | A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool. | +| `configurationConstraints` | `object` | | | `remoteService` | `string` | [Output Only] If the attachment is on a Cross-Cloud Interconnect connection, this field contains the interconnect's remote location service provider. Example values: "Amazon Web Services" "Microsoft Azure". The field is set only for attachments on Cross-Cloud Interconnect connections. Its value is copied from the InterconnectRemoteLocation remoteService field. | | `interconnect` | `string` | URL of the underlying Interconnect object that this attachment's traffic will traverse through. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. | | `pairingKey` | `string` | [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of an PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" | -| `vlanTag8021q` | `integer` | The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time. | -| `adminEnabled` | `boolean` | Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. | -| `googleReferenceId` | `string` | [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. | -| `ipsecInternalAddresses` | `array` | A list of URLs of addresses that have been reserved for the VLAN attachment. Used only for the VLAN attachment that has the encryption option as IPSEC. The addresses must be regional internal IP address ranges. When creating an HA VPN gateway over the VLAN attachment, if the attachment is configured to use a regional internal IP address, then the VPN gateway's IP address is allocated from the IP address range specified here. For example, if the HA VPN gateway's interface 0 is paired to this VLAN attachment, then a regional internal IP address for the VPN gateway interface 0 will be allocated from the IP address specified for this VLAN attachment. If this field is not specified when creating the VLAN attachment, then later on when creating an HA VPN gateway on this VLAN attachment, the HA VPN gateway's IP address is allocated from the regional external IP address pool. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `configurationConstraints` | `object` | | -| `cloudRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | -| `dataplaneVersion` | `integer` | [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. | -| `mtu` | `integer` | Maximum Transmission Unit (MTU), in bytes, of packets passing through this interconnect attachment. Only 1440 and 1500 are allowed. If not specified, the value will default to 1440. | -| `router` | `string` | URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. | -| `region` | `string` | [Output Only] URL of the region where the regional interconnect attachment resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `subnetLength` | `integer` | Length of the IPv4 subnet mask. Allowed values: - 29 (default) - 30 The default value is 29, except for Cross-Cloud Interconnect connections that use an InterconnectRemoteLocation with a constraints.subnetLengthRange.min equal to 30. For example, connections that use an Azure remote location fall into this category. In these cases, the default value is 30, and requesting 29 returns an error. Where both 29 and 30 are allowed, 29 is preferred, because it gives Google Cloud Support more debugging visibility. | -| `candidateIpv6Subnets` | `array` | This field is not available. | -| `customerRouterIpv6InterfaceId` | `string` | This field is not available. | -| `customerRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `candidateSubnets` | `array` | Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `type` | `string` | The type of interconnect attachment this is, which can take one of the following values: - DEDICATED: an attachment to a Dedicated Interconnect. - PARTNER: an attachment to a Partner Interconnect, created by the customer. - PARTNER_PROVIDER: an attachment to a Partner Interconnect, created by the partner. | +| `candidateSubnets` | `array` | Up to 16 candidate prefixes that can be used to restrict the allocation of cloudRouterIpAddress and customerRouterIpAddress for this attachment. All prefixes must be within link-local address space (169.254.0.0/16) and must be /29 or shorter (/28, /27, etc). Google will attempt to select an unused /29 from the supplied candidate prefix(es). The request will fail if all possible /29s are in use on Google's edge. If not supplied, Google will randomly select an unused /29 from all of link-local space. | +| `customerRouterIpv6InterfaceId` | `string` | This field is not available. | +| `dataplaneVersion` | `integer` | [Output Only] Dataplane version for this InterconnectAttachment. This field is only present for Dataplane version 2 and higher. Absence of this field in the API output indicates that the Dataplane is version 1. | | `partnerMetadata` | `object` | Informational metadata about Partner attachments from Partners to display to customers. These fields are propagated from PARTNER_PROVIDER attachments to their corresponding PARTNER attachments. | -| `cloudRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | -| `state` | `string` | [Output Only] The current state of this attachment's functionality. Enum values ACTIVE and UNPROVISIONED are shared by DEDICATED/PRIVATE, PARTNER, and PARTNER_PROVIDER interconnect attachments, while enum values PENDING_PARTNER, PARTNER_REQUEST_RECEIVED, and PENDING_CUSTOMER are used for only PARTNER and PARTNER_PROVIDER interconnect attachments. This state can take one of the following values: - ACTIVE: The attachment has been turned up and is ready to use. - UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. - PENDING_PARTNER: A newly-created PARTNER attachment that has not yet been configured on the Partner side. - PARTNER_REQUEST_RECEIVED: A PARTNER attachment is in the process of provisioning after a PARTNER_PROVIDER attachment was created that references it. - PENDING_CUSTOMER: A PARTNER or PARTNER_PROVIDER attachment that is waiting for a customer to activate it. - DEFUNCT: The attachment was deleted externally and is no longer functional. This could be because the associated Interconnect was removed, or because the other side of a Partner attachment was deleted. | -| `privateInterconnectInfo` | `object` | Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. | -| `bandwidth` | `string` | Provisioned bandwidth capacity for the interconnect attachment. For attachments of type DEDICATED, the user can set the bandwidth. For attachments of type PARTNER, the Google Partner that is operating the interconnect must set the bandwidth. Output only for PARTNER type, mutable for PARTNER_PROVIDER and DEDICATED, and can take one of the following values: - BPS_50M: 50 Mbit/s - BPS_100M: 100 Mbit/s - BPS_200M: 200 Mbit/s - BPS_300M: 300 Mbit/s - BPS_400M: 400 Mbit/s - BPS_500M: 500 Mbit/s - BPS_1G: 1 Gbit/s - BPS_2G: 2 Gbit/s - BPS_5G: 5 Gbit/s - BPS_10G: 10 Gbit/s - BPS_20G: 20 Gbit/s - BPS_50G: 50 Gbit/s | -| `customerRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | -| `stackType` | `string` | The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. | | `operationalStatus` | `string` | [Output Only] The current status of whether or not this interconnect attachment is functional, which can take one of the following values: - OS_ACTIVE: The attachment has been turned up and is ready to use. - OS_UNPROVISIONED: The attachment is not ready to use yet, because turnup is not complete. | -| `cloudRouterIpv6InterfaceId` | `string` | This field is not available. | -| `edgeAvailabilityDomain` | `string` | Desired availability domain for the attachment. Only available for type PARTNER, at creation time, and can take one of the following values: - AVAILABILITY_DOMAIN_ANY - AVAILABILITY_DOMAIN_1 - AVAILABILITY_DOMAIN_2 For improved reliability, customers should configure a pair of attachments, one per availability domain. The selected availability domain will be provided to the Partner via the pairing key, so that the provisioned circuit will lie in the specified domain. If not specified, the value will default to AVAILABILITY_DOMAIN_ANY. | +| `router` | `string` | URL of the Cloud Router to be used for dynamic routing. This router must be in the same region as this InterconnectAttachment. The InterconnectAttachment will automatically connect the Interconnect to the network & region within which the Cloud Router is configured. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this InterconnectAttachment, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InterconnectAttachment. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `partnerAsn` | `string` | Optional BGP ASN for the router supplied by a Layer 3 Partner if they configured BGP on behalf of the customer. Output only for PARTNER type, input only for PARTNER_PROVIDER, not available for DEDICATED. | +| `googleReferenceId` | `string` | [Output Only] Google reference ID, to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. [Deprecated] This field is not used. | +| `vlanTag8021q` | `integer` | The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time. | +| `adminEnabled` | `boolean` | Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `cloudRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | +| `stackType` | `string` | The stack type for this interconnect attachment to identify whether the IPv6 feature is enabled or not. If not specified, IPV4_ONLY will be used. This field can be both set at interconnect attachments creation and update interconnect attachment operations. | +| `encryption` | `string` | Indicates the user-supplied encryption option of this VLAN attachment (interconnectAttachment). Can only be specified at attachment creation for PARTNER or DEDICATED attachments. Possible values are: - NONE - This is the default value, which means that the VLAN attachment carries unencrypted traffic. VMs are able to send traffic to, or receive traffic from, such a VLAN attachment. - IPSEC - The VLAN attachment carries only encrypted traffic that is encrypted by an IPsec device, such as an HA VPN gateway or third-party IPsec VPN. VMs cannot directly send traffic to, or receive traffic from, such a VLAN attachment. To use *HA VPN over Cloud Interconnect*, the VLAN attachment must be created with this option. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/interconnect_locations/index.md b/docs/google-docs/providers/google/compute/interconnect_locations/index.md index bc6162ea4f..97c96244b8 100644 --- a/docs/google-docs/providers/google/compute/interconnect_locations/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_locations/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of the resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | -| `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | -| `status` | `string` | [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `city` | `string` | [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. | | `regionInfos` | `array` | [Output Only] A list of InterconnectLocation.RegionInfo objects, that describe parameters pertaining to the relation between this InterconnectLocation and various Google Cloud regions. | -| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | | `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | +| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | | `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | -| `availabilityZone` | `string` | [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | +| `city` | `string` | [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | +| `status` | `string` | [Output Only] The status of this InterconnectLocation, which can take one of the following values: - CLOSED: The InterconnectLocation is closed and is unavailable for provisioning new Interconnects. - AVAILABLE: The InterconnectLocation is available for provisioning new Interconnects. | +| `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | +| `availabilityZone` | `string` | [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md b/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md index f06e1342fb..a14745a868 100644 --- a/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_remote_locations/index.md @@ -30,23 +30,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of the resource. | -| `maxLagSize10Gbps` | `integer` | [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. | -| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | -| `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | | `attachmentConfigurationConstraints` | `object` | | -| `permittedConnections` | `array` | [Output Only] Permitted connections. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations. | -| `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | -| `remoteService` | `string` | [Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure". | -| `status` | `string` | [Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. | -| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `constraints` | `object` | | -| `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | | `lacp` | `string` | [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED | +| `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | +| `maxLagSize10Gbps` | `integer` | [Output Only] The maximum number of 10 Gbps ports supported in a link aggregation group (LAG). When linkType is 10 Gbps, requestedLinkCount cannot exceed max_lag_size_10_gbps. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectRemoteLocation for interconnect remote locations. | | `city` | `string` | [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". | +| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | +| `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | +| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | +| `constraints` | `object` | | | `maxLagSize100Gbps` | `integer` | [Output Only] The maximum number of 100 Gbps ports supported in a link aggregation group (LAG). When linkType is 100 Gbps, requestedLinkCount cannot exceed max_lag_size_100_gbps. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `remoteService` | `string` | [Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure". | +| `permittedConnections` | `array` | [Output Only] Permitted connections. | +| `status` | `string` | [Output Only] The status of this InterconnectRemoteLocation, which can take one of the following values: - CLOSED: The InterconnectRemoteLocation is closed and is unavailable for provisioning new Cross-Cloud Interconnects. - AVAILABLE: The InterconnectRemoteLocation is available for provisioning new Cross-Cloud Interconnects. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/interconnects/index.md b/docs/google-docs/providers/google/compute/interconnects/index.md index 3d319ab30a..b2c657ee9d 100644 --- a/docs/google-docs/providers/google/compute/interconnects/index.md +++ b/docs/google-docs/providers/google/compute/interconnects/index.md @@ -30,29 +30,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `googleIpAddress` | `string` | [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this Interconnect, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an Interconnect. | -| `location` | `string` | URL of the InterconnectLocation object that represents where this connection is to be provisioned. | -| `peerIpAddress` | `string` | [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. | +| `provisionedLinkCount` | `integer` | [Output Only] Number of links actually provisioned in this interconnect. | | `remoteLocation` | `string` | Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. | -| `nocContactEmail` | `string` | Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `adminEnabled` | `boolean` | Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. | -| `interconnectType` | `string` | Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `circuitInfos` | `array` | [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. | -| `customerName` | `string` | Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. | -| `provisionedLinkCount` | `integer` | [Output Only] Number of links actually provisioned in this interconnect. | -| `interconnectAttachments` | `array` | [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. | | `expectedOutages` | `array` | [Output Only] A list of outages expected for this Interconnect. | +| `peerIpAddress` | `string` | [Output Only] IP address configured on the customer side of the Interconnect link. The customer should configure this IP address during turnup when prompted by Google NOC. This can be used only for ping tests. | +| `customerName` | `string` | Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `location` | `string` | URL of the InterconnectLocation object that represents where this connection is to be provisioned. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnect for interconnects. | | `linkType` | `string` | Type of link requested, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR: A 10G Ethernet with LR optics - LINK_TYPE_ETHERNET_100G_LR: A 100G Ethernet with LR optics. Note that this field indicates the speed of each of the links in the bundle, not the speed of the entire bundle. | +| `state` | `string` | [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. | +| `interconnectAttachments` | `array` | [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `adminEnabled` | `boolean` | Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. | +| `circuitInfos` | `array` | [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. | +| `googleReferenceId` | `string` | [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. | +| `interconnectType` | `string` | Type of interconnect, which can take one of the following values: - PARTNER: A partner-managed interconnection shared between customers though a partner. - DEDICATED: A dedicated physical interconnection with the customer. Note that a value IT_PRIVATE has been deprecated in favor of DEDICATED. | +| `nocContactEmail` | `string` | Email address to contact the customer NOC for operations and maintenance notifications regarding this Interconnect. If specified, this will be used for notifications in addition to all other forms described, such as Cloud Monitoring logs alerting and Cloud Notifications. This field is required for users who sign up for Cloud Interconnect using workforce identity federation. | +| `googleIpAddress` | `string` | [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. | | `operationalStatus` | `string` | [Output Only] The current status of this Interconnect's functionality, which can take one of the following values: - OS_ACTIVE: A valid Interconnect, which is turned up and is ready to use. Attachments may be provisioned on this Interconnect. - OS_UNPROVISIONED: An Interconnect that has not completed turnup. No attachments may be provisioned on this Interconnect. - OS_UNDER_MAINTENANCE: An Interconnect that is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. | | `requestedLinkCount` | `integer` | Target number of physical links in the link bundle, as requested by the customer. | -| `googleReferenceId` | `string` | [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. | -| `state` | `string` | [Output Only] The current state of Interconnect functionality, which can take one of the following values: - ACTIVE: The Interconnect is valid, turned up and ready to use. Attachments may be provisioned on this Interconnect. - UNPROVISIONED: The Interconnect has not completed turnup. No attachments may be provisioned on this Interconnect. - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance. No attachments may be provisioned or updated on this Interconnect. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/license_codes/index.md b/docs/google-docs/providers/google/compute/license_codes/index.md index 96428ea83a..6e17a5ac8a 100644 --- a/docs/google-docs/providers/google/compute/license_codes/index.md +++ b/docs/google-docs/providers/google/compute/license_codes/index.md @@ -30,11 +30,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer. | | `description` | `string` | [Output Only] Description of this License Code. | +| `state` | `string` | [Output Only] Current state of this License Code. | +| `licenseAlias` | `array` | [Output Only] URL and description aliases of Licenses with the same License Code. | +| `transferable` | `boolean` | [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. | | `kind` | `string` | [Output Only] Type of resource. Always compute#licenseCode for licenses. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `transferable` | `boolean` | [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred. | -| `licenseAlias` | `array` | [Output Only] URL and description aliases of Licenses with the same License Code. | -| `state` | `string` | [Output Only] Current state of this License Code. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | diff --git a/docs/google-docs/providers/google/compute/licenses/index.md b/docs/google-docs/providers/google/compute/licenses/index.md index 74b82bb330..4b96bf712f 100644 --- a/docs/google-docs/providers/google/compute/licenses/index.md +++ b/docs/google-docs/providers/google/compute/licenses/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. The name must be 1-63 characters long and comply with RFC1035. | | `description` | `string` | An optional textual description of the resource; provided by the client when the resource is created. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `transferable` | `boolean` | If false, licenses will not be copied from the source resource when creating an image from a disk, disk from snapshot, or snapshot from disk. | +| `resourceRequirements` | `object` | | | `chargesUseFee` | `boolean` | [Output Only] Deprecated. This field no longer reflects whether a license charges a usage fee. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of resource. Always compute#license for licenses. | -| `resourceRequirements` | `object` | | | `licenseCode` | `string` | [Output Only] The unique code used to attach this license to images, snapshots, and disks. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/licenses_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/licenses_iam_audit_configs/index.md deleted file mode 100644 index 00faa4f29a..0000000000 --- a/docs/google-docs/providers/google/compute/licenses_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: licenses_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - licenses_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namelicenses_iam_audit_configs
TypeResource
Idgoogle.compute.licenses_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `licenses_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/licenses_iam_bindings/index.md b/docs/google-docs/providers/google/compute/licenses_iam_bindings/index.md deleted file mode 100644 index 0ce13abf4e..0000000000 --- a/docs/google-docs/providers/google/compute/licenses_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: licenses_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - licenses_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namelicenses_iam_bindings
TypeResource
Idgoogle.compute.licenses_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `licenses_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/machine_images/index.md b/docs/google-docs/providers/google/compute/machine_images/index.md index c21e3020d5..f5b519a0e0 100644 --- a/docs/google-docs/providers/google/compute/machine_images/index.md +++ b/docs/google-docs/providers/google/compute/machine_images/index.md @@ -30,20 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this machine image. The server defines this identifier. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `totalStorageBytes` | `string` | [Output Only] Total size of the storage used by the machine image. | -| `machineImageEncryptionKey` | `object` | | | `guestFlush` | `boolean` | [Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process. | -| `sourceInstance` | `string` | The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | -| `status` | `string` | [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `kind` | `string` | [Output Only] The resource type, which is always compute#machineImage for machine image. | | `savedDisks` | `array` | An array of Machine Image specific properties for disks attached to the source instance | +| `sourceInstance` | `string` | The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | | `storageLocations` | `array` | The regional or multi-regional Cloud Storage bucket location where the machine image is stored. | -| `instanceProperties` | `object` | | +| `status` | `string` | [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. | | `sourceDiskEncryptionKeys` | `array` | [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key. | +| `instanceProperties` | `object` | | +| `totalStorageBytes` | `string` | [Output Only] Total size of the storage used by the machine image. | | `sourceInstanceProperties` | `object` | DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field. | -| `selfLink` | `string` | [Output Only] The URL for this machine image. The server defines this URL. | +| `kind` | `string` | [Output Only] The resource type, which is always compute#machineImage for machine image. | | `creationTimestamp` | `string` | [Output Only] The creation timestamp for this machine image in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] The URL for this machine image. The server defines this URL. | +| `machineImageEncryptionKey` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/machine_images_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/machine_images_iam_audit_configs/index.md deleted file mode 100644 index 89642ae6d9..0000000000 --- a/docs/google-docs/providers/google/compute/machine_images_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: machine_images_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - machine_images_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namemachine_images_iam_audit_configs
TypeResource
Idgoogle.compute.machine_images_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `machineImages_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/machine_images_iam_bindings/index.md b/docs/google-docs/providers/google/compute/machine_images_iam_bindings/index.md deleted file mode 100644 index aed8818253..0000000000 --- a/docs/google-docs/providers/google/compute/machine_images_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: machine_images_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - machine_images_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namemachine_images_iam_bindings
TypeResource
Idgoogle.compute.machine_images_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `machineImages_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md b/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md index 9799ba481a..048dac0b51 100644 --- a/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/machine_images_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/machine_types/index.md b/docs/google-docs/providers/google/compute/machine_types/index.md index 6ee62951e8..7cce11eeaf 100644 --- a/docs/google-docs/providers/google/compute/machine_types/index.md +++ b/docs/google-docs/providers/google/compute/machine_types/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional textual description of the resource. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#machineType for machine types. | +| `scratchDisks` | `array` | [Output Only] A list of extended scratch disks assigned to the instance. | | `zone` | `string` | [Output Only] The name of the zone where the machine type resides, such as us-central1-a. | -| `maximumPersistentDisksSizeGb` | `string` | [Output Only] Maximum total persistent disks size (GB) allowed. | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#machineType for machine types. | +| `imageSpaceGb` | `integer` | [Deprecated] This property is deprecated and will never be populated with any relevant values. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `accelerators` | `array` | [Output Only] A list of accelerator configurations assigned to this machine type. | -| `scratchDisks` | `array` | [Output Only] A list of extended scratch disks assigned to the instance. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the instance, defined in MB. | +| `guestCpus` | `integer` | [Output Only] The number of virtual CPUs that are available to the instance. | | `deprecated` | `object` | Deprecation status for a public resource. | | `maximumPersistentDisks` | `integer` | [Output Only] Maximum persistent disks allowed. | -| `imageSpaceGb` | `integer` | [Deprecated] This property is deprecated and will never be populated with any relevant values. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `isSharedCpu` | `boolean` | [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `guestCpus` | `integer` | [Output Only] The number of virtual CPUs that are available to the instance. | -| `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the instance, defined in MB. | +| `maximumPersistentDisksSizeGb` | `string` | [Output Only] Maximum total persistent disks size (GB) allowed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_attachments/index.md b/docs/google-docs/providers/google/compute/network_attachments/index.md index 0d08274555..40c33bcb52 100644 --- a/docs/google-docs/providers/google/compute/network_attachments/index.md +++ b/docs/google-docs/providers/google/compute/network_attachments/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `subnetworks` | `array` | An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment. | +| `kind` | `string` | [Output Only] Type of the resource. | +| `connectionPreference` | `string` | | +| `connectionEndpoints` | `array` | [Output Only] An array of connections for all the producers connected to this network attachment. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `network` | `string` | [Output Only] The URL of the network which the Network Attachment belongs to. Practically it is inferred by fetching the network of the first subnetwork associated. Because it is required that all the subnetworks must be from the same network, it is assured that the Network Attachment belongs to the same network as all the subnetworks. | -| `producerRejectLists` | `array` | Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource's resource id. | | `producerAcceptLists` | `array` | Projects that are allowed to connect to this network attachment. The project can be specified using its id or number. | -| `kind` | `string` | [Output Only] Type of the resource. | -| `region` | `string` | [Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `connectionEndpoints` | `array` | [Output Only] An array of connections for all the producers connected to this network attachment. | -| `connectionPreference` | `string` | | +| `region` | `string` | [Output Only] URL of the region where the network attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `producerRejectLists` | `array` | Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number. | +| `subnetworks` | `array` | An array of URLs where each entry is the URL of a subnet provided by the service consumer to use for endpoints in the producers that connect to this network attachment. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. An up-to-date fingerprint must be provided in order to patch. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource's resource id. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_attachments_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/network_attachments_iam_audit_configs/index.md deleted file mode 100644 index c03d3d617a..0000000000 --- a/docs/google-docs/providers/google/compute/network_attachments_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: network_attachments_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - network_attachments_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namenetwork_attachments_iam_audit_configs
TypeResource
Idgoogle.compute.network_attachments_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `networkAttachments_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/network_attachments_iam_bindings/index.md b/docs/google-docs/providers/google/compute/network_attachments_iam_bindings/index.md deleted file mode 100644 index d0e6ca1db0..0000000000 --- a/docs/google-docs/providers/google/compute/network_attachments_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: network_attachments_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - network_attachments_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namenetwork_attachments_iam_bindings
TypeResource
Idgoogle.compute.network_attachments_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `networkAttachments_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md b/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md index d43279000e..7d9d09687d 100644 --- a/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/network_attachments_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_edge_security_services/index.md b/docs/google-docs/providers/google/compute/network_edge_security_services/index.md index 5a8f949041..1ef6348725 100644 --- a/docs/google-docs/providers/google/compute/network_edge_security_services/index.md +++ b/docs/google-docs/providers/google/compute/network_edge_security_services/index.md @@ -30,12 +30,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService. | | `region` | `string` | [Output Only] URL of the region where the resource resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `securityPolicy` | `string` | The resource URL for the network edge security service associated with this network edge security service. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a NetworkEdgeSecurityService. An up-to-date fingerprint must be provided in order to update the NetworkEdgeSecurityService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a NetworkEdgeSecurityService. | -| `securityPolicy` | `string` | The resource URL for the network edge security service associated with this network edge security service. | | `kind` | `string` | [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md b/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md index aca261b696..a99c5a0db0 100644 --- a/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md +++ b/docs/google-docs/providers/google/compute/network_endpoint_groups/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | | `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | -| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | -| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | -| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | | `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | -| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | -| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | +| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | -| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | +| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | +| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | | `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | -| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | +| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | +| `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | +| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | +| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies/index.md index 84ad70c86f..c87dba95a0 100644 --- a/docs/google-docs/providers/google/compute/network_firewall_policies/index.md +++ b/docs/google-docs/providers/google/compute/network_firewall_policies/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `associations` | `array` | A list of associations that belong to this firewall policy. | | `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | -| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | +| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | | `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | +| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | +| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | +| `associations` | `array` | A list of associations that belong to this firewall policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies_association/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_association/index.md index 6ffbe28a7b..3700e904f6 100644 --- a/docs/google-docs/providers/google/compute/network_firewall_policies_association/index.md +++ b/docs/google-docs/providers/google/compute/network_firewall_policies_association/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name for an association. | -| `shortName` | `string` | [Output Only] The short name of the firewall policy of the association. | | `attachmentTarget` | `string` | The target that the firewall policy is attached to. | | `displayName` | `string` | [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. | | `firewallPolicyId` | `string` | [Output Only] The firewall policy ID of the association. | +| `shortName` | `string` | [Output Only] The short name of the firewall policy of the association. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_iam_audit_configs/index.md deleted file mode 100644 index 33aa99f458..0000000000 --- a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: network_firewall_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - network_firewall_policies_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namenetwork_firewall_policies_iam_audit_configs
TypeResource
Idgoogle.compute.network_firewall_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `networkFirewallPolicies_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_bindings/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_iam_bindings/index.md deleted file mode 100644 index a487da8b1d..0000000000 --- a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: network_firewall_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - network_firewall_policies_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namenetwork_firewall_policies_iam_bindings
TypeResource
Idgoogle.compute.network_firewall_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `networkFirewallPolicies_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md index 17dfbeaf83..02199b5742 100644 --- a/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `rules` | `array` | This is deprecated and has no effect. Do not use. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md index b45dda99e0..e83638caea 100644 --- a/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/network_firewall_policies_rule/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | An optional description for this resource. | -| `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | -| `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | -| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | -| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | | `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | -| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | +| `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | | `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | -| `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | +| `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | +| `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | | `direction` | `string` | The direction in which this rule applies. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | +| `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | | `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | | `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | +| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | +| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/networks/index.md b/docs/google-docs/providers/google/compute/networks/index.md index 5b8415023f..a7609e552e 100644 --- a/docs/google-docs/providers/google/compute/networks/index.md +++ b/docs/google-docs/providers/google/compute/networks/index.md @@ -30,21 +30,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | -| `routingConfig` | `object` | A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `enableUlaInternalIpv6` | `boolean` | Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. . | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#network for networks. | -| `internalIpv6Range` | `string` | When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. . | -| `IPv4Range` | `string` | Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. | -| `gatewayIPv4` | `string` | [Output Only] The gateway address for default routing out of the network, selected by Google Cloud. | +| `firewallPolicy` | `string` | [Output Only] URL of the firewall policy the network is associated with. | | `peerings` | `array` | [Output Only] A list of network peerings for the resource. | +| `networkFirewallPolicyEnforcementOrder` | `string` | The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `subnetworks` | `array` | [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. | -| `firewallPolicy` | `string` | [Output Only] URL of the firewall policy the network is associated with. | | `mtu` | `integer` | Maximum Transmission Unit in bytes. The minimum value for this field is 1300 and the maximum value is 8896. The suggested value is 1500, which is the default MTU used on the Internet, or 8896 if you want to use Jumbo frames. If unspecified, the value defaults to 1460. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#network for networks. | +| `subnetworks` | `array` | [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. | +| `IPv4Range` | `string` | Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. | | `autoCreateSubnetworks` | `boolean` | Must be set to create a VPC network. If not set, a legacy network is created. When set to true, the VPC network is created in auto mode. When set to false, the VPC network is created in custom mode. An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. For custom mode VPC networks, you can add subnets using the subnetworks insert method. | -| `networkFirewallPolicyEnforcementOrder` | `string` | The network firewall policy enforcement order. Can be either AFTER_CLASSIC_FIREWALL or BEFORE_CLASSIC_FIREWALL. Defaults to AFTER_CLASSIC_FIREWALL if the field is not specified. | +| `routingConfig` | `object` | A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | +| `gatewayIPv4` | `string` | [Output Only] The gateway address for default routing out of the network, selected by Google Cloud. | +| `internalIpv6Range` | `string` | When enabling ula internal ipv6, caller optionally can specify the /48 range they want from the google defined ULA prefix fd20::/20. The input must be a valid /48 ULA IPv6 address and must be within the fd20::/20. Operation will fail if the speficied /48 is already in used by another resource. If the field is not speficied, then a /48 range will be randomly allocated from fd20::/20 and returned via this field. . | +| `enableUlaInternalIpv6` | `boolean` | Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. . | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/networks_effective_firewalls/index.md b/docs/google-docs/providers/google/compute/networks_effective_firewalls/index.md index bcb5ee93d5..40bd666ce9 100644 --- a/docs/google-docs/providers/google/compute/networks_effective_firewalls/index.md +++ b/docs/google-docs/providers/google/compute/networks_effective_firewalls/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `firewallPolicys` | `array` | Effective firewalls from firewall policy. | | `firewalls` | `array` | Effective firewalls on the network. | +| `firewallPolicys` | `array` | Effective firewalls from firewall policy. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/networks_peering_routes/index.md b/docs/google-docs/providers/google/compute/networks_peering_routes/index.md index 3fc9f38eb4..d21b404fe4 100644 --- a/docs/google-docs/providers/google/compute/networks_peering_routes/index.md +++ b/docs/google-docs/providers/google/compute/networks_peering_routes/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `type` | `string` | The type of the peering route. | +| `destRange` | `string` | The destination range of the route. | | `imported` | `boolean` | True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict. | | `nextHopRegion` | `string` | The region of peering route next hop, only applies to dynamic routes. | | `priority` | `integer` | The priority of the peering route. | -| `type` | `string` | The type of the peering route. | -| `destRange` | `string` | The destination range of the route. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/node_groups/index.md b/docs/google-docs/providers/google/compute/node_groups/index.md index 0ad8c618da..c34139dcd8 100644 --- a/docs/google-docs/providers/google/compute/node_groups/index.md +++ b/docs/google-docs/providers/google/compute/node_groups/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `maintenancePolicy` | `string` | Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. | | `size` | `integer` | [Output Only] The total number of nodes in the node group. | -| `nodeTemplate` | `string` | URL of the node template to create the node group from. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `locationHint` | `string` | An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate. | -| `fingerprint` | `string` | | -| `autoscalingPolicy` | `object` | | | `maintenanceWindow` | `object` | Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. | +| `fingerprint` | `string` | | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeGroup for node group. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `status` | `string` | | -| `maintenancePolicy` | `string` | Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. | +| `locationHint` | `string` | An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate. | | `zone` | `string` | [Output Only] The name of the zone where the node group resides, such as us-central1-a. | +| `autoscalingPolicy` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `nodeTemplate` | `string` | URL of the node template to create the node group from. | +| `status` | `string` | | | `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeGroup for node group. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/node_groups_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/node_groups_iam_audit_configs/index.md deleted file mode 100644 index daa3198623..0000000000 --- a/docs/google-docs/providers/google/compute/node_groups_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: node_groups_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - node_groups_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namenode_groups_iam_audit_configs
TypeResource
Idgoogle.compute.node_groups_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `nodeGroups_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/node_groups_iam_bindings/index.md b/docs/google-docs/providers/google/compute/node_groups_iam_bindings/index.md deleted file mode 100644 index 19f44d8cc8..0000000000 --- a/docs/google-docs/providers/google/compute/node_groups_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: node_groups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - node_groups_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namenode_groups_iam_bindings
TypeResource
Idgoogle.compute.node_groups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `nodeGroups_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md b/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md index 1f4f33ae5b..52874f6181 100644 --- a/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/node_groups_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/node_templates/index.md b/docs/google-docs/providers/google/compute/node_templates/index.md index 735d7f817e..a0b90322bc 100644 --- a/docs/google-docs/providers/google/compute/node_templates/index.md +++ b/docs/google-docs/providers/google/compute/node_templates/index.md @@ -31,18 +31,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | -| `status` | `string` | [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. | -| `cpuOvercommitType` | `string` | CPU overcommit. | | `accelerators` | `array` | | -| `region` | `string` | [Output Only] The name of the region where the node template resides, such as us-central1. | -| `disks` | `array` | | -| `nodeTypeFlexibility` | `object` | | | `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. | | `serverBinding` | `object` | | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `nodeAffinityLabels` | `object` | Labels to use for node affinity, which will be used in instance scheduling. | | `nodeType` | `string` | The node type to use for nodes group that are created from this template. | +| `status` | `string` | [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `region` | `string` | [Output Only] The name of the region where the node template resides, such as us-central1. | +| `nodeTypeFlexibility` | `object` | | +| `cpuOvercommitType` | `string` | CPU overcommit. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `nodeAffinityLabels` | `object` | Labels to use for node affinity, which will be used in instance scheduling. | +| `disks` | `array` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/node_templates_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/node_templates_iam_audit_configs/index.md deleted file mode 100644 index 0e4103eac2..0000000000 --- a/docs/google-docs/providers/google/compute/node_templates_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: node_templates_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - node_templates_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namenode_templates_iam_audit_configs
TypeResource
Idgoogle.compute.node_templates_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `nodeTemplates_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/node_templates_iam_bindings/index.md b/docs/google-docs/providers/google/compute/node_templates_iam_bindings/index.md deleted file mode 100644 index 14caea6ade..0000000000 --- a/docs/google-docs/providers/google/compute/node_templates_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: node_templates_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - node_templates_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namenode_templates_iam_bindings
TypeResource
Idgoogle.compute.node_templates_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `nodeTemplates_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md b/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md index ef38099a36..d54dcae0bf 100644 --- a/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/node_templates_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `rules` | `array` | This is deprecated and has no effect. Do not use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/node_types/index.md b/docs/google-docs/providers/google/compute/node_types/index.md index be1f348b48..56162118f7 100644 --- a/docs/google-docs/providers/google/compute/node_types/index.md +++ b/docs/google-docs/providers/google/compute/node_types/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional textual description of the resource. | -| `zone` | `string` | [Output Only] The name of the zone where the node type resides, such as us-central1-a. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `cpuPlatform` | `string` | [Output Only] The CPU platform used by this node type. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeType for node types. | | `guestCpus` | `integer` | [Output Only] The number of virtual CPUs that are available to the node type. | +| `cpuPlatform` | `string` | [Output Only] The CPU platform used by this node type. | +| `zone` | `string` | [Output Only] The name of the zone where the node type resides, such as us-central1-a. | +| `deprecated` | `object` | Deprecation status for a public resource. | | `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the node type, defined in MB. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeType for node types. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `localSsdGb` | `integer` | [Output Only] Local SSD available to the node type, defined in GB. | -| `deprecated` | `object` | Deprecation status for a public resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/packet_mirrorings/index.md b/docs/google-docs/providers/google/compute/packet_mirrorings/index.md index 05a16806bd..b51751e85c 100644 --- a/docs/google-docs/providers/google/compute/packet_mirrorings/index.md +++ b/docs/google-docs/providers/google/compute/packet_mirrorings/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `collectorIlb` | `object` | | +| `enable` | `string` | Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. | +| `priority` | `integer` | The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. | | `filter` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `network` | `object` | | | `region` | `string` | [Output Only] URI of the region where the packetMirroring resides. | | `mirroredResources` | `object` | | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `enable` | `string` | Indicates whether or not this packet mirroring takes effect. If set to FALSE, this packet mirroring policy will not be enforced on the network. The default is TRUE. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `priority` | `integer` | The priority of applying this configuration. Priority is used to break ties in cases where there is more than one matching rule. In the case of two rules that apply for a given Instance, the one with the lowest-numbered priority value wins. Default value is 1000. Valid range is 0 through 65535. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/projects/index.md b/docs/google-docs/providers/google/compute/projects/index.md index 0e012fe168..60828dba84 100644 --- a/docs/google-docs/providers/google/compute/projects/index.md +++ b/docs/google-docs/providers/google/compute/projects/index.md @@ -31,16 +31,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. | | `description` | `string` | An optional textual description of the resource. | | `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `quotas` | `array` | [Output Only] Quotas assigned to this project. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | | `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | | `commonInstanceMetadata` | `object` | A metadata key/value entry. | -| `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | -| `quotas` | `array` | [Output Only] Quotas assigned to this project. | | `enabledFeatures` | `array` | Restricted features enabled for use on this project. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | | `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/projects_xpn_host/index.md b/docs/google-docs/providers/google/compute/projects_xpn_host/index.md deleted file mode 100644 index f4c49dd40e..0000000000 --- a/docs/google-docs/providers/google/compute/projects_xpn_host/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: projects_xpn_host -hide_title: false -hide_table_of_contents: false -keywords: - - projects_xpn_host - - compute - - 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 ---- - - - -## Overview - - - - -
Nameprojects_xpn_host
TypeResource
Idgoogle.compute.projects_xpn_host
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources. | -| `name` | `string` | The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. | -| `description` | `string` | An optional textual description of the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | -| `commonInstanceMetadata` | `object` | A metadata key/value entry. | -| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | -| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | -| `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | -| `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | -| `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `quotas` | `array` | [Output Only] Quotas assigned to this project. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getXpnHost` | `SELECT` | `project` | diff --git a/docs/google-docs/providers/google/compute/projects_xpn_hosts/index.md b/docs/google-docs/providers/google/compute/projects_xpn_hosts/index.md deleted file mode 100644 index aec7f34b8e..0000000000 --- a/docs/google-docs/providers/google/compute/projects_xpn_hosts/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: projects_xpn_hosts -hide_title: false -hide_table_of_contents: false -keywords: - - projects_xpn_hosts - - compute - - 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 ---- - - - -## Overview - - - - -
Nameprojects_xpn_hosts
TypeResource
Idgoogle.compute.projects_xpn_hosts
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources. | -| `name` | `string` | The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. | -| `description` | `string` | An optional textual description of the resource. | -| `quotas` | `array` | [Output Only] Quotas assigned to this project. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | -| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | -| `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | -| `commonInstanceMetadata` | `object` | A metadata key/value entry. | -| `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | -| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_listXpnHosts` | `SELECT` | `project` | diff --git a/docs/google-docs/providers/google/compute/projects_xpn_resources/index.md b/docs/google-docs/providers/google/compute/projects_xpn_resources/index.md deleted file mode 100644 index d4abd355a7..0000000000 --- a/docs/google-docs/providers/google/compute/projects_xpn_resources/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: projects_xpn_resources -hide_title: false -hide_table_of_contents: false -keywords: - - projects_xpn_resources - - compute - - 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 ---- - - - -## Overview - - - - -
Nameprojects_xpn_resources
TypeResource
Idgoogle.compute.projects_xpn_resources
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `kind` | `string` | [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) | -| `nextPageToken` | `string` | [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. | -| `resources` | `array` | Service resources (a.k.a service projects) attached to this project as their shared VPC host. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getXpnResources` | `SELECT` | `project` | diff --git a/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md b/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md index 7538d4c8dc..a8b813bd6e 100644 --- a/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md +++ b/docs/google-docs/providers/google/compute/public_advertised_prefixes/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `publicDelegatedPrefixs` | `array` | [Output Only] The list of public delegated prefixes that exist for this public advertised prefix. | | `ipCidrRange` | `string` | The address range, in CIDR format, represented by this public advertised prefix. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. | | `status` | `string` | The status of the public advertised prefix. Possible values include: - `INITIAL`: RPKI validation is complete. - `PTR_CONFIGURED`: User has configured the PTR. - `VALIDATED`: Reverse DNS lookup is successful. - `REVERSE_DNS_LOOKUP_FAILED`: Reverse DNS lookup failed. - `PREFIX_CONFIGURATION_IN_PROGRESS`: The prefix is being configured. - `PREFIX_CONFIGURATION_COMPLETE`: The prefix is fully configured. - `PREFIX_REMOVAL_IN_PROGRESS`: The prefix is being removed. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicAdvertisedPrefix. An up-to-date fingerprint must be provided in order to update the PublicAdvertisedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicAdvertisedPrefix. | | `dnsVerificationIp` | `string` | The address to be used for reverse DNS verification. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `sharedSecret` | `string` | [Output Only] The shared secret to be used for reverse DNS verification. | -| `publicDelegatedPrefixs` | `array` | [Output Only] The list of public delegated prefixes that exist for this public advertised prefix. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md b/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md index a0aca4468c..8b0c9271f8 100644 --- a/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md +++ b/docs/google-docs/providers/google/compute/public_delegated_prefixes/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `region` | `string` | [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a new PublicDelegatedPrefix. An up-to-date fingerprint must be provided in order to update the PublicDelegatedPrefix, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a PublicDelegatedPrefix. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `isLiveMigration` | `boolean` | If true, the prefix will be live migrated. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `status` | `string` | [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. | | `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by this public delegated prefix. | | `parentPrefix` | `string` | The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. | -| `status` | `string` | [Output Only] The status of the public delegated prefix, which can be one of following values: - `INITIALIZING` The public delegated prefix is being initialized and addresses cannot be created yet. - `READY_TO_ANNOUNCE` The public delegated prefix is a live migration prefix and is active. - `ANNOUNCED` The public delegated prefix is active. - `DELETING` The public delegated prefix is being deprovsioned. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated prefixes. | | `publicDelegatedSubPrefixs` | `array` | The list of sub public delegated prefixes that exist for this public delegated prefix. | -| `region` | `string` | [Output Only] URL of the region where the public delegated prefix resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_autoscalers/index.md b/docs/google-docs/providers/google/compute/region_autoscalers/index.md index 07df945e47..78d8557baa 100644 --- a/docs/google-docs/providers/google/compute/region_autoscalers/index.md +++ b/docs/google-docs/providers/google/compute/region_autoscalers/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | -| `status` | `string` | [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. | -| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | -| `statusDetails` | `array` | [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. | +| `recommendedSize` | `integer` | [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. | | `zone` | `string` | [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). | +| `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | | `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | -| `region` | `string` | [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | -| `recommendedSize` | `integer` | [Output Only] Target recommended MIG size (number of instances) computed by autoscaler. Autoscaler calculates the recommended MIG size even when the autoscaling policy mode is different from ON. This field is empty when autoscaler is not connected to an existing managed instance group or autoscaler did not generate its prediction. | +| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | +| `statusDetails` | `array` | [Output Only] Human-readable details about the current state of the autoscaler. Read the documentation for Commonly returned status messages for examples of status messages you might encounter. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `status` | `string` | [Output Only] The status of the autoscaler configuration. Current set of possible values: - PENDING: Autoscaler backend hasn't read new/updated configuration. - DELETING: Configuration is being deleted. - ACTIVE: Configuration is acknowledged to be effective. Some warnings might be present in the statusDetails field. - ERROR: Configuration has errors. Actionable for users. Details are present in the statusDetails field. New values might be added in the future. | +| `region` | `string` | [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_backend_services/index.md b/docs/google-docs/providers/google/compute/region_backend_services/index.md index 166cc55011..d7853208b1 100644 --- a/docs/google-docs/providers/google/compute/region_backend_services/index.md +++ b/docs/google-docs/providers/google/compute/region_backend_services/index.md @@ -30,43 +30,43 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `failoverPolicy` | `object` | For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). | -| `portName` | `string` | A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. | -| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | -| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | +| `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | | `affinityCookieTtlSec` | `integer` | Lifetime of cookies in seconds. This setting is applicable to external and internal HTTP(S) load balancers and Traffic Director and requires GENERATED_COOKIE or HTTP_COOKIE session affinity. If set to 0, the cookie is non-persistent and lasts only until the end of the browser session (or equivalent). The maximum allowed value is two weeks (1,209,600). Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | -| `serviceBindings` | `array` | URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. | -| `sessionAffinity` | `string` | Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). | -| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | -| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | -| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | | `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | -| `port` | `integer` | Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. | -| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | +| `failoverPolicy` | `object` | For load balancers that have configurable failover: [Internal TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/internal/failover-overview) and [external TCP/UDP Load Balancing](https://cloud.google.com/load-balancing/docs/network/networklb-failover-overview). On failover or failback, this field indicates whether connection draining will be honored. Google Cloud has a fixed connection draining timeout of 10 minutes. A setting of true terminates existing TCP connections to the active pool during failover and failback, immediately draining traffic. A setting of false allows existing TCP connections to persist, even on VMs no longer in the active pool, for up to the duration of the connection draining timeout (10 minutes). | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | +| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | +| `serviceBindings` | `array` | URLs of networkservices.ServiceBinding resources. Can only be set if load balancing scheme is INTERNAL_SELF_MANAGED. If set, lists of backends and health checks must be both empty. | +| `iap` | `object` | Identity-Aware Proxy | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | -| `healthChecks` | `array` | The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. | -| `loadBalancingScheme` | `string` | Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | -| `region` | `string` | [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | | `localityLbPolicies` | `array` | A list of locality load-balancing policies to be used in order of preference. When you use localityLbPolicies, you must set at least one value for either the localityLbPolicies[].policy or the localityLbPolicies[].customPolicy field. localityLbPolicies overrides any value set in the localityLbPolicy field. For an example of how to use this field, see Define a list of preferred policies. Caution: This field and its children are intended for use in a service mesh that includes gRPC clients only. Envoy proxies can't use backend services that have this configuration. | -| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | -| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | | `backends` | `array` | The list of backends that serve this BackendService. | -| `iap` | `object` | Identity-Aware Proxy | +| `loadBalancingScheme` | `string` | Specifies the load balancer type. A backend service created for one type of load balancer cannot be used with another. For more information, refer to Choosing a load balancer. | | `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | -| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | -| `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | -| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | -| `localityLbPolicy` | `string` | The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. | -| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a BackendService. An up-to-date fingerprint must be provided in order to update the BackendService, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a BackendService. | +| `healthChecks` | `array` | The list of URLs to the healthChecks, httpHealthChecks (legacy), or httpsHealthChecks (legacy) resource for health checking this backend service. Not all backend services support legacy health checks. See Load balancer guide. Currently, at most one health check can be specified for each backend service. Backend services with instance group or zonal NEG backends must have a health check. Backend services with internet or serverless NEG backends must not have a health check. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `sessionAffinity` | `string` | Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). | +| `protocol` | `string` | The protocol this BackendService uses to communicate with backends. Possible values are HTTP, HTTPS, HTTP2, TCP, SSL, UDP or GRPC. depending on the chosen load balancer or Traffic Director configuration. Refer to the documentation for the load balancers or for Traffic Director for more information. Must be set to GRPC when the backend service is referenced by a URL map that is bound to target gRPC proxy. | +| `maxStreamDuration` | `object` | A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. | | `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | +| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | +| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | +| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | +| `portName` | `string` | A named port on a backend instance group representing the port for communication to the backend VMs in that group. The named port must be [defined on each backend instance group](https://cloud.google.com/load-balancing/docs/backend-service#named_ports). This parameter has no meaning if the backends are NEGs. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port_name. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | +| `subsetting` | `object` | Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. | +| `timeoutSec` | `integer` | The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. | +| `region` | `string` | [Output Only] URL of the region where the regional backend service resides. This field is not applicable to global backend services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `network` | `string` | The URL of the network to which this backend service belongs. This field can only be specified when the load balancing scheme is set to INTERNAL. | | `connectionDraining` | `object` | Message containing connection draining configuration. | +| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | +| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | +| `port` | `integer` | Deprecated in favor of portName. The TCP port to connect on the backend. The default value is 80. For Internal TCP/UDP Load Balancing and Network Load Balancing, omit port. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_backend_services_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/region_backend_services_iam_audit_configs/index.md deleted file mode 100644 index 9501c3c38a..0000000000 --- a/docs/google-docs/providers/google/compute/region_backend_services_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: region_backend_services_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - region_backend_services_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameregion_backend_services_iam_audit_configs
TypeResource
Idgoogle.compute.region_backend_services_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `regionBackendServices_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/region_backend_services_iam_bindings/index.md b/docs/google-docs/providers/google/compute/region_backend_services_iam_bindings/index.md deleted file mode 100644 index 6a3cc14ae7..0000000000 --- a/docs/google-docs/providers/google/compute/region_backend_services_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: region_backend_services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - region_backend_services_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameregion_backend_services_iam_bindings
TypeResource
Idgoogle.compute.region_backend_services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `regionBackendServices_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md b/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md index 30134d9707..37dae8115c 100644 --- a/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_backend_services_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_commitments/index.md b/docs/google-docs/providers/google/compute/region_commitments/index.md index a966776ba3..d3c0e22758 100644 --- a/docs/google-docs/providers/google/compute/region_commitments/index.md +++ b/docs/google-docs/providers/google/compute/region_commitments/index.md @@ -30,23 +30,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `plan` | `string` | The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). | +| `reservations` | `array` | List of reservations in this commitment. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `autoRenew` | `boolean` | Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. | | `startTimestamp` | `string` | [Output Only] Commitment start time in RFC3339 text format. | -| `region` | `string` | [Output Only] URL of the region where this commitment may be used. | +| `plan` | `string` | The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years). | +| `licenseResource` | `object` | Commitment for a particular license resource. | +| `status` | `string` | [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#commitment for commitments. | +| `region` | `string` | [Output Only] URL of the region where this commitment may be used. | +| `endTimestamp` | `string` | [Output Only] Commitment end time in RFC3339 text format. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `resources` | `array` | A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. | -| `status` | `string` | [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED. | -| `licenseResource` | `object` | Commitment for a particular license resource. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `type` | `string` | The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. | -| `autoRenew` | `boolean` | Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. | | `mergeSourceCommitments` | `array` | List of source commitments to be merged into a new commitment. | -| `reservations` | `array` | List of reservations in this commitment. | | `splitSourceCommitment` | `string` | Source commitment to be split into a new commitment. | -| `category` | `string` | The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. | | `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | -| `endTimestamp` | `string` | [Output Only] Commitment end time in RFC3339 text format. | +| `type` | `string` | The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines. | +| `category` | `string` | The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. | +| `resources` | `array` | A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_disk_types/index.md b/docs/google-docs/providers/google/compute/region_disk_types/index.md index d32bee8029..83350ddd0c 100644 --- a/docs/google-docs/providers/google/compute/region_disk_types/index.md +++ b/docs/google-docs/providers/google/compute/region_disk_types/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of this resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `zone` | `string` | [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `deprecated` | `object` | Deprecation status for a public resource. | | `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | -| `deprecated` | `object` | Deprecation status for a public resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `zone` | `string` | [Output Only] URL of the zone where the disk type resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `region` | `string` | [Output Only] URL of the region where the disk type resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `validDiskSize` | `string` | [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_disks/index.md b/docs/google-docs/providers/google/compute/region_disks/index.md index 2aa00b9204..5a6f525369 100644 --- a/docs/google-docs/providers/google/compute/region_disks/index.md +++ b/docs/google-docs/providers/google/compute/region_disks/index.md @@ -30,47 +30,47 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `sourceSnapshot` | `string` | The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | +| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | | `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | -| `region` | `string` | [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `sourceSnapshot` | `string` | The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot | | `provisionedThroughput` | `string` | Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. | -| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | -| `sizeGb` | `string` | Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. | -| `sourceImageEncryptionKey` | `object` | | -| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | -| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | -| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | -| `type` | `string` | URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. | +| `region` | `string` | [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `resourceStatus` | `object` | | -| `sourceSnapshotEncryptionKey` | `object` | | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `guestOsFeatures` | `array` | A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. | -| `sourceDiskId` | `string` | [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. | +| `sourceImage` | `string` | The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family | +| `diskEncryptionKey` | `object` | | +| `provisionedIops` | `string` | Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. | +| `type` | `string` | URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types. | +| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | | `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | +| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | +| `sourceDiskId` | `string` | [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used. | +| `sourceStorageObject` | `string` | The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. | +| `sourceImageEncryptionKey` | `object` | | | `asyncPrimaryDisk` | `object` | | -| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | -| `sourceImage` | `string` | The source image used to create this disk. If the source image is deleted, this field will not be set. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family | +| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `params` | `object` | Additional disk params. | -| `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | +| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | +| `locationHint` | `string` | An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. | | `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | -| `physicalBlockSizeBytes` | `string` | Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project. | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | | `sourceDisk` | `string` | The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk | -| `locationHint` | `string` | An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. | -| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `sourceSnapshotEncryptionKey` | `object` | | | `lastDetachTimestamp` | `string` | [Output Only] Last detach timestamp in RFC3339 text format. | -| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | -| `diskEncryptionKey` | `object` | | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | -| `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | -| `provisionedIops` | `string` | Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `zone` | `string` | [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk. | -| `sourceStorageObject` | `string` | The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. | +| `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | +| `sizeGb` | `string` | Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. | | `options` | `string` | Internal use only. | -| `status` | `string` | [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. | +| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | +| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | +| `sourceSnapshotId` | `string` | [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used. | +| `zone` | `string` | [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | +| `sourceImageId` | `string` | [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_disks_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/region_disks_iam_audit_configs/index.md deleted file mode 100644 index 02fc132489..0000000000 --- a/docs/google-docs/providers/google/compute/region_disks_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: region_disks_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - region_disks_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameregion_disks_iam_audit_configs
TypeResource
Idgoogle.compute.region_disks_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `regionDisks_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/region_disks_iam_bindings/index.md b/docs/google-docs/providers/google/compute/region_disks_iam_bindings/index.md deleted file mode 100644 index 8cae220861..0000000000 --- a/docs/google-docs/providers/google/compute/region_disks_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: region_disks_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - region_disks_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameregion_disks_iam_bindings
TypeResource
Idgoogle.compute.region_disks_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `regionDisks_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md b/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md index 966c6e51e0..161d1171cb 100644 --- a/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_disks_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_health_check_services/index.md b/docs/google-docs/providers/google/compute/region_health_check_services/index.md index 730092b205..e517484e96 100644 --- a/docs/google-docs/providers/google/compute/region_health_check_services/index.md +++ b/docs/google-docs/providers/google/compute/region_health_check_services/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `healthStatusAggregationPolicy` | `string` | Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. | -| `networkEndpointGroups` | `array` | A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. | -| `region` | `string` | [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `notificationEndpoints` | `array` | A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `healthStatusAggregationPolicy` | `string` | Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified. - NO_AGGREGATION. An EndpointHealth message is returned for each pair in the health check service. - AND. If any health check of an endpoint reports UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is only allowed with regional HealthCheckService. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. | +| `region` | `string` | [Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `healthChecks` | `array` | A list of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10 for regional HealthCheckService, and not more than 1 for global HealthCheckService. HealthCheck resources must have portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks must belong to the same region as zones of NetworkEndpointGroups. For global HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the global HealthChecks must specify sourceRegions, and HealthChecks that specify sourceRegions can only be used with global INTERNET_IP_PORT NetworkEndpointGroups. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#healthCheckServicefor health check services. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `notificationEndpoints` | `array` | A list of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. | +| `networkEndpointGroups` | `array` | A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. For global HealthCheckServices, the NetworkEndpointGroups must be global INTERNET_IP_PORT. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_health_checks/index.md b/docs/google-docs/providers/google/compute/region_health_checks/index.md index acf8b20221..ef7102796c 100644 --- a/docs/google-docs/providers/google/compute/region_health_checks/index.md +++ b/docs/google-docs/providers/google/compute/region_health_checks/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. For example, a name that is 1-63 characters long, matches the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`, and otherwise complies with RFC1035. This regular expression describes a name where the first character is a lowercase letter, and all following characters are a dash, lowercase letter, or digit, except the last character, which isn't a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `logConfig` | `object` | Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. | -| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | -| `httpHealthCheck` | `object` | | -| `type` | `string` | Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. | +| `grpcHealthCheck` | `object` | | | `kind` | `string` | Type of the resource. | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `tcpHealthCheck` | `object` | | -| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | | `httpsHealthCheck` | `object` | | -| `http2HealthCheck` | `object` | | +| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | | `sslHealthCheck` | `object` | | +| `logConfig` | `object` | Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. | +| `type` | `string` | Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. | | `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | -| `grpcHealthCheck` | `object` | | -| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | +| `httpHealthCheck` | `object` | | | `timeoutSec` | `integer` | How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. | +| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | +| `http2HealthCheck` | `object` | | +| `tcpHealthCheck` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md b/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md index b3019a581c..dc89fd9ffb 100644 --- a/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md +++ b/docs/google-docs/providers/google/compute/region_instance_group_managers/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this resource type. The server generates this identifier. | | `name` | `string` | The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. | -| `status` | `object` | | -| `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | -| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | -| `targetSize` | `integer` | The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. | -| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | -| `baseInstanceName` | `string` | The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. | -| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | -| `updatePolicy` | `object` | | -| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | +| `distributionPolicy` | `object` | | | `statefulPolicy` | `object` | | -| `instanceTemplate` | `string` | The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. | | `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | -| `fingerprint` | `string` | Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. | -| `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | -| `distributionPolicy` | `object` | | +| `instanceLifecyclePolicy` | `object` | | +| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | +| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | +| `updatePolicy` | `object` | | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | | `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | | `currentActions` | `object` | | -| `versions` | `array` | Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates. | -| `instanceLifecyclePolicy` | `object` | | +| `targetSize` | `integer` | The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. | +| `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | | `targetPools` | `array` | The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | +| `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | +| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | +| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | +| `baseInstanceName` | `string` | The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. | +| `fingerprint` | `string` | Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager. | +| `instanceTemplate` | `string` | The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. | +| `status` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_instance_groups/index.md b/docs/google-docs/providers/google/compute/region_instance_groups/index.md index 60229bcdba..0a00f75317 100644 --- a/docs/google-docs/providers/google/compute/region_instance_groups/index.md +++ b/docs/google-docs/providers/google/compute/region_instance_groups/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this instance group, generated by the server. | | `name` | `string` | The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `zone` | `string` | [Output Only] The URL of the zone where the instance group is located (for zonal resources). | -| `size` | `integer` | [Output Only] The total number of instances in the instance group. | | `subnetwork` | `string` | [Output Only] The URL of the subnetwork to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | -| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | -| `namedPorts` | `array` | Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. | +| `network` | `string` | [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | | `region` | `string` | [Output Only] The URL of the region where the instance group is located (for regional resources). | +| `size` | `integer` | [Output Only] The total number of instances in the instance group. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | +| `zone` | `string` | [Output Only] The URL of the zone where the instance group is located (for zonal resources). | +| `namedPorts` | `array` | Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group. | +| `fingerprint` | `string` | [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently. | | `selfLink` | `string` | [Output Only] The URL for this instance group. The server generates this URL. | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroup for instance groups. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | -| `network` | `string` | [Output Only] The URL of the network to which all instances in the instance group belong. If your instance has multiple network interfaces, then the network and subnetwork fields only refer to the network and subnet used by your primary interface (nic0). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_instance_templates/index.md b/docs/google-docs/providers/google/compute/region_instance_templates/index.md index c6a6181d03..de84713503 100644 --- a/docs/google-docs/providers/google/compute/region_instance_templates/index.md +++ b/docs/google-docs/providers/google/compute/region_instance_templates/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this instance template. The server defines this identifier. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance template in RFC3339 text format. | -| `region` | `string` | [Output Only] URL of the region where the instance template resides. Only applicable for regional resources. | -| `sourceInstance` | `string` | The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. | +| `region` | `string` | [Output Only] URL of the region where the instance template resides. Only applicable for regional resources. | +| `properties` | `object` | | | `selfLink` | `string` | [Output Only] The URL for this instance template. The server defines this URL. | +| `sourceInstance` | `string` | The source instance used to create the template. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance | | `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | -| `properties` | `object` | | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance template in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md b/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md index fe497d0a4f..b22f17e6ac 100644 --- a/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md +++ b/docs/google-docs/providers/google/compute/region_network_endpoint_groups/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | -| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | +| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | | `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | +| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | +| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | | `cloudFunction` | `object` | Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | +| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | +| `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | +| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | | `pscTargetService` | `string` | The target service url used to set up private service connection to a Google API or a PSC Producer Service Attachment. An example value is: "asia-northeast3-cloudkms.googleapis.com" | +| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | | `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | -| `appEngine` | `object` | Configuration for an App Engine network endpoint group (NEG). The service is optional, may be provided explicitly or in the URL mask. The version is optional and can only be provided explicitly or in the URL mask when service is present. Note: App Engine service must be in the same project and located in the same region as the Serverless NEG. | -| `networkEndpointType` | `string` | Type of network endpoints in this network endpoint group. Can be one of GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT, INTERNET_IP_PORT, SERVERLESS, PRIVATE_SERVICE_CONNECT. | -| `cloudRun` | `object` | Configuration for a Cloud Run network endpoint group (NEG). The service must be provided explicitly or in the URL mask. The tag is optional, may be provided explicitly or in the URL mask. Note: Cloud Run service must be in the same project and located in the same region as the Serverless NEG. | | `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | -| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | -| `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md index dfce51fab5..7264077692 100644 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_network_firewall_policies/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | -| `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | | `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. | +| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `associations` | `array` | A list of associations that belong to this firewall policy. | | `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. | -| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | -| `shortName` | `string` | User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | +| `region` | `string` | [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `displayName` | `string` | Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | +| `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | +| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies_association/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_association/index.md index 4b99a29c42..6f24afcbb2 100644 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies_association/index.md +++ b/docs/google-docs/providers/google/compute/region_network_firewall_policies_association/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name for an association. | -| `shortName` | `string` | [Output Only] The short name of the firewall policy of the association. | -| `attachmentTarget` | `string` | The target that the firewall policy is attached to. | | `displayName` | `string` | [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association. | | `firewallPolicyId` | `string` | [Output Only] The firewall policy ID of the association. | +| `shortName` | `string` | [Output Only] The short name of the firewall policy of the association. | +| `attachmentTarget` | `string` | The target that the firewall policy is attached to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_audit_configs/index.md deleted file mode 100644 index b25b498b6f..0000000000 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: region_network_firewall_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - region_network_firewall_policies_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameregion_network_firewall_policies_iam_audit_configs
TypeResource
Idgoogle.compute.region_network_firewall_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `regionNetworkFirewallPolicies_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_bindings/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_bindings/index.md deleted file mode 100644 index 761b2165aa..0000000000 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: region_network_firewall_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - region_network_firewall_policies_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameregion_network_firewall_policies_iam_bindings
TypeResource
Idgoogle.compute.region_network_firewall_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `regionNetworkFirewallPolicies_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md index bbcc090625..6e276a4c2f 100644 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md index 6f57e576ab..b9be0eb8b3 100644 --- a/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/region_network_firewall_policies_rule/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | An optional description for this resource. | -| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | -| `direction` | `string` | The direction in which this rule applies. | -| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | -| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | | `enableLogging` | `boolean` | Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | -| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | +| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | | `targetResources` | `array` | A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. | | `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | +| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. | +| `direction` | `string` | The direction in which this rule applies. | +| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | +| `targetSecureTags` | `array` | A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. | | `disabled` | `boolean` | Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. | -| `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md b/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md index 2d2fdddb76..4ef18533b1 100644 --- a/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md +++ b/docs/google-docs/providers/google/compute/region_notification_endpoints/index.md @@ -30,11 +30,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] A unique identifier for this resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `region` | `string` | [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `grpcSettings` | `object` | Represents a gRPC setting that describes one gRPC notification endpoint and the retry duration attempting to send notification to this endpoint. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#notificationEndpoint for notification endpoints. | +| `region` | `string` | [Output Only] URL of the region where the notification endpoint resides. This field applies only to the regional resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_operations/index.md b/docs/google-docs/providers/google/compute/region_operations/index.md index b857cfc55a..2f8c7c5fb4 100644 --- a/docs/google-docs/providers/google/compute/region_operations/index.md +++ b/docs/google-docs/providers/google/compute/region_operations/index.md @@ -30,28 +30,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | -| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | | `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | | `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | +| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | | `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | | `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | | `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_security_policies/index.md b/docs/google-docs/providers/google/compute/region_security_policies/index.md index be07a20c3f..4bba24ea2b 100644 --- a/docs/google-docs/providers/google/compute/region_security_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_security_policies/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. | | `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security policies | +| `recaptchaOptionsConfig` | `object` | | | `ddosProtectionConfig` | `object` | | -| `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. | +| `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | | `advancedOptionsConfig` | `object` | | +| `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | | `type` | `string` | The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. | -| `recaptchaOptionsConfig` | `object` | | -| `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md b/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md index 19c5fab605..14692c3b08 100644 --- a/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md +++ b/docs/google-docs/providers/google/compute/region_ssl_certificates/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `managed` | `object` | Configuration and status of a managed SSL certificate. | -| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | | `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `certificate` | `string` | A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. | | `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | -| `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | -| `type` | `string` | (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | | `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | | `privateKey` | `string` | A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field. | +| `type` | `string` | (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. | +| `managed` | `object` | Configuration and status of a managed SSL certificate. | +| `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | +| `certificate` | `string` | A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_ssl_policies/index.md b/docs/google-docs/providers/google/compute/region_ssl_policies/index.md index 34fa663cd6..86566a05e8 100644 --- a/docs/google-docs/providers/google/compute/region_ssl_policies/index.md +++ b/docs/google-docs/providers/google/compute/region_ssl_policies/index.md @@ -31,15 +31,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | -| `customFeatures` | `array` | A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. | | `enabledFeatures` | `array` | [Output Only] The list of features enabled in the SSL policy. | | `kind` | `string` | [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. | -| `region` | `string` | [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `minTlsVersion` | `string` | The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `profile` | `string` | Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. | +| `region` | `string` | [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. | +| `customFeatures` | `array` | A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md b/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md index bfe57cc815..ee98eeeff0 100644 --- a/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md +++ b/docs/google-docs/providers/google/compute/region_target_http_proxies/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. | -| `region` | `string` | [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | +| `region` | `string` | [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. | | `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md b/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md index 372bc29b45..80965329dc 100644 --- a/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md +++ b/docs/google-docs/providers/google/compute/region_target_https_proxies/index.md @@ -30,20 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `authorizationPolicy` | `string` | Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `quicOverride` | `string` | Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. | +| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | +| `authorizationPolicy` | `string` | Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. | | `serverTlsPolicy` | `string` | Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. | +| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | | `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | -| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. | +| `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | | `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | | `urlMap` | `string` | A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | -| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | -| `quicOverride` | `string` | Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. | -| `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | +| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md b/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md index 511509a256..b5b8f2e18b 100644 --- a/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md +++ b/docs/google-docs/providers/google/compute/region_target_tcp_proxies/index.md @@ -32,11 +32,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | -| `service` | `string` | URL to the BackendService resource. | | `proxyHeader` | `string` | Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. | +| `service` | `string` | URL to the BackendService resource. | | `region` | `string` | [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/region_url_maps/index.md b/docs/google-docs/providers/google/compute/region_url_maps/index.md index 2b8a8d0301..f09749a829 100644 --- a/docs/google-docs/providers/google/compute/region_url_maps/index.md +++ b/docs/google-docs/providers/google/compute/region_url_maps/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. | -| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | -| `tests` | `array` | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. | -| `hostRules` | `array` | The list of host rules to use against the URL. | +| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | | `region` | `string` | [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `defaultRouteAction` | `object` | | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `hostRules` | `array` | The list of host rules to use against the URL. | +| `tests` | `array` | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. | +| `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | -| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. | | `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | +| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/regions/index.md b/docs/google-docs/providers/google/compute/regions/index.md index 2a618ab6b3..b2e8d0fb53 100644 --- a/docs/google-docs/providers/google/compute/regions/index.md +++ b/docs/google-docs/providers/google/compute/regions/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] Textual description of the resource. | -| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zones` | `array` | [Output Only] A list of zones available in this region, in the form of resource URLs. | | `quotas` | `array` | [Output Only] Quotas assigned to this region. | | `status` | `string` | [Output Only] Status of the region, either UP or DOWN. | -| `deprecated` | `object` | Deprecation status for a public resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#region for regions. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `deprecated` | `object` | Deprecation status for a public resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/reservations/index.md b/docs/google-docs/providers/google/compute/reservations/index.md index cefd7bb69c..1903bca85d 100644 --- a/docs/google-docs/providers/google/compute/reservations/index.md +++ b/docs/google-docs/providers/google/compute/reservations/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `commitment` | `string` | [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. | +| `specificReservation` | `object` | This reservation type allows to pre allocate specific instance configuration. Next ID: 6 | | `specificReservationRequired` | `boolean` | Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `commitment` | `string` | [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. | | `status` | `string` | [Output Only] The status of the reservation. | -| `resourcePolicies` | `object` | Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zone` | `string` | Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#reservations for reservations. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | | `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `resourceStatus` | `object` | [Output Only] Contains output only fields. | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | -| `specificReservation` | `object` | This reservation type allows to pre allocate specific instance configuration. Next ID: 6 | +| `resourcePolicies` | `object` | Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#reservations for reservations. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/reservations_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/reservations_iam_audit_configs/index.md deleted file mode 100644 index daf4deff95..0000000000 --- a/docs/google-docs/providers/google/compute/reservations_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: reservations_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - reservations_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namereservations_iam_audit_configs
TypeResource
Idgoogle.compute.reservations_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `reservations_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/reservations_iam_bindings/index.md b/docs/google-docs/providers/google/compute/reservations_iam_bindings/index.md deleted file mode 100644 index 135a795f53..0000000000 --- a/docs/google-docs/providers/google/compute/reservations_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: reservations_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - reservations_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namereservations_iam_bindings
TypeResource
Idgoogle.compute.reservations_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `reservations_getIamPolicy` | `SELECT` | `project, resource, zone` | diff --git a/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md b/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md index 7d4142ea71..38cf37dec3 100644 --- a/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/reservations_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/resource_policies/index.md b/docs/google-docs/providers/google/compute/resource_policies/index.md index 696e82d144..9f9cd933f8 100644 --- a/docs/google-docs/providers/google/compute/resource_policies/index.md +++ b/docs/google-docs/providers/google/compute/resource_policies/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | | -| `diskConsistencyGroupPolicy` | `object` | Resource policy for disk consistency groups. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `instanceSchedulePolicy` | `object` | An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. | | `groupPlacementPolicy` | `object` | A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality | +| `diskConsistencyGroupPolicy` | `object` | Resource policy for disk consistency groups. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#resource_policies for resource policies. | +| `status` | `string` | [Output Only] The status of resource policy creation. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `resourceStatus` | `object` | Contains output only fields. Use this sub-message for all output fields set on ResourcePolicy. The internal structure of this "status" field should mimic the structure of ResourcePolicy proto specification. | | `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | | `region` | `string` | | | `snapshotSchedulePolicy` | `object` | A snapshot schedule policy specifies when and how frequently snapshots are to be created for the target disk. Also specifies how many and how long these scheduled snapshots should be retained. | -| `status` | `string` | [Output Only] The status of resource policy creation. | -| `instanceSchedulePolicy` | `object` | An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/resource_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/resource_policies_iam_audit_configs/index.md deleted file mode 100644 index b342016866..0000000000 --- a/docs/google-docs/providers/google/compute/resource_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: resource_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - resource_policies_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameresource_policies_iam_audit_configs
TypeResource
Idgoogle.compute.resource_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `resourcePolicies_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/resource_policies_iam_bindings/index.md b/docs/google-docs/providers/google/compute/resource_policies_iam_bindings/index.md deleted file mode 100644 index 75489f1a0a..0000000000 --- a/docs/google-docs/providers/google/compute/resource_policies_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: resource_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - resource_policies_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameresource_policies_iam_bindings
TypeResource
Idgoogle.compute.resource_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `resourcePolicies_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md index ceff0fda6f..18dd4e8652 100644 --- a/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/resource_policies_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/routers/index.md b/docs/google-docs/providers/google/compute/routers/index.md index a0f6e8dbaa..6a02380170 100644 --- a/docs/google-docs/providers/google/compute/routers/index.md +++ b/docs/google-docs/providers/google/compute/routers/index.md @@ -31,16 +31,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `network` | `string` | URI of the network to which this router belongs. | -| `md5AuthenticationKeys` | `array` | Keys used for MD5 authentication. | +| `bgp` | `object` | | +| `encryptedInterconnectRouter` | `boolean` | Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). | | `region` | `string` | [Output Only] URI of the region where the router resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `interfaces` | `array` | Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. | -| `bgpPeers` | `array` | BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of resource. Always compute#router for routers. | -| `encryptedInterconnectRouter` | `boolean` | Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). | | `nats` | `array` | A list of NAT services created in this router. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `bgp` | `object` | | +| `network` | `string` | URI of the network to which this router belongs. | +| `interfaces` | `array` | Router interfaces. Each interface requires either one linked resource, (for example, linkedVpnTunnel), or IP address and IP address range (for example, ipRange), or both. | +| `md5AuthenticationKeys` | `array` | Keys used for MD5 authentication. | +| `bgpPeers` | `array` | BGP information that must be configured into the routing stack to establish BGP peering. This information must specify the peer ASN and either the interface name, IP address, or peer IP address. Please refer to RFC4273. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md b/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md index e127b062c8..5b43853aba 100644 --- a/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md +++ b/docs/google-docs/providers/google/compute/routers_nat_mapping_info/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `interfaceNatMappings` | `array` | | | `instanceName` | `string` | Name of the VM instance which the endpoint belongs to | +| `interfaceNatMappings` | `array` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/routes/index.md b/docs/google-docs/providers/google/compute/routes/index.md index 7bc813e58f..c1f5b98653 100644 --- a/docs/google-docs/providers/google/compute/routes/index.md +++ b/docs/google-docs/providers/google/compute/routes/index.md @@ -31,24 +31,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. | | `description` | `string` | An optional description of this resource. Provide this field when you create the resource. | | `nextHopIp` | `string` | The network IP address of an instance that should handle matching packets. Only IPv4 is supported. | -| `nextHopNetwork` | `string` | The URL of the local network if it should handle matching packets. | | `routeType` | `string` | [Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route | -| `routeStatus` | `string` | [Output only] The status of the route. | -| `destRange` | `string` | The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. | +| `nextHopNetwork` | `string` | The URL of the local network if it should handle matching packets. | | `nextHopHub` | `string` | [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. | -| `nextHopIlb` | `string` | The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule | -| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. | -| `nextHopVpnTunnel` | `string` | The URL to a VpnTunnel that should handle matching packets. | +| `routeStatus` | `string` | [Output only] The status of the route. | | `network` | `string` | Fully-qualified URL of the network that this route applies to. | -| `priority` | `integer` | The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. | -| `asPaths` | `array` | [Output Only] AS path. | -| `kind` | `string` | [Output Only] Type of this resource. Always compute#routes for Route resources. | +| `nextHopIlb` | `string` | The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule | | `tags` | `array` | A list of instance tags to which this route applies. | -| `nextHopPeering` | `string` | [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. | | `nextHopInstance` | `string` | The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/ | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `priority` | `integer` | The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is `1000`. The priority value must be from `0` to `65535`, inclusive. | +| `nextHopVpnTunnel` | `string` | The URL to a VpnTunnel that should handle matching packets. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `nextHopGateway` | `string` | The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway | +| `nextHopPeering` | `string` | [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. | +| `asPaths` | `array` | [Output Only] AS path. | +| `destRange` | `string` | The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. | +| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. | +| `kind` | `string` | [Output Only] Type of this resource. Always compute#routes for Route resources. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/security_policies/index.md b/docs/google-docs/providers/google/compute/security_policies/index.md index 61341162cd..b7c278f128 100644 --- a/docs/google-docs/providers/google/compute/security_policies/index.md +++ b/docs/google-docs/providers/google/compute/security_policies/index.md @@ -30,19 +30,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `ddosProtectionConfig` | `object` | | -| `advancedOptionsConfig` | `object` | | -| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. | -| `type` | `string` | The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. | | `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `recaptchaOptionsConfig` | `object` | | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `type` | `string` | The type indicates the intended use of the security policy. - CLOUD_ARMOR: Cloud Armor backend security policies can be configured to filter incoming HTTP requests targeting backend services. They filter requests before they hit the origin servers. - CLOUD_ARMOR_EDGE: Cloud Armor edge security policies can be configured to filter incoming HTTP requests targeting backend services (including Cloud CDN-enabled) as well as backend buckets (Cloud Storage). They filter requests before the request is served from Google's cache. - CLOUD_ARMOR_INTERNAL_SERVICE: Cloud Armor internal service policies can be configured to filter HTTP requests targeting services managed by Traffic Director in a service mesh. They filter requests before the request is served from the application. - CLOUD_ARMOR_NETWORK: Cloud Armor network policies can be configured to filter packets targeting network load balancing resources such as backend services, target pools, target instances, and instances with external IPs. They filter requests before the request is served from the application. This field can be set only at resource creation time. | +| `advancedOptionsConfig` | `object` | | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `fingerprint` | `string` | Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the security policy. | | `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security policies | +| `ddosProtectionConfig` | `object` | | | `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `rules` | `array` | A list of rules that belong to this policy. There must always be a default rule which is a rule with priority 2147483647 and match all condition (for the match condition this means match "*" for srcIpRanges and for the networkMatch condition every field must be either match "*" or not set). If no rules are provided when creating a security policy, a default rule with action "allow" will be added. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this security policy, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make get() request to the security policy. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/security_policies_rule/index.md b/docs/google-docs/providers/google/compute/security_policies_rule/index.md index 2774d9b8a4..7aa6b7119c 100644 --- a/docs/google-docs/providers/google/compute/security_policies_rule/index.md +++ b/docs/google-docs/providers/google/compute/security_policies_rule/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `headerAction` | `object` | | -| `preview` | `boolean` | If set to true, the specified action is not enforced. | -| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. | | `preconfiguredWafConfig` | `object` | | -| `rateLimitOptions` | `object` | | +| `headerAction` | `object` | | | `redirectOptions` | `object` | | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `priority` | `integer` | An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest priority. | +| `preview` | `boolean` | If set to true, the specified action is not enforced. | | `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `rateLimitOptions` | `object` | | | `action` | `string` | The Action to perform when the rule is matched. The following are the valid actions: - allow: allow access to target. - deny(STATUS): deny access to target, returns the HTTP response code specified. Valid values for `STATUS` are 403, 404, and 502. - rate_based_ban: limit client traffic to the configured threshold and ban the client if the traffic exceeds the threshold. Configure parameters for this action in RateLimitOptions. Requires rate_limit_options to be set. - redirect: redirect to a different target. This can either be an internal reCAPTCHA redirect, or an external URL-based redirect via a 302 response. Parameters for this action can be configured via redirectOptions. This action is only supported in Global Security Policies of type CLOUD_ARMOR. - throttle: limit client traffic to the configured threshold. Configure parameters for this action in rateLimitOptions. Requires rate_limit_options to be set for this. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/compute/service_attachments/index.md b/docs/google-docs/providers/google/compute/service_attachments/index.md index 10e6ea31ef..4ca4129896 100644 --- a/docs/google-docs/providers/google/compute/service_attachments/index.md +++ b/docs/google-docs/providers/google/compute/service_attachments/index.md @@ -30,22 +30,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource type. The server generates this identifier. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. | -| `producerForwardingRule` | `string` | The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment. | -| `targetService` | `string` | The URL of a service serving the endpoint identified by this service attachment. | +| `consumerAcceptLists` | `array` | Projects that are allowed to connect to this service attachment. | +| `connectionPreference` | `string` | The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. | +| `enableProxyProtocol` | `boolean` | If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. | | `connectedEndpoints` | `array` | [Output Only] An array of connections for all the consumers connected to this service attachment. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `region` | `string` | [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | | `natSubnets` | `array` | An array of URLs where each entry is the URL of a subnet provided by the service producer to use for NAT in this service attachment. | | `consumerRejectLists` | `array` | Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number. | -| `reconcileConnections` | `boolean` | This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true. | -| `connectionPreference` | `string` | The connection preference of service attachment. The value can be set to ACCEPT_AUTOMATIC. An ACCEPT_AUTOMATIC service attachment is one that always accepts the connection from consumer forwarding rules. | -| `region` | `string` | [Output Only] URL of the region where the service attachment resides. This field applies only to the region resource. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `pscServiceAttachmentId` | `object` | | -| `enableProxyProtocol` | `boolean` | If true, enable the proxy protocol which is for supplying client TCP/IP address data in TCP connections that traverse proxies on their way to destination servers. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments. | +| `targetService` | `string` | The URL of a service serving the endpoint identified by this service attachment. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `consumerAcceptLists` | `array` | Projects that are allowed to connect to this service attachment. | +| `producerForwardingRule` | `string` | The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a ServiceAttachment. An up-to-date fingerprint must be provided in order to patch/update the ServiceAttachment; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the ServiceAttachment. | | `domainNames` | `array` | If specified, the domain name will be used during the integration between the PSC connected endpoints and the Cloud DNS. For example, this is a valid domain name: "p.mycompany.com.". Current max number of domain names supported is 1. | +| `reconcileConnections` | `boolean` | This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true. | +| `pscServiceAttachmentId` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/service_attachments_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/service_attachments_iam_audit_configs/index.md deleted file mode 100644 index 3f647583f9..0000000000 --- a/docs/google-docs/providers/google/compute/service_attachments_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: service_attachments_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - service_attachments_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Nameservice_attachments_iam_audit_configs
TypeResource
Idgoogle.compute.service_attachments_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `serviceAttachments_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/service_attachments_iam_bindings/index.md b/docs/google-docs/providers/google/compute/service_attachments_iam_bindings/index.md deleted file mode 100644 index a0a852d3ca..0000000000 --- a/docs/google-docs/providers/google/compute/service_attachments_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: service_attachments_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - service_attachments_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Nameservice_attachments_iam_bindings
TypeResource
Idgoogle.compute.service_attachments_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `serviceAttachments_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md b/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md index 01ddc415cc..1a991e4f08 100644 --- a/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/service_attachments_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/snapshots/index.md b/docs/google-docs/providers/google/compute/snapshots/index.md index 30dd36da14..265b694d4a 100644 --- a/docs/google-docs/providers/google/compute/snapshots/index.md +++ b/docs/google-docs/providers/google/compute/snapshots/index.md @@ -30,32 +30,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `creationSizeBytes` | `string` | [Output Only] Size in bytes of the snapshot at creation time. | -| `storageBytes` | `string` | [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. | -| `diskSizeGb` | `string` | [Output Only] Size of the source disk, specified in GB. | -| `snapshotEncryptionKey` | `object` | | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. | -| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. | -| `licenses` | `array` | [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `chainName` | `string` | Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. | -| `snapshotType` | `string` | Indicates the type of the snapshot. | -| `sourceDiskEncryptionKey` | `object` | | -| `downloadBytes` | `string` | [Output Only] Number of bytes downloaded to restore a snapshot to a disk. | | `sourceSnapshotSchedulePolicy` | `string` | [Output Only] URL of the resource policy which created this scheduled snapshot. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. | -| `architecture` | `string` | [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. | | `labels` | `object` | Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. | -| `autoCreated` | `boolean` | [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. | -| `licenseCodes` | `array` | [Output Only] Integer license codes indicating which licenses are attached to this snapshot. | -| `storageBytesStatus` | `string` | [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. | -| `locationHint` | `string` | An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. | | `storageLocations` | `array` | Cloud Storage bucket storage location of the snapshot (regional or multi-regional). | -| `sourceSnapshotSchedulePolicyId` | `string` | [Output Only] ID of the resource policy which created this scheduled snapshot. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. | +| `storageBytesStatus` | `string` | [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `locationHint` | `string` | An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. | | `sourceDisk` | `string` | The source disk used to create this snapshot. | | `status` | `string` | [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. | +| `licenseCodes` | `array` | [Output Only] Integer license codes indicating which licenses are attached to this snapshot. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. | +| `architecture` | `string` | [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. | +| `creationSizeBytes` | `string` | [Output Only] Size in bytes of the snapshot at creation time. | +| `sourceSnapshotSchedulePolicyId` | `string` | [Output Only] ID of the resource policy which created this scheduled snapshot. | +| `autoCreated` | `boolean` | [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. | +| `snapshotType` | `string` | Indicates the type of the snapshot. | +| `storageBytes` | `string` | [Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. | +| `chainName` | `string` | Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non-empty value. | +| `sourceDiskId` | `string` | [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. | +| `snapshotEncryptionKey` | `object` | | +| `sourceDiskEncryptionKey` | `object` | | +| `licenses` | `array` | [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). | +| `downloadBytes` | `string` | [Output Only] Number of bytes downloaded to restore a snapshot to a disk. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `diskSizeGb` | `string` | [Output Only] Size of the source disk, specified in GB. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/snapshots_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/snapshots_iam_audit_configs/index.md deleted file mode 100644 index 871d5dbfc1..0000000000 --- a/docs/google-docs/providers/google/compute/snapshots_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: snapshots_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - snapshots_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namesnapshots_iam_audit_configs
TypeResource
Idgoogle.compute.snapshots_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `snapshots_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/snapshots_iam_bindings/index.md b/docs/google-docs/providers/google/compute/snapshots_iam_bindings/index.md deleted file mode 100644 index ff5d871c7f..0000000000 --- a/docs/google-docs/providers/google/compute/snapshots_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: snapshots_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - snapshots_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namesnapshots_iam_bindings
TypeResource
Idgoogle.compute.snapshots_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `snapshots_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md b/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md index c5562c2953..0cf43e0c29 100644 --- a/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/snapshots_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/ssl_certificates/index.md b/docs/google-docs/providers/google/compute/ssl_certificates/index.md index 43f2b3ec5b..24e931609c 100644 --- a/docs/google-docs/providers/google/compute/ssl_certificates/index.md +++ b/docs/google-docs/providers/google/compute/ssl_certificates/index.md @@ -30,17 +30,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `certificate` | `string` | A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. | -| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | -| `privateKey` | `string` | A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | | `type` | `string` | (Optional) Specifies the type of SSL certificate, either "SELF_MANAGED" or "MANAGED". If not specified, the certificate is self-managed and the fields certificate and private_key are used. | -| `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | -| `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | -| `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | | `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global SSL Certificate. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | | `managed` | `object` | Configuration and status of a managed SSL certificate. | +| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | +| `privateKey` | `string` | A value read into memory from a write-only private key file. The private key file must be in PEM format. For security, only insert requests include this field. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | +| `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | +| `certificate` | `string` | A value read into memory from a certificate file. The certificate file must be in PEM format. The certificate chain must be no greater than 5 certs long. The chain must include at least one intermediate cert. | +| `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/ssl_policies/index.md b/docs/google-docs/providers/google/compute/ssl_policies/index.md index c294a7b157..b22df8f9ab 100644 --- a/docs/google-docs/providers/google/compute/ssl_policies/index.md +++ b/docs/google-docs/providers/google/compute/ssl_policies/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. | -| `enabledFeatures` | `array` | [Output Only] The list of features enabled in the SSL policy. | +| `minTlsVersion` | `string` | The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. | | `profile` | `string` | Profile specifies the set of SSL features that can be used by the load balancer when negotiating SSL with clients. This can be one of COMPATIBLE, MODERN, RESTRICTED, or CUSTOM. If using CUSTOM, the set of SSL features to enable must be specified in the customFeatures field. | | `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `customFeatures` | `array` | A list of features enabled when the selected profile is CUSTOM. The method returns the set of features that can be specified in this list. This field must be empty if the profile is not CUSTOM. | +| `enabledFeatures` | `array` | [Output Only] The list of features enabled in the SSL policy. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a SslPolicy. An up-to-date fingerprint must be provided in order to update the SslPolicy, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an SslPolicy. | -| `minTlsVersion` | `string` | The minimum version of SSL protocol that can be used by the clients to establish a connection with the load balancer. This can be one of TLS_1_0, TLS_1_1, TLS_1_2. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. | | `region` | `string` | [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/subnetworks/index.md b/docs/google-docs/providers/google/compute/subnetworks/index.md index 4a5887cb62..dd335a41b3 100644 --- a/docs/google-docs/providers/google/compute/subnetworks/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. | -| `gatewayAddress` | `string` | [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. | -| `logConfig` | `object` | The available logging options for this subnetwork. | +| `ipv6CidrRange` | `string` | [Output Only] This field is for internal use. | | `ipv6AccessType` | `string` | The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. | -| `privateIpGoogleAccess` | `boolean` | Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. | -| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | -| `enableFlowLogs` | `boolean` | Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `network` | `string` | The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. | | `role` | `string` | The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. | -| `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. | -| `stackType` | `string` | The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `externalIpv6Prefix` | `string` | The external IPv6 address range that is owned by this subnetwork. | -| `state` | `string` | [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY | -| `ipv6CidrRange` | `string` | [Output Only] This field is for internal use. | +| `enableFlowLogs` | `boolean` | Whether to enable flow logging for this subnetwork. If this field is not explicitly set, it will not appear in get listings. If not set the default behavior is determined by the org policy, if there is no org policy specified, then it will default to disabled. This field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | +| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. | -| `purpose` | `string` | The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | +| `stackType` | `string` | The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. | | `privateIpv6GoogleAccess` | `string` | This field is for internal use. This field can be both set at resource creation time and updated using patch. | -| `network` | `string` | The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. This field can be set only at resource creation time. | -| `secondaryIpRanges` | `array` | An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. | +| `externalIpv6Prefix` | `string` | The external IPv6 address range that is owned by this subnetwork. | +| `purpose` | `string` | The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | | `region` | `string` | URL of the region where the Subnetwork resides. This field can be set only at resource creation time. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a Subnetwork. An up-to-date fingerprint must be provided in order to update the Subnetwork, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a Subnetwork. | +| `privateIpGoogleAccess` | `boolean` | Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. | +| `gatewayAddress` | `string` | [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. | +| `secondaryIpRanges` | `array` | An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. The primary IP of such VM must belong to the primary ipCidrRange of the subnetwork. The alias IPs may belong to either primary or secondary ranges. This field can be updated with a patch request. | +| `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 100.64.0.0/10. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field is set at resource creation time. The range can be any range listed in the Valid ranges list. The range can be expanded after creation using expandIpCidrRange. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `logConfig` | `object` | The available logging options for this subnetwork. | +| `state` | `string` | [Output Only] The state of the subnetwork, which can be one of the following values: READY: Subnetwork is created and ready to use DRAINING: only applicable to subnetworks that have the purpose set to INTERNAL_HTTPS_LOAD_BALANCER and indicates that connections to the load balancer are being drained. A subnetwork that is draining cannot be used or modified until it reaches a status of READY | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/subnetworks_iam_audit_configs/index.md b/docs/google-docs/providers/google/compute/subnetworks_iam_audit_configs/index.md deleted file mode 100644 index cc9d0ff383..0000000000 --- a/docs/google-docs/providers/google/compute/subnetworks_iam_audit_configs/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: subnetworks_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - subnetworks_iam_audit_configs - - compute - - 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 ---- - - - -## Overview - - - - -
Namesubnetworks_iam_audit_configs
TypeResource
Idgoogle.compute.subnetworks_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `exemptedMembers` | `array` | This is deprecated and has no effect. Do not use. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `subnetworks_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/subnetworks_iam_bindings/index.md b/docs/google-docs/providers/google/compute/subnetworks_iam_bindings/index.md deleted file mode 100644 index b0a01b9f66..0000000000 --- a/docs/google-docs/providers/google/compute/subnetworks_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: subnetworks_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - subnetworks_iam_bindings - - compute - - 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 ---- - - - -## Overview - - - - -
Namesubnetworks_iam_bindings
TypeResource
Idgoogle.compute.subnetworks_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | This is deprecated and has no effect. Do not use. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `subnetworks_getIamPolicy` | `SELECT` | `project, region, resource` | diff --git a/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md b/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md index a5614eecdb..17952c3a1f 100644 --- a/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | This is deprecated and has no effect. Do not use. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/subnetworks_usable/index.md b/docs/google-docs/providers/google/compute/subnetworks_usable/index.md index 3093f6d012..ebe1106035 100644 --- a/docs/google-docs/providers/google/compute/subnetworks_usable/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks_usable/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. | -| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | -| `externalIpv6Prefix` | `string` | [Output Only] The external IPv6 address range that is assigned to this subnetwork. | -| `stackType` | `string` | The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. | | `role` | `string` | The role of subnetwork. Currently, this field is only used when purpose = REGIONAL_MANAGED_PROXY. The value can be set to ACTIVE or BACKUP. An ACTIVE subnetwork is one that is currently being used for Envoy-based load balancers in a region. A BACKUP subnetwork is one that is ready to be promoted to ACTIVE or is currently draining. This field can be updated with a patch request. | -| `subnetwork` | `string` | Subnetwork URL. | | `network` | `string` | Network URL. | +| `ipv6AccessType` | `string` | The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. | +| `stackType` | `string` | The stack type for the subnet. If set to IPV4_ONLY, new VMs in the subnet are assigned IPv4 addresses only. If set to IPV4_IPV6, new VMs in the subnet can be assigned both IPv4 and IPv6 addresses. If not specified, IPV4_ONLY is used. This field can be both set at resource creation time and updated using patch. | +| `subnetwork` | `string` | Subnetwork URL. | +| `externalIpv6Prefix` | `string` | [Output Only] The external IPv6 address range that is assigned to this subnetwork. | | `purpose` | `string` | The purpose of the resource. This field can be either PRIVATE, REGIONAL_MANAGED_PROXY, PRIVATE_SERVICE_CONNECT, or INTERNAL_HTTPS_LOAD_BALANCER. PRIVATE is the default purpose for user-created subnets or subnets that are automatically created in auto mode networks. A subnet with purpose set to REGIONAL_MANAGED_PROXY is a user-created subnetwork that is reserved for regional Envoy-based load balancers. A subnet with purpose set to PRIVATE_SERVICE_CONNECT is used to publish services using Private Service Connect. A subnet with purpose set to INTERNAL_HTTPS_LOAD_BALANCER is a proxy-only subnet that can be used only by regional internal HTTP(S) load balancers. Note that REGIONAL_MANAGED_PROXY is the preferred setting for all regional Envoy load balancers. If unspecified, the subnet purpose defaults to PRIVATE. The enableFlowLogs field isn't supported if the subnet purpose field is set to REGIONAL_MANAGED_PROXY. | +| `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | | `secondaryIpRanges` | `array` | Secondary IP ranges. | -| `ipv6AccessType` | `string` | The access type of IPv6 address this subnet holds. It's immutable and can only be specified during creation or the first time the subnet is updated into IPV4_IPV6 dual stack. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md b/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md index 3301e36244..203ab33db9 100644 --- a/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_grpc_proxies/index.md @@ -31,12 +31,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetGrpcProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetGrpcProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetGrpcProxy. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. The protocol field in the BackendService must be set to GRPC. | | `validateForProxyless` | `boolean` | If true, indicates that the BackendServices referenced by the urlMap may be accessed by gRPC applications without using a sidecar proxy. This will enable configuration checks on urlMap and its referenced BackendServices to not allow unsupported features. A gRPC application must use "xds:///" scheme in the target URI of the service it is connecting to. If false, indicates that the BackendServices referenced by the urlMap will be accessed by gRPC applications via a sidecar proxy. In this case, a gRPC application must not use "xds:///" scheme in the target URI of the service it is connecting to | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL with id for the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetGrpcProxy for target grpc proxies. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL with id for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/target_http_proxies/index.md b/docs/google-docs/providers/google/compute/target_http_proxies/index.md index 5bf3e4008b..21f4bcf4a7 100644 --- a/docs/google-docs/providers/google/compute/target_http_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_http_proxies/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpProxy. An up-to-date fingerprint must be provided in order to patch/update the TargetHttpProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpProxy. | -| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | | `region` | `string` | [Output Only] URL of the region where the regional Target HTTP Proxy resides. This field is not applicable to global Target HTTP Proxies. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpProxy for target HTTP proxies. | +| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/target_https_proxies/index.md b/docs/google-docs/providers/google/compute/target_https_proxies/index.md index 8613d7f013..94a34de814 100644 --- a/docs/google-docs/providers/google/compute/target_https_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_https_proxies/index.md @@ -30,20 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | +| `urlMap` | `string` | A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map | | `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | -| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. | -| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | | `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | -| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | | `quicOverride` | `string` | Specifies the QUIC override policy for this TargetHttpsProxy resource. This setting determines whether the load balancer attempts to negotiate QUIC with clients. You can specify NONE, ENABLE, or DISABLE. - When quic-override is set to NONE, Google manages whether QUIC is used. - When quic-override is set to ENABLE, the load balancer uses QUIC when possible. - When quic-override is set to DISABLE, the load balancer doesn't use QUIC. - If the quic-override flag is not specified, NONE is implied. | -| `serverTlsPolicy` | `string` | Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | +| `httpKeepAliveTimeoutSec` | `integer` | Specifies how long to keep a connection open, after completing a response, while there is no matching traffic (in seconds). If an HTTP keep-alive is not specified, a default value (610 seconds) will be used. For Global external HTTP(S) load balancer, the minimum allowed value is 5 seconds and the maximum allowed value is 1200 seconds. For Global external HTTP(S) load balancer (classic), this option is not available publicly. | | `authorizationPolicy` | `string` | Optional. A URL referring to a networksecurity.AuthorizationPolicy resource that describes how the proxy should authorize inbound traffic. If left blank, access will not be restricted by an authorization policy. Refer to the AuthorizationPolicy resource for additional details. authorizationPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED. Note: This field currently has no impact. | -| `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetHttpsProxy resource. If not set, the TargetHttpsProxy resource has no SSL policy configured. | -| `urlMap` | `string` | A fully-qualified or valid partial URL to the UrlMap resource that defines the mapping from URL to the BackendService. For example, the following are all valid URLs for specifying a URL map: - https://www.googleapis.compute/v1/projects/project/global/urlMaps/ url-map - projects/project/global/urlMaps/url-map - global/urlMaps/url-map | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a TargetHttpsProxy. An up-to-date fingerprint must be provided in order to patch the TargetHttpsProxy; otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the TargetHttpsProxy. | +| `serverTlsPolicy` | `string` | Optional. A URL referring to a networksecurity.ServerTlsPolicy resource that describes how the proxy should authenticate inbound traffic. serverTlsPolicy only applies to a global TargetHttpsProxy attached to globalForwardingRules with the loadBalancingScheme set to INTERNAL_SELF_MANAGED or EXTERNAL or EXTERNAL_MANAGED. For details which ServerTlsPolicy resources are accepted with INTERNAL_SELF_MANAGED and which with EXTERNAL, EXTERNAL_MANAGED loadBalancingScheme consult ServerTlsPolicy documentation. If left blank, communications are not encrypted. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | +| `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections between users and the load balancer. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/target_instances/index.md b/docs/google-docs/providers/google/compute/target_instances/index.md index 252d39d0ed..68d32db8ec 100644 --- a/docs/google-docs/providers/google/compute/target_instances/index.md +++ b/docs/google-docs/providers/google/compute/target_instances/index.md @@ -31,12 +31,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#targetInstance for target instances. | | `instance` | `string` | A URL to the virtual machine instance that handles traffic for this target instance. When creating a target instance, you can provide the fully-qualified URL or a valid partial URL to the desired virtual machine. For example, the following are all valid URLs: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance | -| `natPolicy` | `string` | Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance. | | `network` | `string` | The URL of the network this target instance uses to forward traffic. If not specified, the traffic will be forwarded to the network that the default network interface belongs to. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `zone` | `string` | [Output Only] URL of the zone where the target instance resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#targetInstance for target instances. | +| `natPolicy` | `string` | Must have a value of NO_NAT. Protocol forwarding delivers packets while preserving the destination IP address of the forwarding rule referencing the target instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/target_pools/index.md b/docs/google-docs/providers/google/compute/target_pools/index.md index 673dbf198d..23108519ec 100644 --- a/docs/google-docs/providers/google/compute/target_pools/index.md +++ b/docs/google-docs/providers/google/compute/target_pools/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `sessionAffinity` | `string` | Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetPool for target pools. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `healthChecks` | `array` | The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified. | -| `failoverRatio` | `number` | This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. | | `region` | `string` | [Output Only] URL of the region where the target pool resides. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `backupPool` | `string` | The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetPool for target pools. | | `instances` | `array` | A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool. | +| `failoverRatio` | `number` | This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. | +| `backupPool` | `string` | The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `sessionAffinity` | `string` | Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md b/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md index 45ac7040e1..59296ddb26 100644 --- a/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_ssl_proxies/index.md @@ -32,12 +32,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | | `proxyHeader` | `string` | Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. | | `certificateMap` | `string` | URL of a certificate map that identifies a certificate map associated with the given target proxy. This field can only be set for global target proxies. If set, sslCertificates will be ignored. Accepted format is //certificatemanager.googleapis.com/projects/{project }/locations/{location}/certificateMaps/{resourceName}. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `service` | `string` | URL to the BackendService resource. | | `sslPolicy` | `string` | URL of SslPolicy resource that will be associated with the TargetSslProxy resource. If not set, the TargetSslProxy resource will not have any SSL policy configured. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. | +| `service` | `string` | URL to the BackendService resource. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `sslCertificates` | `array` | URLs to SslCertificate resources that are used to authenticate connections to Backends. At least one SSL certificate must be specified. Currently, you may specify up to 15 SSL certificates. sslCertificates do not apply when the load balancing scheme is set to INTERNAL_SELF_MANAGED. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md b/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md index 9f4c93cfda..bbeee7fa54 100644 --- a/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md +++ b/docs/google-docs/providers/google/compute/target_tcp_proxies/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `service` | `string` | URL to the BackendService resource. | -| `proxyHeader` | `string` | Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. | -| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `region` | `string` | [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy. | +| `service` | `string` | URL to the BackendService resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | +| `proxyHeader` | `string` | Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `proxyBind` | `boolean` | This field only applies when the forwarding rule that references this target proxy has a loadBalancingScheme set to INTERNAL_SELF_MANAGED. When this field is set to true, Envoy proxies set up inbound traffic interception and bind to the IP address and port specified in the forwarding rule. This is generally useful when using Traffic Director to configure Envoy as a gateway or middle proxy (in other words, not a sidecar proxy). The Envoy proxy listens for inbound requests and handles requests when it receives them. The default is false. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md b/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md index 8d2d1ebd0f..cd9bd86f74 100644 --- a/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md +++ b/docs/google-docs/providers/google/compute/target_vpn_gateways/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. | -| `forwardingRules` | `array` | [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `tunnels` | `array` | [Output Only] A list of URLs to VpnTunnel resources. VpnTunnels are created using the compute.vpntunnels.insert method and associated with a VPN gateway. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `status` | `string` | [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. | -| `region` | `string` | [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this TargetVpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a TargetVpnGateway. | +| `forwardingRules` | `array` | [Output Only] A list of URLs to the ForwardingRule resources. ForwardingRules are created using compute.forwardingRules.insert and associated with a VPN gateway. | | `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | | `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | +| `region` | `string` | [Output Only] URL of the region where the target VPN gateway resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/url_maps/index.md b/docs/google-docs/providers/google/compute/url_maps/index.md index 018c627e90..0350e7ab95 100644 --- a/docs/google-docs/providers/google/compute/url_maps/index.md +++ b/docs/google-docs/providers/google/compute/url_maps/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | +| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | +| `region` | `string` | [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | -| `defaultService` | `string` | The full or partial URL of the defaultService resource to which traffic is directed if none of the hostRules match. If defaultRouteAction is also specified, advanced routing actions, such as URL rewrites, take effect before sending the request to the backend. However, if defaultService is specified, defaultRouteAction cannot contain any weightedBackendServices. Conversely, if routeAction specifies any weightedBackendServices, service must not be specified. Only one of defaultService, defaultUrlRedirect , or defaultRouteAction.weightedBackendService must be set. defaultService has no effect when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | | `fingerprint` | `string` | Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field is ignored when inserting a UrlMap. An up-to-date fingerprint must be provided in order to update the UrlMap, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a UrlMap. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | | `defaultRouteAction` | `object` | | -| `region` | `string` | [Output Only] URL of the region where the regional URL map resides. This field is not applicable to global URL maps. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `tests` | `array` | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. | +| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | +| `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | | `hostRules` | `array` | The list of host rules to use against the URL. | +| `tests` | `array` | The list of expected URL mapping tests. Request to update the UrlMap succeeds only if all test cases pass. You can specify a maximum of 100 tests per UrlMap. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/vpn_gateways/index.md b/docs/google-docs/providers/google/compute/vpn_gateways/index.md index 5a240b500b..cf38a2d587 100644 --- a/docs/google-docs/providers/google/compute/vpn_gateways/index.md +++ b/docs/google-docs/providers/google/compute/vpn_gateways/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | +| `region` | `string` | [Output Only] URL of the region where the VPN gateway resides. | | `stackType` | `string` | The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. | | `labelFingerprint` | `string` | A fingerprint for the labels being applied to this VpnGateway, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnGateway. | -| `region` | `string` | [Output Only] URL of the region where the VPN gateway resides. | -| `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `vpnInterfaces` | `array` | The list of VPN interfaces associated with this VPN gateway. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. | +| `vpnInterfaces` | `array` | The list of VPN interfaces associated with this VPN gateway. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/vpn_tunnels/index.md b/docs/google-docs/providers/google/compute/vpn_tunnels/index.md index df52d310d9..e865874ad3 100644 --- a/docs/google-docs/providers/google/compute/vpn_tunnels/index.md +++ b/docs/google-docs/providers/google/compute/vpn_tunnels/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional description of this resource. Provide this property when you create the resource. | -| `sharedSecretHash` | `string` | Hash of the shared secret. | -| `vpnGateway` | `string` | URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. | | `region` | `string` | [Output Only] URL of the region where the VPN tunnel resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. | -| `status` | `string` | [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. | -| `ikeVersion` | `integer` | IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. | -| `peerIp` | `string` | IP address of the peer VPN gateway. Only IPv4 is supported. | -| `peerExternalGatewayInterface` | `integer` | The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. | -| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | -| `sharedSecret` | `string` | Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. | | `localTrafficSelector` | `array` | Local traffic selector to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges must be disjoint. Only IPv4 is supported. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. | +| `sharedSecret` | `string` | Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. | +| `labels` | `object` | Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. | +| `peerExternalGatewayInterface` | `integer` | The interface ID of the external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. Possible values are: `0`, `1`, `2`, `3`. The number of IDs in use depends on the external VPN gateway redundancy type. | +| `peerExternalGateway` | `string` | URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `peerGcpGateway` | `string` | URL of the peer side HA GCP VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field can be used when creating highly available VPN from VPC network to VPC network, the field is exclusive with the field peerExternalGateway. If provided, the VPN tunnel will automatically use the same vpnGatewayInterface ID in the peer GCP VPN gateway. | -| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. | +| `remoteTrafficSelector` | `array` | Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. | +| `detailedStatus` | `string` | [Output Only] Detailed status message for the VPN tunnel. | +| `sharedSecretHash` | `string` | Hash of the shared secret. | | `vpnGatewayInterface` | `integer` | The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. | +| `ikeVersion` | `integer` | IKE protocol version to use when establishing the VPN tunnel with the peer VPN gateway. Acceptable IKE versions are 1 or 2. The default version is 2. | +| `labelFingerprint` | `string` | A fingerprint for the labels being applied to this VpnTunnel, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a VpnTunnel. | +| `vpnGateway` | `string` | URL of the VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. This must be used (instead of target_vpn_gateway) if a High Availability VPN gateway resource is created. | +| `targetVpnGateway` | `string` | URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. | +| `status` | `string` | [Output Only] The status of the VPN tunnel, which can be one of the following: - PROVISIONING: Resource is being allocated for the VPN tunnel. - WAITING_FOR_FULL_CONFIG: Waiting to receive all VPN-related configs from the user. Network, TargetVpnGateway, VpnTunnel, ForwardingRule, and Route resources are needed to setup the VPN tunnel. - FIRST_HANDSHAKE: Successful first handshake with the peer VPN. - ESTABLISHED: Secure session is successfully established with the peer VPN. - NETWORK_ERROR: Deprecated, replaced by NO_INCOMING_PACKETS - AUTHORIZATION_ERROR: Auth error (for example, bad shared secret). - NEGOTIATION_FAILURE: Handshake failed. - DEPROVISIONING: Resources are being deallocated for the VPN tunnel. - FAILED: Tunnel creation has failed and the tunnel is not ready to be used. - NO_INCOMING_PACKETS: No incoming packets from peer. - REJECTED: Tunnel configuration was rejected, can be result of being denied access. - ALLOCATING_RESOURCES: Cloud VPN is in the process of allocating all required resources. - STOPPED: Tunnel is stopped due to its Forwarding Rules being deleted for Classic VPN tunnels or the project is in frozen state. - PEER_IDENTITY_MISMATCH: Peer identity does not match peer IP, probably behind NAT. - TS_NARROWING_NOT_ALLOWED: Traffic selector narrowing not allowed for an HA-VPN tunnel. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. | +| `peerIp` | `string` | IP address of the peer VPN gateway. Only IPv4 is supported. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `detailedStatus` | `string` | [Output Only] Detailed status message for the VPN tunnel. | | `router` | `string` | URL of the router resource to be used for dynamic routing. | -| `targetVpnGateway` | `string` | URL of the Target VPN gateway with which this VPN tunnel is associated. Provided by the client when the VPN tunnel is created. | -| `remoteTrafficSelector` | `array` | Remote traffic selectors to use when establishing the VPN tunnel with the peer VPN gateway. The value should be a CIDR formatted string, for example: 192.168.0.0/16. The ranges should be disjoint. Only IPv4 is supported. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `peerExternalGateway` | `string` | URL of the peer side external VPN gateway to which this VPN tunnel is connected. Provided by the client when the VPN tunnel is created. This field is exclusive with the field peerGcpGateway. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/xpn_host/index.md b/docs/google-docs/providers/google/compute/xpn_host/index.md index ea8ae3c007..2b72ad9e6d 100644 --- a/docs/google-docs/providers/google/compute/xpn_host/index.md +++ b/docs/google-docs/providers/google/compute/xpn_host/index.md @@ -31,16 +31,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. | | `description` | `string` | An optional textual description of the resource. | | `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | +| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | +| `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | | `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | | `commonInstanceMetadata` | `object` | A metadata key/value entry. | -| `xpnProjectStatus` | `string` | [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `defaultNetworkTier` | `string` | This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. | -| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | +| `quotas` | `array` | [Output Only] Quotas assigned to this project. | | `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | +| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `quotas` | `array` | [Output Only] Quotas assigned to this project. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/compute/zone_operations/index.md b/docs/google-docs/providers/google/compute/zone_operations/index.md index 4bc968d526..1b4dac1f59 100644 --- a/docs/google-docs/providers/google/compute/zone_operations/index.md +++ b/docs/google-docs/providers/google/compute/zone_operations/index.md @@ -30,28 +30,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | | `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | | `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | | `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | -| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | +| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | | `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/zones/index.md b/docs/google-docs/providers/google/compute/zones/index.md index 4b6e27330a..5fe45dcd88 100644 --- a/docs/google-docs/providers/google/compute/zones/index.md +++ b/docs/google-docs/providers/google/compute/zones/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the resource. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] Textual description of the resource. | -| `availableCpuPlatforms` | `array` | [Output Only] Available cpu/platform selections for the zone. | +| `region` | `string` | [Output Only] Full URL reference to the region which hosts the zone. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `status` | `string` | [Output Only] Status of the zone, either UP or DOWN. | | `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#zone for zones. | | `deprecated` | `object` | Deprecation status for a public resource. | -| `region` | `string` | [Output Only] Full URL reference to the region which hosts the zone. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `status` | `string` | [Output Only] Status of the zone, either UP or DOWN. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `availableCpuPlatforms` | `array` | [Output Only] Available cpu/platform selections for the zone. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/connectors/actions/index.md b/docs/google-docs/providers/google/connectors/actions/index.md index 69ce0801b3..1d0f6563c8 100644 --- a/docs/google-docs/providers/google/connectors/actions/index.md +++ b/docs/google-docs/providers/google/connectors/actions/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the action. | -| `inputParameters` | `array` | List containing input parameter metadata. | | `resultMetadata` | `array` | List containing the metadata of result fields. | +| `inputParameters` | `array` | List containing input parameter metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/authentication_config/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/authentication_config/index.md deleted file mode 100644 index 449129be4c..0000000000 --- a/docs/google-docs/providers/google/contactcenteraiplatform/authentication_config/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: authentication_config -hide_title: false -hide_table_of_contents: false -keywords: - - authentication_config - - contactcenteraiplatform - - 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 ---- - - - -## Overview - - - - -
Nameauthentication_config
TypeResource
Idgoogle.contactcenteraiplatform.authentication_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Name of authentication config. Format: projects/{project}/locations/{location}/contactCenters/{contact_center}/authentication-config | -| `samlSetting` | `object` | | -| `basicAuthSetting` | `object` | | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `get_authentication-config` | `SELECT` | `contactCentersId, locationsId, projectsId` | -| `update_authentication-config` | `EXEC` | `contactCentersId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md index 38c2d62adb..23bf8d6041 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/contact_centers/index.md @@ -28,19 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | name of resource | -| `updateTime` | `string` | Output only. [Output only] Update time stamp | | `userEmail` | `string` | Optional. Email address of the first admin user. | -| `createTime` | `string` | Output only. [Output only] Create time stamp | | `ccaipManagedUsers` | `boolean` | Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity | -| `labels` | `object` | Labels as key value pairs | -| `state` | `string` | Output only. The state of this contact center. | +| `createTime` | `string` | Output only. [Output only] Create time stamp | | `customerDomainPrefix` | `string` | Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). | +| `state` | `string` | Output only. The state of this contact center. | +| `samlParams` | `object` | Message storing SAML params to enable Google as IDP. | | `displayName` | `string` | Required. A user friendly name for the ContactCenter. | -| `adminUser` | `object` | Message storing info about the first admin user. Next ID: 3 | | `instanceConfig` | `object` | Message storing the instance configuration. | -| `samlParams` | `object` | Message storing SAML params to enable Google as IDP. | -| `kmsKey` | `string` | Immutable. The KMS key name to encrypt the user input (`ContactCenter`). | +| `labels` | `object` | Labels as key value pairs | +| `adminUser` | `object` | Message storing info about the first admin user. Next ID: 3 | | `uris` | `object` | Message storing the URIs of the ContactCenter. | +| `updateTime` | `string` | Output only. [Output only] Update time stamp | +| `kmsKey` | `string` | Immutable. The KMS key name to encrypt the user input (`ContactCenter`). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md index b1e4857ba3..cd5b67f6c0 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md index 5961487ea8..bc7e6b56ae 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md b/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md index 80ba960dae..bb3e1f3fef 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} | -| `analysisResult` | `object` | The result of an analysis. | -| `annotatorSelector` | `object` | Selector of all available annotators and phrase matchers to run. | | `createTime` | `string` | Output only. The time at which the analysis was created, which occurs when the long-running operation completes. | | `requestTime` | `string` | Output only. The time at which the analysis was requested. | +| `analysisResult` | `object` | The result of an analysis. | +| `annotatorSelector` | `object` | Selector of all available annotators and phrase matchers to run. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md b/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md index 724e9d9728..33eb0c39ea 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/conversations/index.md @@ -28,25 +28,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation} | -| `medium` | `string` | Immutable. The conversation medium, if unspecified will default to PHONE_CALL. | | `runtimeAnnotations` | `array` | Output only. The annotations that were generated during the customer and agent interaction. | -| `ttl` | `string` | Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. | -| `transcript` | `object` | A message representing the transcript of a conversation. | -| `dialogflowIntents` | `object` | Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} | -| `dataSource` | `object` | The conversation source, which is a combination of transcript and audio. | -| `agentId` | `string` | An opaque, user-specified string representing the human agent who handled the conversation. | +| `medium` | `string` | Immutable. The conversation medium, if unspecified will default to PHONE_CALL. | +| `duration` | `string` | Output only. The duration of the conversation. | +| `languageCode` | `string` | A user-specified language code for the conversation. | | `createTime` | `string` | Output only. The time at which the conversation was created. | +| `expireTime` | `string` | The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. | | `latestAnalysis` | `object` | The analysis resource. | -| `turnCount` | `integer` | Output only. The number of turns in the conversation. | +| `agentId` | `string` | An opaque, user-specified string representing the human agent who handled the conversation. | +| `ttl` | `string` | Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. | +| `labels` | `object` | A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. | | `obfuscatedUserId` | `string` | Obfuscated user ID which the customer sent to us. | | `latestSummary` | `object` | Conversation summarization suggestion data. | -| `languageCode` | `string` | A user-specified language code for the conversation. | -| `labels` | `object` | A map for the user to specify any custom fields. A maximum of 20 labels per conversation is allowed, with a maximum of 256 characters per entry. | -| `duration` | `string` | Output only. The duration of the conversation. | -| `callMetadata` | `object` | Call-specific metadata. | -| `updateTime` | `string` | Output only. The most recent time at which the conversation was updated. | -| `expireTime` | `string` | The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. | +| `transcript` | `object` | A message representing the transcript of a conversation. | +| `dialogflowIntents` | `object` | Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent} | | `startTime` | `string` | The time at which the conversation started. | +| `turnCount` | `integer` | Output only. The number of turns in the conversation. | +| `updateTime` | `string` | Output only. The most recent time at which the conversation was updated. | +| `callMetadata` | `object` | Call-specific metadata. | +| `dataSource` | `object` | The conversation source, which is a combination of transcript and audio. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md b/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md index e57fd4c8b2..522acac6ea 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/issue_models/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the issue model. Format: projects/{project}/locations/{location}/issueModels/{issue_model} | -| `state` | `string` | Output only. State of the model. | -| `createTime` | `string` | Output only. The time at which this issue model was created. | | `updateTime` | `string` | Output only. The most recent time at which the issue model was updated. | +| `createTime` | `string` | Output only. The time at which this issue model was created. | +| `state` | `string` | Output only. State of the model. | | `displayName` | `string` | The representative name for the issue model. | -| `modelType` | `string` | Type of the model. | -| `languageCode` | `string` | Language of the model. | -| `issueCount` | `string` | Output only. Number of issues in this issue model. | | `inputDataConfig` | `object` | Configs for the input data used to create the issue model. | +| `languageCode` | `string` | Language of the model. | +| `modelType` | `string` | Type of the model. | | `trainingStats` | `object` | Aggregated statistics about an issue model. | +| `issueCount` | `string` | Output only. Number of issues in this issue model. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/issues/index.md b/docs/google-docs/providers/google/contactcenterinsights/issues/index.md index 2cf39045fd..eccb307f26 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/issues/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/issues/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the issue. Format: projects/{project}/locations/{location}/issueModels/{issue_model}/issues/{issue} | -| `sampleUtterances` | `array` | Output only. Resource names of the sample representative utterances that match to this issue. | | `updateTime` | `string` | Output only. The most recent time that this issue was updated. | | `createTime` | `string` | Output only. The time at which this issue was created. | | `displayName` | `string` | The representative name for the issue. | +| `sampleUtterances` | `array` | Output only. Resource names of the sample representative utterances that match to this issue. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/locations/index.md b/docs/google-docs/providers/google/contactcenterinsights/locations/index.md deleted file mode 100644 index 2e3b8855a6..0000000000 --- a/docs/google-docs/providers/google/contactcenterinsights/locations/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: locations -hide_title: false -hide_table_of_contents: false -keywords: - - locations - - contactcenterinsights - - 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 ---- - - - -## Overview - - - - -
Namelocations
TypeResource
Idgoogle.contactcenterinsights.locations
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_updateSettings` | `EXEC` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/contactcenterinsights/locations_settings/index.md b/docs/google-docs/providers/google/contactcenterinsights/locations_settings/index.md deleted file mode 100644 index 5fbf9e321c..0000000000 --- a/docs/google-docs/providers/google/contactcenterinsights/locations_settings/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: locations_settings -hide_title: false -hide_table_of_contents: false -keywords: - - locations_settings - - contactcenterinsights - - 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 ---- - - - -## Overview - - - - -
Namelocations_settings
TypeResource
Idgoogle.contactcenterinsights.locations_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings | -| `createTime` | `string` | Output only. The time at which the settings was created. | -| `languageCode` | `string` | A language code to be applied to each transcript segment unless the segment already specifies a language code. Language code defaults to "en-US" if it is neither specified on the segment nor here. | -| `pubsubNotificationSettings` | `object` | A map that maps a notification trigger to a Pub/Sub topic. Each time a specified trigger occurs, Insights will notify the corresponding Pub/Sub topic. Keys are notification triggers. Supported keys are: * "all-triggers": Notify each time any of the supported triggers occurs. * "create-analysis": Notify each time an analysis is created. * "create-conversation": Notify each time a conversation is created. * "export-insights-data": Notify each time an export is complete. * "update-conversation": Notify each time a conversation is updated via UpdateConversation. Values are Pub/Sub topics. The format of each Pub/Sub topic is: projects/{project}/topics/{topic} | -| `updateTime` | `string` | Output only. The time at which the settings were last updated. | -| `analysisConfig` | `object` | Default configuration when creating Analyses in Insights. | -| `conversationTtl` | `string` | The default TTL for newly-created conversations. If a conversation has a specified expiration, that value will be used instead. Changing this value will not change the expiration of existing conversations. Conversations with no expire time persist until they are deleted. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_getSettings` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/contactcenterinsights/operations/index.md b/docs/google-docs/providers/google/contactcenterinsights/operations/index.md index 503dd3d3f6..b2087ebabd 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/operations/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `error` | `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). | | `metadata` | `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. | | `response` | `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`. | | `done` | `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. | -| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md b/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md index 4aa317fe00..4f79541925 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the phrase matcher. Format: projects/{project}/locations/{location}/phraseMatchers/{phrase_matcher} | +| `type` | `string` | Required. The type of this phrase matcher. | +| `updateTime` | `string` | Output only. The most recent time at which the phrase matcher was updated. | | `active` | `boolean` | Applies the phrase matcher only when it is active. | | `revisionCreateTime` | `string` | Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added. | -| `updateTime` | `string` | Output only. The most recent time at which the phrase matcher was updated. | -| `versionTag` | `string` | The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. | -| `activationUpdateTime` | `string` | Output only. The most recent time at which the activation status was updated. | | `roleMatch` | `string` | The role whose utterances the phrase matcher should be matched against. If the role is ROLE_UNSPECIFIED it will be matched against any utterances in the transcript. | -| `type` | `string` | Required. The type of this phrase matcher. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567 | | `displayName` | `string` | The human-readable name of the phrase matcher. | | `phraseMatchRuleGroups` | `array` | A list of phase match rule groups that are included in this matcher. | -| `revisionId` | `string` | Output only. Immutable. The revision ID of the phrase matcher. A new revision is committed whenever the matcher is changed, except when it is activated or deactivated. A server generated random ID will be used. Example: locations/global/phraseMatchers/my-first-matcher@1234567 | +| `versionTag` | `string` | The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. | +| `activationUpdateTime` | `string` | Output only. The most recent time at which the activation status was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/views/index.md b/docs/google-docs/providers/google/contactcenterinsights/views/index.md index f19fd0fac9..08dd7fa32a 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/views/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/views/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the view. Format: projects/{project}/locations/{location}/views/{view} | +| `displayName` | `string` | The human-readable display name of the view. | | `updateTime` | `string` | Output only. The most recent time at which the view was updated. | | `value` | `string` | String with specific view properties, must be non-empty. | | `createTime` | `string` | Output only. The time at which this view was created. | -| `displayName` | `string` | The human-readable display name of the view. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/container/clusters_jwks/index.md b/docs/google-docs/providers/google/container/clusters_jwks/index.md index e6627ebe87..665e12dc83 100644 --- a/docs/google-docs/providers/google/container/clusters_jwks/index.md +++ b/docs/google-docs/providers/google/container/clusters_jwks/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `cacheHeader` | `object` | RFC-2616: cache control support | | `keys` | `array` | The public component of the keys used by the cluster to sign token requests. | +| `cacheHeader` | `object` | RFC-2616: cache control support | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/container/locations_server_config/index.md b/docs/google-docs/providers/google/container/locations_server_config/index.md deleted file mode 100644 index aa0e87b8cf..0000000000 --- a/docs/google-docs/providers/google/container/locations_server_config/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: locations_server_config -hide_title: false -hide_table_of_contents: false -keywords: - - locations_server_config - - container - - 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 ---- - - - -## Overview - - - - -
Namelocations_server_config
TypeResource
Idgoogle.container.locations_server_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `validMasterVersions` | `array` | List of valid master versions, in descending order. | -| `validNodeVersions` | `array` | List of valid node upgrade target versions, in descending order. | -| `channels` | `array` | List of release channel configurations. | -| `defaultClusterVersion` | `string` | Version of Kubernetes the service deploys by default. | -| `defaultImageType` | `string` | Default image type. | -| `validImageTypes` | `array` | List of valid image types. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_getServerConfig` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/container/node_pools/index.md b/docs/google-docs/providers/google/container/node_pools/index.md index 49becf5797..fb5e5809f9 100644 --- a/docs/google-docs/providers/google/container/node_pools/index.md +++ b/docs/google-docs/providers/google/container/node_pools/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the node pool. | -| `config` | `object` | Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. | -| `podIpv4CidrSize` | `integer` | [Output only] The pod CIDR block size per node in this node pool. | -| `instanceGroupUrls` | `array` | [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. | -| `maxPodsConstraint` | `object` | Constraints applied to pods. | -| `management` | `object` | NodeManagement defines the set of node management services turned on for the node pool. | -| `locations` | `array` | The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. | +| `conditions` | `array` | Which conditions caused the current node pool state. | +| `etag` | `string` | This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. | | `selfLink` | `string` | [Output only] Server-defined URL for the resource. | +| `statusMessage` | `string` | [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. | +| `status` | `string` | [Output only] The status of the nodes in this pool instance. | +| `maxPodsConstraint` | `object` | Constraints applied to pods. | +| `version` | `string` | The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). | | `initialNodeCount` | `integer` | The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. | +| `locations` | `array` | The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. | +| `management` | `object` | NodeManagement defines the set of node management services turned on for the node pool. | +| `updateInfo` | `object` | UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. | +| `config` | `object` | Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. | +| `networkConfig` | `object` | Parameters for node pool-level network config. | | `bestEffortProvisioning` | `object` | Best effort provisioning. | -| `status` | `string` | [Output only] The status of the nodes in this pool instance. | +| `instanceGroupUrls` | `array` | [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. | | `placementPolicy` | `object` | PlacementPolicy defines the placement policy used by the node pool. | -| `etag` | `string` | This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. | -| `conditions` | `array` | Which conditions caused the current node pool state. | -| `statusMessage` | `string` | [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. | +| `podIpv4CidrSize` | `integer` | [Output only] The pod CIDR block size per node in this node pool. | | `upgradeSettings` | `object` | These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is ROLLING, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. | -| `version` | `string` | The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version). | -| `networkConfig` | `object` | Parameters for node pool-level network config. | -| `updateInfo` | `object` | UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. | | `autoscaling` | `object` | NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/container/operations/index.md b/docs/google-docs/providers/google/container/operations/index.md index f678a6374a..2606169fff 100644 --- a/docs/google-docs/providers/google/container/operations/index.md +++ b/docs/google-docs/providers/google/container/operations/index.md @@ -28,20 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned ID for the operation. | +| `operationType` | `string` | The operation type. | +| `status` | `string` | The current status of the operation. | | `error` | `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). | | `statusMessage` | `string` | Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. | -| `zone` | `string` | The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. | -| `clusterConditions` | `array` | Which conditions caused the current cluster state. Deprecated. Use field error instead. | | `selfLink` | `string` | Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. | | `location` | `string` | [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. | -| `status` | `string` | The current status of the operation. | -| `detail` | `string` | Detailed operation progress, if available. | -| `targetLink` | `string` | Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` | -| `progress` | `object` | Information about operation (or operation stage) progress. | +| `nodepoolConditions` | `array` | Which conditions caused the current node pool state. Deprecated. Use field error instead. | +| `zone` | `string` | The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. | | `endTime` | `string` | [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `progress` | `object` | Information about operation (or operation stage) progress. | | `startTime` | `string` | [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | -| `nodepoolConditions` | `array` | Which conditions caused the current node pool state. Deprecated. Use field error instead. | -| `operationType` | `string` | The operation type. | +| `clusterConditions` | `array` | Which conditions caused the current cluster state. Deprecated. Use field error instead. | +| `targetLink` | `string` | Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` | +| `detail` | `string` | Detailed operation progress, if available. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/container/usable_subnetworks/index.md b/docs/google-docs/providers/google/container/usable_subnetworks/index.md index fd909a2dfe..99681f0ebc 100644 --- a/docs/google-docs/providers/google/container/usable_subnetworks/index.md +++ b/docs/google-docs/providers/google/container/usable_subnetworks/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `network` | `string` | Network Name. Example: projects/my-project/global/networks/my-network | -| `secondaryIpRanges` | `array` | Secondary IP ranges. | | `statusMessage` | `string` | A human readable status message representing the reasons for cases where the caller cannot use the secondary ranges under the subnet. For example if the secondary_ip_ranges is empty due to a permission issue, an insufficient permission message will be given by status_message. | | `subnetwork` | `string` | Subnetwork Name. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet | | `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. | +| `network` | `string` | Network Name. Example: projects/my-project/global/networks/my-network | +| `secondaryIpRanges` | `array` | Secondary IP ranges. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/container/well_known_openid_configuration/index.md b/docs/google-docs/providers/google/container/well_known_openid_configuration/index.md index 37e7813876..5b92b2529f 100644 --- a/docs/google-docs/providers/google/container/well_known_openid_configuration/index.md +++ b/docs/google-docs/providers/google/container/well_known_openid_configuration/index.md @@ -27,14 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `id_token_signing_alg_values_supported` | `array` | supported ID Token signing Algorithms. | +| `issuer` | `string` | OIDC Issuer. | +| `jwks_uri` | `string` | JSON Web Key uri. | | `response_types_supported` | `array` | Supported response types. | | `subject_types_supported` | `array` | Supported subject types. | | `cacheHeader` | `object` | RFC-2616: cache control support | | `claims_supported` | `array` | Supported claims. | | `grant_types` | `array` | Supported grant types. | -| `id_token_signing_alg_values_supported` | `array` | supported ID Token signing Algorithms. | -| `issuer` | `string` | OIDC Issuer. | -| `jwks_uri` | `string` | JSON Web Key uri. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/containeranalysis/notes/index.md b/docs/google-docs/providers/google/containeranalysis/notes/index.md index d80dbafaed..0cca9b0e9c 100644 --- a/docs/google-docs/providers/google/containeranalysis/notes/index.md +++ b/docs/google-docs/providers/google/containeranalysis/notes/index.md @@ -28,26 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. | -| `package` | `object` | PackageNote represents a particular package version. | -| `relatedUrl` | `array` | URLs associated with this note. | -| `attestation` | `object` | Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. | -| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | +| `dsseAttestation` | `object` | | | `sbomReference` | `object` | The note representing an SBOM reference. | -| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | | `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | -| `dsseAttestation` | `object` | | -| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | | `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | -| `relatedNoteNames` | `array` | Other notes related to this note. | -| `deployment` | `object` | An artifact that can be deployed in some runtime. | +| `longDescription` | `string` | A detailed description of this note. | | `discovery` | `object` | A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. | -| `shortDescription` | `string` | A one sentence description of this note. | +| `relatedNoteNames` | `array` | Other notes related to this note. | +| `compliance` | `object` | | +| `attestation` | `object` | Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. | +| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | | `vulnerability` | `object` | A security vulnerability that can be found in resources. | | `upgrade` | `object` | An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. | -| `longDescription` | `string` | A detailed description of this note. | -| `compliance` | `object` | | -| `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | +| `deployment` | `object` | An artifact that can be deployed in some runtime. | | `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | +| `shortDescription` | `string` | A one sentence description of this note. | +| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | +| `package` | `object` | PackageNote represents a particular package version. | +| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | +| `relatedUrl` | `array` | URLs associated with this note. | +| `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/containeranalysis/notes_batch/index.md b/docs/google-docs/providers/google/containeranalysis/notes_batch/index.md deleted file mode 100644 index dfaea83262..0000000000 --- a/docs/google-docs/providers/google/containeranalysis/notes_batch/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: notes_batch -hide_title: false -hide_table_of_contents: false -keywords: - - notes_batch - - containeranalysis - - 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 ---- - - - -## Overview - - - - -
Namenotes_batch
TypeResource
Idgoogle.containeranalysis.notes_batch
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_notes_batchCreate` | `INSERT` | `projectsId` | diff --git a/docs/google-docs/providers/google/containeranalysis/notes_iam_bindings/index.md b/docs/google-docs/providers/google/containeranalysis/notes_iam_bindings/index.md deleted file mode 100644 index eccc40d532..0000000000 --- a/docs/google-docs/providers/google/containeranalysis/notes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: notes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - notes_iam_bindings - - containeranalysis - - 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 ---- - - - -## Overview - - - - -
Namenotes_iam_bindings
TypeResource
Idgoogle.containeranalysis.notes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_notes_getIamPolicy` | `SELECT` | `notesId, projectsId` | diff --git a/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md b/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md index c52ebf92a5..8105fa2e72 100644 --- a/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md +++ b/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences/index.md index 2ab158bda9..a46ebb1d9f 100644 --- a/docs/google-docs/providers/google/containeranalysis/occurrences/index.md +++ b/docs/google-docs/providers/google/containeranalysis/occurrences/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. | -| `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | -| `remediation` | `string` | A description of actions that can be taken to remedy the note. | +| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | | `kind` | `string` | Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. | -| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | -| `upgrade` | `object` | An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. | +| `sbomReference` | `object` | The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. | +| `resourceUri` | `string` | Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image. | +| `build` | `object` | Details of a build occurrence. | +| `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | +| `noteName` | `string` | Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. | +| `remediation` | `string` | A description of actions that can be taken to remedy the note. | +| `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | | `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | -| `createTime` | `string` | Output only. The time this occurrence was created. | +| `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | | `updateTime` | `string` | Output only. The time this occurrence was last updated. | -| `noteName` | `string` | Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. | | `deployment` | `object` | The period during which some deployable was active in a runtime. | -| `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | -| `resourceUri` | `string` | Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image. | -| `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | -| `attestation` | `object` | Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. | -| `build` | `object` | Details of a build occurrence. | -| `sbomReference` | `object` | The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. | +| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | +| `upgrade` | `object` | An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. | +| `createTime` | `string` | Output only. The time this occurrence was created. | | `package` | `object` | Details on how a particular software package was installed on a system. | -| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | +| `attestation` | `object` | Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences_batch/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences_batch/index.md deleted file mode 100644 index 1e30a2a5f4..0000000000 --- a/docs/google-docs/providers/google/containeranalysis/occurrences_batch/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: occurrences_batch -hide_title: false -hide_table_of_contents: false -keywords: - - occurrences_batch - - containeranalysis - - 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 ---- - - - -## Overview - - - - -
Nameoccurrences_batch
TypeResource
Idgoogle.containeranalysis.occurrences_batch
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_occurrences_batchCreate` | `INSERT` | `projectsId` | diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences_iam_bindings/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences_iam_bindings/index.md deleted file mode 100644 index bd0d0e014b..0000000000 --- a/docs/google-docs/providers/google/containeranalysis/occurrences_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: occurrences_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - occurrences_iam_bindings - - containeranalysis - - 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 ---- - - - -## Overview - - - - -
Nameoccurrences_iam_bindings
TypeResource
Idgoogle.containeranalysis.occurrences_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_occurrences_getIamPolicy` | `SELECT` | `occurrencesId, projectsId` | diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md index a0140ec43e..41547867b8 100644 --- a/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md +++ b/docs/google-docs/providers/google/containeranalysis/occurrences_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md index 230ec199ff..0c408ee50c 100644 --- a/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md +++ b/docs/google-docs/providers/google/containeranalysis/occurrences_notes/index.md @@ -28,26 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. | -| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | -| `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | -| `attestation` | `object` | Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. | -| `relatedUrl` | `array` | URLs associated with this note. | -| `shortDescription` | `string` | A one sentence description of this note. | | `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | +| `package` | `object` | PackageNote represents a particular package version. | +| `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | | `compliance` | `object` | | -| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | | `upgrade` | `object` | An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. | -| `discovery` | `object` | A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. | -| `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | -| `longDescription` | `string` | A detailed description of this note. | -| `vulnerability` | `object` | A security vulnerability that can be found in resources. | -| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | +| `relatedNoteNames` | `array` | Other notes related to this note. | | `deployment` | `object` | An artifact that can be deployed in some runtime. | | `sbomReference` | `object` | The note representing an SBOM reference. | -| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | -| `relatedNoteNames` | `array` | Other notes related to this note. | -| `package` | `object` | PackageNote represents a particular package version. | +| `attestation` | `object` | Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. | +| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | | `dsseAttestation` | `object` | | +| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | +| `discovery` | `object` | A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A `Discovery` occurrence is created in a consumer's project at the start of analysis. | +| `longDescription` | `string` | A detailed description of this note. | +| `relatedUrl` | `array` | URLs associated with this note. | +| `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | +| `image` | `object` | Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. | +| `vulnerability` | `object` | A security vulnerability that can be found in resources. | +| `shortDescription` | `string` | A one sentence description of this note. | +| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md b/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md index 6e5b8f71a0..096c860054 100644 --- a/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/document_schemas/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema. | | `description` | `string` | Schema description. | -| `propertyDefinitions` | `array` | Document details. | | `updateTime` | `string` | Output only. The time when the document schema is last updated. | | `createTime` | `string` | Output only. The time when the document schema is created. | | `displayName` | `string` | Required. Name of the schema given by the user. Must be unique per project. | | `documentIsFolder` | `boolean` | Document Type, true refers the document is a folder, otherwise it is a typical document. | +| `propertyDefinitions` | `array` | Document details. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contentwarehouse/projects_acl/index.md b/docs/google-docs/providers/google/contentwarehouse/projects_acl/index.md deleted file mode 100644 index 96f8dcc434..0000000000 --- a/docs/google-docs/providers/google/contentwarehouse/projects_acl/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: projects_acl -hide_title: false -hide_table_of_contents: false -keywords: - - projects_acl - - contentwarehouse - - 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 ---- - - - -## Overview - - - - -
Nameprojects_acl
TypeResource
Idgoogle.contentwarehouse.projects_acl
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `metadata` | `object` | Additional information returned to client, such as debugging information. | -| `policy` | `object` | An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } **YAML example:** bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/). | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_fetchAcl` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md b/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md index 1b54832179..23a1467cbb 100644 --- a/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/rule_sets/index.md @@ -29,8 +29,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the rule set. Managed internally. Format: projects/{project_number}/locations/{location}/ruleSet/{rule_set_id}. The name is ignored when creating a rule set. | | `description` | `string` | Short description of the rule-set. | -| `source` | `string` | Source of the rules i.e., customer name. | | `rules` | `array` | List of rules given by the customer. | +| `source` | `string` | Source of the rules i.e., customer name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contentwarehouse/status/index.md b/docs/google-docs/providers/google/contentwarehouse/status/index.md index f2ec4dd9c9..85fc641ed8 100644 --- a/docs/google-docs/providers/google/contentwarehouse/status/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/status/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `qaEnabled` | `boolean` | If the qa is enabled on this project. | +| `state` | `string` | State of the project. | | `accessControlMode` | `string` | Access control mode. | | `databaseType` | `string` | Database type. | | `documentCreatorDefaultRole` | `string` | The default role for the person who create a document. | | `location` | `string` | The location of the queried project. | -| `qaEnabled` | `boolean` | If the qa is enabled on this project. | -| `state` | `string` | State of the project. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md b/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md index a8f2c3ba01..2ef5621055 100644 --- a/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/synonym_sets/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the SynonymSet This is mandatory for google.api.resource. Format: projects/{project_number}/locations/{location}/synonymSets/{context}. | -| `synonyms` | `array` | List of Synonyms for the context. | | `context` | `string` | This is a freeform field. Example contexts can be "sales," "engineering," "real estate," "accounting," etc. The context can be supplied during search requests. | +| `synonyms` | `array` | List of Synonyms for the context. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/entries/index.md b/docs/google-docs/providers/google/datacatalog/entries/index.md index b3e49fc8c0..d6b6aa6b79 100644 --- a/docs/google-docs/providers/google/datacatalog/entries/index.md +++ b/docs/google-docs/providers/google/datacatalog/entries/index.md @@ -29,31 +29,31 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. | | `description` | `string` | Entry description that can consist of several sentences or paragraphs that describe entry contents. 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). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. | -| `userSpecifiedType` | `string` | Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. | -| `dataSource` | `object` | Physical location of an entry. | +| `integratedSystem` | `string` | Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. | +| `gcsFilesetSpec` | `object` | Describes a Cloud Storage fileset entry. | +| `labels` | `object` | Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. | | `businessContext` | `object` | Business Context of the entry. | -| `usageSignal` | `object` | The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. | -| `bigqueryDateShardedSpec` | `object` | Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). | -| `type` | `string` | The type of the entry. For details, see [`EntryType`](#entrytype). | +| `filesetSpec` | `object` | Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. | | `dataSourceConnectionSpec` | `object` | Specification that applies to a data source connection. Valid only for entries with the `DATA_SOURCE_CONNECTION` type. Only one of internal specs can be set at the time, and cannot be changed later. | | `fullyQualifiedName` | `string` | [Fully Qualified Name (FQN)](https://cloud.google.com//data-catalog/docs/fully-qualified-names) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries. | +| `userSpecifiedType` | `string` | Custom entry type that doesn't match any of the values allowed for input and listed in the `EntryType` enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, `my_special_type`. The `user_specified_type` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. | | `personalDetails` | `object` | Entry metadata relevant only to the user and private to them. | +| `userSpecifiedSystem` | `string` | Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. | +| `displayName` | `string` | Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. | | `databaseTableSpec` | `object` | Specification that applies to a table resource. Valid only for entries with the `TABLE` type. | -| `sqlDatabaseSystemSpec` | `object` | Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_type) | +| `dataSource` | `object` | Physical location of an entry. | | `serviceSpec` | `object` | Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type. | +| `bigqueryDateShardedSpec` | `object` | Specification for a group of BigQuery tables with the `[prefix]YYYYMMDD` name pattern. For more information, see [Introduction to partitioned tables] (https://cloud.google.com/bigquery/docs/partitioned-tables#partitioning_versus_sharding). | +| `sqlDatabaseSystemSpec` | `object` | Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_type) | +| `bigqueryTableSpec` | `object` | Describes a BigQuery table. | +| `cloudBigtableSystemSpec` | `object` | Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type) | | `sourceSystemTimestamps` | `object` | Timestamps associated with this resource in a particular system. | -| `labels` | `object` | Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. | -| `filesetSpec` | `object` | Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. | | `lookerSystemSpec` | `object` | Specification that applies to entries that are part `LOOKER` system (user_specified_type) | -| `integratedSystem` | `string` | Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. | -| `userSpecifiedSystem` | `string` | Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The `user_specified_system` string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. | -| `gcsFilesetSpec` | `object` | Describes a Cloud Storage fileset entry. | -| `cloudBigtableSystemSpec` | `object` | Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type) | -| `schema` | `object` | Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. | +| `usageSignal` | `object` | The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. | | `routineSpec` | `object` | Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. | -| `bigqueryTableSpec` | `object` | Describes a BigQuery table. | -| `displayName` | `string` | Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. | +| `schema` | `object` | Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. | | `linkedResource` | `string` | The resource this metadata entry refers to. For Google Cloud Platform resources, `linked_resource` is the [Full Resource Name] (https://cloud.google.com/apis/design/resource_names#full_resource_name). For example, the `linked_resource` for a table resource from BigQuery is: `//bigquery.googleapis.com/projects/{PROJECT_ID}/datasets/{DATASET_ID}/tables/{TABLE_ID}` Output only when the entry is one of the types in the `EntryType` enum. For entries with a `user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (#). The maximum size is 200 bytes when encoded in UTF-8. | +| `type` | `string` | The type of the entry. For details, see [`EntryType`](#entrytype). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/entries_iam_bindings/index.md b/docs/google-docs/providers/google/datacatalog/entries_iam_bindings/index.md deleted file mode 100644 index a5a4340242..0000000000 --- a/docs/google-docs/providers/google/datacatalog/entries_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: entries_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - entries_iam_bindings - - datacatalog - - 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 ---- - - - -## Overview - - - - -
Nameentries_iam_bindings
TypeResource
Idgoogle.datacatalog.entries_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_entryGroups_entries_getIamPolicy` | `SELECT` | `entriesId, entryGroupsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md index a7b4510833..d0b5a29ebf 100644 --- a/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/entries_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/entry_groups_iam_bindings/index.md b/docs/google-docs/providers/google/datacatalog/entry_groups_iam_bindings/index.md deleted file mode 100644 index 42a9a14229..0000000000 --- a/docs/google-docs/providers/google/datacatalog/entry_groups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: entry_groups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - entry_groups_iam_bindings - - datacatalog - - 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 ---- - - - -## Overview - - - - -
Nameentry_groups_iam_bindings
TypeResource
Idgoogle.datacatalog.entry_groups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_entryGroups_getIamPolicy` | `SELECT` | `entryGroupsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datacatalog/operations/index.md b/docs/google-docs/providers/google/datacatalog/operations/index.md index 027a8e210a..bd6aae1d4a 100644 --- a/docs/google-docs/providers/google/datacatalog/operations/index.md +++ b/docs/google-docs/providers/google/datacatalog/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/policy_tags_iam_bindings/index.md b/docs/google-docs/providers/google/datacatalog/policy_tags_iam_bindings/index.md deleted file mode 100644 index 9c983412e6..0000000000 --- a/docs/google-docs/providers/google/datacatalog/policy_tags_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: policy_tags_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - policy_tags_iam_bindings - - datacatalog - - 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 ---- - - - -## Overview - - - - -
Namepolicy_tags_iam_bindings
TypeResource
Idgoogle.datacatalog.policy_tags_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_taxonomies_policyTags_getIamPolicy` | `SELECT` | `locationsId, policyTagsId, projectsId, taxonomiesId` | diff --git a/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md index 39ee629068..7f40dc536b 100644 --- a/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/policy_tags_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/tag_templates_iam_bindings/index.md b/docs/google-docs/providers/google/datacatalog/tag_templates_iam_bindings/index.md deleted file mode 100644 index d67e822076..0000000000 --- a/docs/google-docs/providers/google/datacatalog/tag_templates_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: tag_templates_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - tag_templates_iam_bindings - - datacatalog - - 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 ---- - - - -## Overview - - - - -
Nametag_templates_iam_bindings
TypeResource
Idgoogle.datacatalog.tag_templates_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_tagTemplates_getIamPolicy` | `SELECT` | `locationsId, projectsId, tagTemplatesId` | diff --git a/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md b/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md index 1b12c765c6..3fd10c2e59 100644 --- a/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/datacatalog/tag_templates_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/tags/index.md b/docs/google-docs/providers/google/datacatalog/tags/index.md index 1449151e5e..d5b3a2ca1d 100644 --- a/docs/google-docs/providers/google/datacatalog/tags/index.md +++ b/docs/google-docs/providers/google/datacatalog/tags/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the tag in URL format where tag ID is a system-generated identifier. Note: The tag itself might not be stored in the location specified in its name. | -| `template` | `string` | Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation. | -| `templateDisplayName` | `string` | Output only. The display name of the tag template. | | `column` | `string` | Resources like entry can have schemas associated with them. This scope allows you to attach tags to an individual column based on that schema. To attach a tag to a nested column, separate column names with a dot (`.`). Example: `column.nested_column`. | | `fields` | `object` | Required. Maps the ID of a tag field to its value and additional information about that field. Tag template defines valid field IDs. A tag must have at least 1 field and at most 500 fields. | +| `template` | `string` | Required. The resource name of the tag template this tag uses. Example: `projects/{PROJECT_ID}/locations/{LOCATION}/tagTemplates/{TAG_TEMPLATE_ID}` This field cannot be modified after creation. | +| `templateDisplayName` | `string` | Output only. The display name of the tag template. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/taxonomies/index.md b/docs/google-docs/providers/google/datacatalog/taxonomies/index.md index 04330d01ed..1c60759a8d 100644 --- a/docs/google-docs/providers/google/datacatalog/taxonomies/index.md +++ b/docs/google-docs/providers/google/datacatalog/taxonomies/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of this taxonomy in URL format. Note: Policy tag manager generates unique taxonomy IDs. | | `description` | `string` | Optional. Description of this taxonomy. If not set, defaults to empty. The description must contain only Unicode characters, tabs, newlines, carriage returns, and page breaks, and be at most 2000 bytes long when encoded in UTF-8. | +| `service` | `object` | The source system of the Taxonomy. | | `taxonomyTimestamps` | `object` | Timestamps associated with this resource in a particular system. | | `activatedPolicyTypes` | `array` | Optional. A list of policy types that are activated for this taxonomy. If not set, defaults to an empty list. | | `displayName` | `string` | Required. User-defined name of this taxonomy. The name can't start or end with spaces, must contain only Unicode letters, numbers, underscores, dashes, and spaces, and be at most 200 bytes long when encoded in UTF-8. The taxonomy display name must be unique within an organization. | | `policyTagCount` | `integer` | Output only. Number of policy tags in this taxonomy. | -| `service` | `object` | The source system of the Taxonomy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/taxonomies_iam_bindings/index.md b/docs/google-docs/providers/google/datacatalog/taxonomies_iam_bindings/index.md deleted file mode 100644 index 0960abb9ac..0000000000 --- a/docs/google-docs/providers/google/datacatalog/taxonomies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: taxonomies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - taxonomies_iam_bindings - - datacatalog - - 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 ---- - - - -## Overview - - - - -
Nametaxonomies_iam_bindings
TypeResource
Idgoogle.datacatalog.taxonomies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_taxonomies_getIamPolicy` | `SELECT` | `locationsId, projectsId, taxonomiesId` | diff --git a/docs/google-docs/providers/google/dataflow/jobs/index.md b/docs/google-docs/providers/google/dataflow/jobs/index.md index 78b967006f..c26265d29e 100644 --- a/docs/google-docs/providers/google/dataflow/jobs/index.md +++ b/docs/google-docs/providers/google/dataflow/jobs/index.md @@ -29,30 +29,30 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job. | | `name` | `string` | The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?` | -| `currentStateTime` | `string` | The timestamp associated with the current state. | -| `createdFromSnapshotId` | `string` | If this is specified, the job's initial state is populated from the given snapshot. | -| `steps` | `array` | Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL. | -| `type` | `string` | The type of Cloud Dataflow job. | | `stepsLocation` | `string` | The Cloud Storage location where the steps are stored. | -| `runtimeUpdatableParams` | `object` | Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. | -| `jobMetadata` | `object` | Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. | -| `transformNameMapping` | `object` | The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. | -| `tempFiles` | `array` | A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} | -| `requestedState` | `string` | The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. | -| `stageStates` | `array` | This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. | +| `labels` | `object` | User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. | | `startTime` | `string` | The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. | | `satisfiesPzs` | `boolean` | Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. | -| `labels` | `object` | User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. | +| `runtimeUpdatableParams` | `object` | Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. | | `createTime` | `string` | The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. | -| `currentState` | `string` | The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. | -| `replacedByJobId` | `string` | If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. | +| `requestedState` | `string` | The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. | | `replaceJobId` | `string` | If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job. | -| `location` | `string` | The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. | -| `executionInfo` | `object` | Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. | -| `environment` | `object` | Describes the environment in which a Dataflow Job runs. | +| `projectId` | `string` | The ID of the Cloud Platform project that the job belongs to. | | `clientRequestId` | `string` | The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it. | +| `steps` | `array` | Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL. | | `pipelineDescription` | `object` | A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. | -| `projectId` | `string` | The ID of the Cloud Platform project that the job belongs to. | +| `executionInfo` | `object` | Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. | +| `location` | `string` | The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. | +| `replacedByJobId` | `string` | If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job. | +| `currentState` | `string` | The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. | +| `stageStates` | `array` | This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. | +| `jobMetadata` | `object` | Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. | +| `transformNameMapping` | `object` | The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. | +| `type` | `string` | The type of Cloud Dataflow job. | +| `environment` | `object` | Describes the environment in which a Dataflow Job runs. | +| `createdFromSnapshotId` | `string` | If this is specified, the job's initial state is populated from the given snapshot. | +| `tempFiles` | `array` | A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} | +| `currentStateTime` | `string` | The timestamp associated with the current state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataflow/jobs_aggregated/index.md b/docs/google-docs/providers/google/dataflow/jobs_aggregated/index.md deleted file mode 100644 index 6474634745..0000000000 --- a/docs/google-docs/providers/google/dataflow/jobs_aggregated/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: jobs_aggregated -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_aggregated - - dataflow - - 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 ---- - - - -## Overview - - - - -
Namejobs_aggregated
TypeResource
Idgoogle.dataflow.jobs_aggregated
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | Set if there may be more results than fit in this response. | -| `failedLocation` | `array` | Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. | -| `jobs` | `array` | A subset of the requested job information. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_jobs_aggregated` | `SELECT` | `projectId` | diff --git a/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md b/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md index a0ee3d50f4..f16dfcef86 100644 --- a/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md +++ b/docs/google-docs/providers/google/dataflow/jobs_execution_details/index.md @@ -27,13 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `startTime` | `string` | Start time of this stage. | | `state` | `string` | State of this stage. | | `stragglerSummary` | `object` | Summarized straggler identification details. | | `endTime` | `string` | End time of this stage. If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time. | | `metrics` | `array` | Metrics for this stage. | | `progress` | `object` | Information about the progress of some component of job execution. | | `stageId` | `string` | ID of this stage | +| `startTime` | `string` | Start time of this stage. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dataflow/messages/index.md b/docs/google-docs/providers/google/dataflow/messages/index.md index 0649f5855b..f8df5939ec 100644 --- a/docs/google-docs/providers/google/dataflow/messages/index.md +++ b/docs/google-docs/providers/google/dataflow/messages/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | Deprecated. | +| `messageImportance` | `string` | Importance level of the message. | | `messageText` | `string` | The text of the message. | | `time` | `string` | The timestamp of the message. | -| `messageImportance` | `string` | Importance level of the message. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dataflow/projects_snapshots/index.md b/docs/google-docs/providers/google/dataflow/projects_snapshots/index.md deleted file mode 100644 index 821d5664cb..0000000000 --- a/docs/google-docs/providers/google/dataflow/projects_snapshots/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: projects_snapshots -hide_title: false -hide_table_of_contents: false -keywords: - - projects_snapshots - - dataflow - - 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 ---- - - - -## Overview - - - - -
Nameprojects_snapshots
TypeResource
Idgoogle.dataflow.projects_snapshots
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_deleteSnapshots` | `DELETE` | `projectId` | diff --git a/docs/google-docs/providers/google/dataflow/sql/index.md b/docs/google-docs/providers/google/dataflow/sql/index.md deleted file mode 100644 index 6ab1df5b9c..0000000000 --- a/docs/google-docs/providers/google/dataflow/sql/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: sql -hide_title: false -hide_table_of_contents: false -keywords: - - sql - - dataflow - - 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 ---- - - - -## Overview - - - - -
Namesql
TypeResource
Idgoogle.dataflow.sql
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_sql_validate` | `EXEC` | `location, projectId` | diff --git a/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md b/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md index ecd01c7f3c..47e5f085db 100644 --- a/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md +++ b/docs/google-docs/providers/google/dataflow/stages_execution_details/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `workItems` | `array` | Work items processed by this worker, sorted by time. | | `workerName` | `string` | Name of this worker | +| `workItems` | `array` | Work items processed by this worker, sorted by time. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dataflow/templates/index.md b/docs/google-docs/providers/google/dataflow/templates/index.md index a0b616abae..bc2c3e3614 100644 --- a/docs/google-docs/providers/google/dataflow/templates/index.md +++ b/docs/google-docs/providers/google/dataflow/templates/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metadata` | `object` | Metadata describing a template. | -| `runtimeMetadata` | `object` | RuntimeMetadata describing a runtime environment. | | `status` | `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). | | `templateType` | `string` | Template Type. | +| `metadata` | `object` | Metadata describing a template. | +| `runtimeMetadata` | `object` | RuntimeMetadata describing a runtime environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/compilation_results/index.md b/docs/google-docs/providers/google/dataform/compilation_results/index.md index 813ee58a7f..545b2c74da 100644 --- a/docs/google-docs/providers/google/dataform/compilation_results/index.md +++ b/docs/google-docs/providers/google/dataform/compilation_results/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The compilation result's name. | -| `resolvedGitCommitSha` | `string` | Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace. | | `workspace` | `string` | Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`. | | `codeCompilationConfig` | `object` | Configures various aspects of Dataform code compilation. | | `compilationErrors` | `array` | Output only. Errors encountered during project compilation. | | `dataformCoreVersion` | `string` | Output only. The version of `@dataform/core` that was used for compilation. | | `gitCommitish` | `string` | Immutable. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` | | `releaseConfig` | `string` | Immutable. The name of the release config to compile. The release config's 'current_compilation_result' field will be updated to this compilation result. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. | +| `resolvedGitCommitSha` | `string` | Output only. The fully resolved Git commit SHA of the code that was compiled. Not set for compilation results whose source is a workspace. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/locations/index.md b/docs/google-docs/providers/google/dataform/locations/index.md index a33842323a..e32d17a2cf 100644 --- a/docs/google-docs/providers/google/dataform/locations/index.md +++ b/docs/google-docs/providers/google/dataform/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/release_configs/index.md b/docs/google-docs/providers/google/dataform/release_configs/index.md index 46f66332ac..8e4577baf1 100644 --- a/docs/google-docs/providers/google/dataform/release_configs/index.md +++ b/docs/google-docs/providers/google/dataform/release_configs/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The release config's name. | -| `recentScheduledReleaseRecords` | `array` | Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. | | `releaseCompilationResult` | `string` | Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is created from this release config, or when this resource is updated by API call (perhaps to roll back to an earlier release). The compilation result must have been created using this release config. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. | | `timeZone` | `string` | Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. | | `codeCompilationConfig` | `object` | Configures various aspects of Dataform code compilation. | | `cronSchedule` | `string` | Optional. Optional schedule (in cron format) for automatic creation of compilation results. | | `gitCommitish` | `string` | Required. Git commit/tag/branch name at which the repository should be compiled. Must exist in the remote repository. Examples: - a commit SHA: `12ade345` - a tag: `tag1` - a branch name: `branch1` | +| `recentScheduledReleaseRecords` | `array` | Output only. Records of the 10 most recent scheduled release attempts, ordered in in descending order of `release_time`. Updated whenever automatic creation of a compilation result is triggered by cron_schedule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/repositories/index.md b/docs/google-docs/providers/google/dataform/repositories/index.md index 6ce45bbfc6..30de2d6659 100644 --- a/docs/google-docs/providers/google/dataform/repositories/index.md +++ b/docs/google-docs/providers/google/dataform/repositories/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The repository's name. | +| `displayName` | `string` | Optional. The repository's user-friendly name. | +| `gitRemoteSettings` | `object` | Controls Git remote configuration for a repository. | | `labels` | `object` | Optional. Repository user labels. | | `npmrcEnvironmentVariablesSecretVersion` | `string` | Optional. The name of the Secret Manager secret version to be used to interpolate variables into the .npmrc file for package installation operations. Must be in the format `projects/*/secrets/*/versions/*`. The file itself must be in a JSON format. | | `serviceAccount` | `string` | Optional. The service account to run workflow invocations under. | | `setAuthenticatedUserAdmin` | `boolean` | Optional. Input only. If set to true, the authenticated user will be granted the roles/dataform.admin role on the created repository. To modify access to the created repository later apply setIamPolicy from https://cloud.google.com/dataform/reference/rest#rest-resource:-v1beta1.projects.locations.repositories | | `workspaceCompilationOverrides` | `object` | Configures workspace compilation overrides for a repository. Primarily used by the UI (`console.cloud.google.com`). `schema_suffix` and `table_prefix` can have a special expression - `${workspaceName}`, which refers to the workspace name from which the compilation results will be created. API callers are expected to resolve the expression in these overrides and provide them explicitly in `code_compilation_config` (https://cloud.google.com/dataform/reference/rest/v1beta1/projects.locations.repositories.compilationResults#codecompilationconfig) when creating workspace-scoped compilation results. | -| `displayName` | `string` | Optional. The repository's user-friendly name. | -| `gitRemoteSettings` | `object` | Controls Git remote configuration for a repository. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/repositories_iam_policies/index.md b/docs/google-docs/providers/google/dataform/repositories_iam_policies/index.md index 88eeda0b77..4f0389c4ff 100644 --- a/docs/google-docs/providers/google/dataform/repositories_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataform/repositories_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/workflow_configs/index.md b/docs/google-docs/providers/google/dataform/workflow_configs/index.md index 3ed325052a..5ad9b319d9 100644 --- a/docs/google-docs/providers/google/dataform/workflow_configs/index.md +++ b/docs/google-docs/providers/google/dataform/workflow_configs/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The workflow config's name. | -| `recentScheduledExecutionRecords` | `array` | Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. | -| `releaseConfig` | `string` | Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. | | `timeZone` | `string` | Optional. Specifies the time zone to be used when interpreting cron_schedule. Must be a time zone name from the time zone database (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). If left unspecified, the default is UTC. | | `cronSchedule` | `string` | Optional. Optional schedule (in cron format) for automatic execution of this workflow config. | | `invocationConfig` | `object` | Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. | +| `recentScheduledExecutionRecords` | `array` | Output only. Records of the 10 most recent scheduled execution attempts, ordered in in descending order of `execution_time`. Updated whenever automatic creation of a workflow invocation is triggered by cron_schedule. | +| `releaseConfig` | `string` | Required. The name of the release config whose release_compilation_result should be executed. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/workflow_invocations/index.md b/docs/google-docs/providers/google/dataform/workflow_invocations/index.md index 2331a8f73c..f31ff0ea16 100644 --- a/docs/google-docs/providers/google/dataform/workflow_invocations/index.md +++ b/docs/google-docs/providers/google/dataform/workflow_invocations/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The workflow invocation's name. | +| `invocationTiming` | `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. | | `state` | `string` | Output only. This workflow invocation's current state. | | `workflowConfig` | `string` | Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`. | | `compilationResult` | `string` | Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. | | `invocationConfig` | `object` | Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. | -| `invocationTiming` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/dns_peerings/index.md b/docs/google-docs/providers/google/datafusion/dns_peerings/index.md index 7bd148cbb1..95aec8ff02 100644 --- a/docs/google-docs/providers/google/datafusion/dns_peerings/index.md +++ b/docs/google-docs/providers/google/datafusion/dns_peerings/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the dns peering zone. Format: projects/{project}/locations/{location}/instances/{instance}/dnsPeerings/{dns_peering} | | `description` | `string` | Optional. Optional description of the dns zone. | -| `domain` | `string` | Required. The dns name suffix of the zone. | | `targetNetwork` | `string` | Optional. Optional target network to which dns peering should happen. | | `targetProject` | `string` | Optional. Optional target project to which dns peering should happen. | +| `domain` | `string` | Required. The dns name suffix of the zone. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/instances/index.md b/docs/google-docs/providers/google/datafusion/instances/index.md index ee860c475c..45ed057baf 100644 --- a/docs/google-docs/providers/google/datafusion/instances/index.md +++ b/docs/google-docs/providers/google/datafusion/instances/index.md @@ -29,35 +29,35 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}. | | `description` | `string` | A description of this instance. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `stateMessage` | `string` | Output only. Additional information about the current state of this Data Fusion instance if available. | +| `tenantProjectId` | `string` | Output only. The name of the tenant project. | +| `networkConfig` | `object` | Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. | +| `p4ServiceAccount` | `string` | Output only. P4 service account for the customer project. | +| `enableStackdriverLogging` | `boolean` | Option to enable Stackdriver Logging. | +| `disabledReason` | `array` | Output only. If the instance state is DISABLED, the reason for disabling the instance. | | `enableRbac` | `boolean` | Option to enable granular role-based access control. | +| `state` | `string` | Output only. The current state of this Data Fusion instance. | +| `serviceAccount` | `string` | Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. | | `availableVersion` | `array` | Output only. Available versions that the instance can be upgraded to using UpdateInstanceRequest. | -| `updateTime` | `string` | Output only. The time the instance was last updated. | -| `p4ServiceAccount` | `string` | Output only. P4 service account for the customer project. | -| `privateInstance` | `boolean` | Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. | | `apiEndpoint` | `string` | Output only. Endpoint on which the REST APIs is accessible. | -| `networkConfig` | `object` | Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. | -| `labels` | `object` | The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. | -| `enableStackdriverLogging` | `boolean` | Option to enable Stackdriver Logging. | -| `gcsBucket` | `string` | Output only. Cloud Storage bucket generated by Data Fusion in the customer project. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | | `version` | `string` | Current version of the Data Fusion. Only specifiable in Update. | -| `type` | `string` | Required. Instance type. | -| `dataprocServiceAccount` | `string` | User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. | -| `cryptoKeyConfig` | `object` | The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. | -| `serviceEndpoint` | `string` | Output only. Endpoint on which the Data Fusion UI is accessible. | -| `tenantProjectId` | `string` | Output only. The name of the tenant project. | -| `displayName` | `string` | Display name for an instance. | +| `enableZoneSeparation` | `boolean` | Option to enable granular zone separation. | | `options` | `object` | Map of additional options used to configure the behavior of Data Fusion instance. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `displayName` | `string` | Display name for an instance. | +| `serviceEndpoint` | `string` | Output only. Endpoint on which the Data Fusion UI is accessible. | | `zone` | `string` | Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. | -| `state` | `string` | Output only. The current state of this Data Fusion instance. | -| `serviceAccount` | `string` | Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. | +| `dataprocServiceAccount` | `string` | User-managed service account to set on Dataproc when Cloud Data Fusion creates Dataproc to run data processing pipelines. This allows users to have fine-grained access control on Dataproc's accesses to cloud resources. | | `accelerators` | `array` | Output only. List of accelerators enabled for this CDF instance. | -| `createTime` | `string` | Output only. The time the instance was created. | -| `enableZoneSeparation` | `boolean` | Option to enable granular zone separation. | -| `enableStackdriverMonitoring` | `boolean` | Option to enable Stackdriver Monitoring. | -| `stateMessage` | `string` | Output only. Additional information about the current state of this Data Fusion instance if available. | -| `disabledReason` | `array` | Output only. If the instance state is DISABLED, the reason for disabling the instance. | +| `gcsBucket` | `string` | Output only. Cloud Storage bucket generated by Data Fusion in the customer project. | +| `updateTime` | `string` | Output only. The time the instance was last updated. | +| `type` | `string` | Required. Instance type. | +| `privateInstance` | `boolean` | Specifies whether the Data Fusion instance should be private. If set to true, all Data Fusion nodes will have private IP addresses and will not be able to access the public internet. | | `eventPublishConfig` | `object` | Confirguration of PubSubEventWriter. | +| `labels` | `object` | The resource labels for instance to use to annotate any related underlying resources such as Compute Engine VMs. The character '=' is not allowed to be used within the labels. | +| `cryptoKeyConfig` | `object` | The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. | +| `enableStackdriverMonitoring` | `boolean` | Option to enable Stackdriver Monitoring. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/instances_iam_audit_configs/index.md b/docs/google-docs/providers/google/datafusion/instances_iam_audit_configs/index.md deleted file mode 100644 index fa3b343ce8..0000000000 --- a/docs/google-docs/providers/google/datafusion/instances_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: instances_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_audit_configs - - datafusion - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_audit_configs
TypeResource
Idgoogle.datafusion.instances_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_instances_getIamPolicy` | `SELECT` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datafusion/instances_iam_bindings/index.md b/docs/google-docs/providers/google/datafusion/instances_iam_bindings/index.md deleted file mode 100644 index 39dcbf9ad1..0000000000 --- a/docs/google-docs/providers/google/datafusion/instances_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instances_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_bindings - - datafusion - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_bindings
TypeResource
Idgoogle.datafusion.instances_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_instances_getIamPolicy` | `SELECT` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datafusion/locations/index.md b/docs/google-docs/providers/google/datafusion/locations/index.md index 6ea79549bc..bc8c60607a 100644 --- a/docs/google-docs/providers/google/datafusion/locations/index.md +++ b/docs/google-docs/providers/google/datafusion/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/operations/index.md b/docs/google-docs/providers/google/datafusion/operations/index.md index 1a92d228c4..61c6838163 100644 --- a/docs/google-docs/providers/google/datafusion/operations/index.md +++ b/docs/google-docs/providers/google/datafusion/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/versions/index.md b/docs/google-docs/providers/google/datafusion/versions/index.md index a9641b4bdf..cb1aafdc9b 100644 --- a/docs/google-docs/providers/google/datafusion/versions/index.md +++ b/docs/google-docs/providers/google/datafusion/versions/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `defaultVersion` | `boolean` | Whether this is currently the default version for Cloud Data Fusion | | `type` | `string` | Type represents the release availability of the version | | `versionNumber` | `string` | The version number of the Data Fusion instance, such as '6.0.1.0'. | | `availableFeatures` | `array` | Represents a list of available feature names for a given version. | -| `defaultVersion` | `boolean` | Whether this is currently the default version for Cloud Data Fusion | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md b/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md index 71cb3c458e..c42c8ed7a9 100644 --- a/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md +++ b/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Output only. AnnotatedDataset resource name in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id} | | `description` | `string` | Output only. The description of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 10000 characters. | | `exampleCount` | `string` | Output only. Number of examples in the annotated dataset. | -| `createTime` | `string` | Output only. Time the AnnotatedDataset was created. | +| `annotationSource` | `string` | Output only. Source of the annotation. | | `labelStats` | `object` | Statistics about annotation specs. | -| `metadata` | `object` | Metadata on AnnotatedDataset. | -| `displayName` | `string` | Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters. | +| `createTime` | `string` | Output only. Time the AnnotatedDataset was created. | | `annotationType` | `string` | Output only. Type of the annotation. It is specified when starting labeling task. | -| `completedExampleCount` | `string` | Output only. Number of examples that have annotation in the annotated dataset. | -| `annotationSource` | `string` | Output only. Source of the annotation. | +| `metadata` | `object` | Metadata on AnnotatedDataset. | | `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the annotated dataset. | +| `completedExampleCount` | `string` | Output only. Number of examples that have annotation in the annotated dataset. | +| `displayName` | `string` | Output only. The display name of the AnnotatedDataset. It is specified in HumanAnnotationConfig when user starts a labeling task. Maximum of 64 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md b/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md index 491e844720..d913bd122d 100644 --- a/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md +++ b/docs/google-docs/providers/google/datalabeling/annotation_spec_sets/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The AnnotationSpecSet resource name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}" | | `description` | `string` | Optional. User-provided description of the annotation specification set. The description can be up to 10,000 characters long. | -| `displayName` | `string` | Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters. | | `annotationSpecs` | `array` | Required. The array of AnnotationSpecs that you define when you create the AnnotationSpecSet. These are the possible labels for the labeling task. | | `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the annotation spec set. | +| `displayName` | `string` | Required. The display name for AnnotationSpecSet that you define when you create it. Maximum of 64 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/datasets/index.md b/docs/google-docs/providers/google/datalabeling/datasets/index.md index 24df7d43f6..e6d82479b8 100644 --- a/docs/google-docs/providers/google/datalabeling/datasets/index.md +++ b/docs/google-docs/providers/google/datalabeling/datasets/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Dataset resource name, format is: projects/{project_id}/datasets/{dataset_id} | | `description` | `string` | Optional. User-provided description of the annotation specification set. The description can be up to 10000 characters long. | -| `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the dataset. | -| `createTime` | `string` | Output only. Time the dataset is created. | -| `dataItemCount` | `string` | Output only. The number of data items in the dataset. | | `displayName` | `string` | Required. The display name of the dataset. Maximum of 64 characters. | | `inputConfigs` | `array` | Output only. This is populated with the original input configs where ImportData is called. It is available only after the clients import data to this dataset. | | `lastMigrateTime` | `string` | Last time that the Dataset is migrated to AI Platform V2. If any of the AnnotatedDataset is migrated, the last_migration_time in Dataset is also updated. | +| `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the dataset. | +| `createTime` | `string` | Output only. Time the dataset is created. | +| `dataItemCount` | `string` | Output only. The number of data items in the dataset. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md b/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md index cce432f226..863e1f9df1 100644 --- a/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md +++ b/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. After you create a job, Data Labeling Service assigns a name to the job with the following format: "projects/{project_id}/evaluationJobs/ {evaluation_job_id}" | | `description` | `string` | Required. Description of the job. The description can be up to 25,000 characters long. | -| `createTime` | `string` | Output only. Timestamp of when this evaluation job was created. | -| `labelMissingGroundTruth` | `boolean` | Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`. | -| `modelVersion` | `string` | Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: "projects/{project_id}/models/{model_name}/versions/{version_name}" There can only be one evaluation job per model version. | -| `schedule` | `string` | Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in [crontab format](/scheduler/docs/configuring/cron-job-schedules) or in an [English-like format](/appengine/docs/standard/python/config/cronref#schedule_format). Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day. | | `attempts` | `array` | Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array. | +| `modelVersion` | `string` | Required. The [AI Platform Prediction model version](/ml-engine/docs/prediction-overview) to be evaluated. Prediction input and output is sampled from this model version. When creating an evaluation job, specify the model version in the following format: "projects/{project_id}/models/{model_name}/versions/{version_name}" There can only be one evaluation job per model version. | | `evaluationJobConfig` | `object` | Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob. | | `annotationSpecSet` | `string` | Required. Name of the AnnotationSpecSet describing all the labels that your machine learning model outputs. You must create this resource before you create an evaluation job and provide its name in the following format: "projects/{project_id}/annotationSpecSets/{annotation_spec_set_id}" | +| `schedule` | `string` | Required. Describes the interval at which the job runs. This interval must be at least 1 day, and it is rounded to the nearest day. For example, if you specify a 50-hour interval, the job runs every 2 days. You can provide the schedule in [crontab format](/scheduler/docs/configuring/cron-job-schedules) or in an [English-like format](/appengine/docs/standard/python/config/cronref#schedule_format). Regardless of what you specify, the job will run at 10:00 AM UTC. Only the interval from this schedule is used, not the specific time of day. | +| `createTime` | `string` | Output only. Timestamp of when this evaluation job was created. | +| `labelMissingGroundTruth` | `boolean` | Required. Whether you want Data Labeling Service to provide ground truth labels for prediction input. If you want the service to assign human labelers to annotate your data, set this to `true`. If you want to provide your own ground truth labels in the evaluation job's BigQuery table, set this to `false`. | | `state` | `string` | Output only. Describes the current state of the job. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/datalabeling/evaluations/index.md b/docs/google-docs/providers/google/datalabeling/evaluations/index.md index 2e8220360b..9b2fcc94ab 100644 --- a/docs/google-docs/providers/google/datalabeling/evaluations/index.md +++ b/docs/google-docs/providers/google/datalabeling/evaluations/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of an evaluation. The name has the following format: "projects/{project_id}/datasets/{dataset_id}/evaluations/ {evaluation_id}' | -| `evaluationMetrics` | `object` | | | `annotationType` | `string` | Output only. Type of task that the model version being evaluated performs, as defined in the evaluationJobConfig.inputConfig.annotationType field of the evaluation job that created this evaluation. | | `config` | `object` | Configuration details used for calculating evaluation metrics and creating an Evaluation. | | `createTime` | `string` | Output only. Timestamp for when this evaluation was created. | | `evaluatedItemCount` | `string` | Output only. The number of items in the ground truth dataset that were used for this evaluation. Only populated when the evaulation is for certain AnnotationTypes. | | `evaluationJobRunTime` | `string` | Output only. Timestamp for when the evaluation job that created this evaluation ran. | +| `evaluationMetrics` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md b/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md index 5c19f3f7b5..2cd9050e80 100644 --- a/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md +++ b/docs/google-docs/providers/google/datalabeling/feedback_messages/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}' | +| `body` | `string` | String content of the feedback. Maximum of 10000 characters. | +| `createTime` | `string` | Create time. | | `image` | `string` | The image storing this feedback if the feedback is an image representing operator's comments. | | `operatorFeedbackMetadata` | `object` | Metadata describing the feedback from the operator. | | `requesterFeedbackMetadata` | `object` | Metadata describing the feedback from the labeling task requester. | -| `body` | `string` | String content of the feedback. Maximum of 10000 characters. | -| `createTime` | `string` | Create time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/instructions/index.md b/docs/google-docs/providers/google/datalabeling/instructions/index.md index b5af31df2a..c270a788a9 100644 --- a/docs/google-docs/providers/google/datalabeling/instructions/index.md +++ b/docs/google-docs/providers/google/datalabeling/instructions/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Instruction resource name, format: projects/{project_id}/instructions/{instruction_id} | | `description` | `string` | Optional. User-provided description of the instruction. The description can be up to 10000 characters long. | -| `csvInstruction` | `object` | Deprecated: this instruction format is not supported any more. Instruction from a CSV file. | -| `displayName` | `string` | Required. The display name of the instruction. Maximum of 64 characters. | -| `createTime` | `string` | Output only. Creation time of instruction. | -| `pdfInstruction` | `object` | Instruction from a PDF file. | | `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the instruction. | | `dataType` | `string` | Required. The data type of this instruction. | +| `pdfInstruction` | `object` | Instruction from a PDF file. | +| `csvInstruction` | `object` | Deprecated: this instruction format is not supported any more. Instruction from a CSV file. | +| `createTime` | `string` | Output only. Creation time of instruction. | +| `displayName` | `string` | Required. The display name of the instruction. Maximum of 64 characters. | | `updateTime` | `string` | Output only. Last update time of instruction. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/datalabeling/operations/index.md b/docs/google-docs/providers/google/datalabeling/operations/index.md index 3aeb4d1d54..4e4eb11a0d 100644 --- a/docs/google-docs/providers/google/datalabeling/operations/index.md +++ b/docs/google-docs/providers/google/datalabeling/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalineage/operations/index.md b/docs/google-docs/providers/google/datalineage/operations/index.md index 1e53719cc8..3bf857a63e 100644 --- a/docs/google-docs/providers/google/datalineage/operations/index.md +++ b/docs/google-docs/providers/google/datalineage/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalineage/processes/index.md b/docs/google-docs/providers/google/datalineage/processes/index.md index 069d54226a..03c61f8ace 100644 --- a/docs/google-docs/providers/google/datalineage/processes/index.md +++ b/docs/google-docs/providers/google/datalineage/processes/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the lineage process. Format: `projects/{project}/locations/{location}/processes/{process}`. Can be specified or auto-assigned. {process} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` | +| `origin` | `object` | Origin of a process. | | `attributes` | `object` | Optional. The attributes of the process. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the process). Up to 100 attributes are allowed. | | `displayName` | `string` | Optional. A human-readable name you can set to display in a user interface. Must be not longer than 200 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.` | -| `origin` | `object` | Origin of a process. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalineage/runs/index.md b/docs/google-docs/providers/google/datalineage/runs/index.md index 7f13ad53cb..701c46905d 100644 --- a/docs/google-docs/providers/google/datalineage/runs/index.md +++ b/docs/google-docs/providers/google/datalineage/runs/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the run. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}`. Can be specified or auto-assigned. {run} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` | +| `attributes` | `object` | Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed. | | `displayName` | `string` | Optional. A human-readable name you can set to display in a user interface. Must be not longer than 1024 characters and only contain UTF-8 letters or numbers, spaces or characters like `_-:&.` | | `endTime` | `string` | Optional. The timestamp of the end of the run. | | `startTime` | `string` | Required. The timestamp of the start of the run. | | `state` | `string` | Required. The state of the run. | -| `attributes` | `object` | Optional. The attributes of the run. Should only be used for the purpose of non-semantic management (classifying, describing or labeling the run). Up to 100 attributes are allowed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/connection_profiles/index.md b/docs/google-docs/providers/google/datamigration/connection_profiles/index.md index 2d89c6352d..a849d5d31b 100644 --- a/docs/google-docs/providers/google/datamigration/connection_profiles/index.md +++ b/docs/google-docs/providers/google/datamigration/connection_profiles/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}. | +| `provider` | `string` | The database provider. | +| `mysql` | `object` | Specifies connection parameters required specifically for MySQL databases. | | `alloydb` | `object` | Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. | +| `postgresql` | `object` | Specifies connection parameters required specifically for PostgreSQL databases. | +| `labels` | `object` | The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. | | `cloudsql` | `object` | Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. | +| `updateTime` | `string` | Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | +| `state` | `string` | The current connection profile state (e.g. DRAFT, READY, or FAILED). | | `createTime` | `string` | Output only. The timestamp when the resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | -| `error` | `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). | -| `labels` | `object` | The resource labels for connection profile to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. | -| `mysql` | `object` | Specifies connection parameters required specifically for MySQL databases. | | `displayName` | `string` | The connection profile display name. | -| `state` | `string` | The current connection profile state (e.g. DRAFT, READY, or FAILED). | -| `provider` | `string` | The database provider. | -| `postgresql` | `object` | Specifies connection parameters required specifically for PostgreSQL databases. | +| `error` | `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). | | `oracle` | `object` | Specifies connection parameters required specifically for Oracle databases. | -| `updateTime` | `string` | Output only. The timestamp when the resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_audit_configs/index.md b/docs/google-docs/providers/google/datamigration/connection_profiles_iam_audit_configs/index.md deleted file mode 100644 index f285a4d78a..0000000000 --- a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: connection_profiles_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - connection_profiles_iam_audit_configs - - datamigration - - 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 ---- - - - -## Overview - - - - -
Nameconnection_profiles_iam_audit_configs
TypeResource
Idgoogle.datamigration.connection_profiles_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_connectionProfiles_getIamPolicy` | `SELECT` | `connectionProfilesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_bindings/index.md b/docs/google-docs/providers/google/datamigration/connection_profiles_iam_bindings/index.md deleted file mode 100644 index 9aab0a6c95..0000000000 --- a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: connection_profiles_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - connection_profiles_iam_bindings - - datamigration - - 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 ---- - - - -## Overview - - - - -
Nameconnection_profiles_iam_bindings
TypeResource
Idgoogle.datamigration.connection_profiles_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_connectionProfiles_getIamPolicy` | `SELECT` | `connectionProfilesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md b/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md index 41428a64a0..24ddc4d2f0 100644 --- a/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md +++ b/docs/google-docs/providers/google/datamigration/connection_profiles_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md b/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md index 7b29ec462b..7204dbf520 100644 --- a/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md +++ b/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}. | +| `hasUncommittedChanges` | `boolean` | Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). | | `latestCommitTime` | `string` | Output only. The timestamp when the workspace was committed. | | `displayName` | `string` | Optional. The display name for the workspace. | +| `createTime` | `string` | Output only. The timestamp when the workspace resource was created. | | `destination` | `object` | The type and version of a source or destination database. | -| `hasUncommittedChanges` | `boolean` | Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). | -| `latestCommitId` | `string` | Output only. The latest commit ID. | -| `source` | `object` | The type and version of a source or destination database. | | `updateTime` | `string` | Output only. The timestamp when the workspace resource was last updated. | -| `createTime` | `string` | Output only. The timestamp when the workspace resource was created. | +| `latestCommitId` | `string` | Output only. The latest commit ID. | | `globalSettings` | `object` | Optional. A generic list of settings for the workspace. The settings are database pair dependant and can indicate default behavior for the mapping rules engine or turn on or off specific features. Such examples can be: convert_foreign_key_to_interleave=true, skip_triggers=false, ignore_non_table_synonyms=true | +| `source` | `object` | The type and version of a source or destination database. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md b/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md index 4c9d8f6796..78446d5fc3 100644 --- a/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md +++ b/docs/google-docs/providers/google/datamigration/conversion_workspaces_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/locations/index.md b/docs/google-docs/providers/google/datamigration/locations/index.md index 5989115392..2190a6ad53 100644 --- a/docs/google-docs/providers/google/datamigration/locations/index.md +++ b/docs/google-docs/providers/google/datamigration/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/mapping_rules/index.md b/docs/google-docs/providers/google/datamigration/mapping_rules/index.md index 4aabc7b1e3..4f14415454 100644 --- a/docs/google-docs/providers/google/datamigration/mapping_rules/index.md +++ b/docs/google-docs/providers/google/datamigration/mapping_rules/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}. | +| `ruleScope` | `string` | Required. The rule scope | | `displayName` | `string` | Optional. A human readable name | -| `filter` | `object` | A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. | -| `state` | `string` | Optional. The mapping rule state | -| `singleEntityRename` | `object` | Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym | | `multiEntityRename` | `object` | Options to configure rule type MultiEntityRename. The rule is used to rename multiple entities. The rule filter field can refer to one or more entities. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT | +| `singleEntityRename` | `object` | Options to configure rule type SingleEntityRename. The rule is used to rename an entity. The rule filter field can refer to only one entity. The rule scope can be one of: Database, Schema, Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT, Synonym | +| `filterTableColumns` | `object` | Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. | | `convertRowidColumn` | `object` | Options to configure rule type ConvertROWIDToColumn. The rule is used to add column rowid to destination tables based on an Oracle rowid function/property. The rule filter field can refer to one or more entities. The rule scope can be one of: Table. This rule requires additional filter to be specified beyond the basic rule filter field, which is whether or not to work on tables which already have a primary key defined. | -| `ruleOrder` | `string` | Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. | +| `sourceSqlChange` | `object` | Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View | | `revisionId` | `string` | Output only. The revision ID of the mapping rule. A new revision is committed whenever the mapping rule is changed in any way. The format is an 8-character hexadecimal string. | | `singleColumnChange` | `object` | Options to configure rule type SingleColumnChange. The rule is used to change the properties of a column. The rule filter field can refer to one entity. The rule scope can be one of: Column. When using this rule, if a field is not specified than the destination column's configuration will be the same as the one in the source column.. | -| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | -| `sourceSqlChange` | `object` | Options to configure rule type SourceSqlChange. The rule is used to alter the sql code for database entities. The rule filter field can refer to one entity. The rule scope can be: StoredProcedure, Function, Trigger, View | -| `ruleScope` | `string` | Required. The rule scope | +| `multiColumnDataTypeChange` | `object` | Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). | | `entityMove` | `object` | Options to configure rule type EntityMove. The rule is used to move an entity to a new schema. The rule filter field can refer to one or more entities. The rule scope can be one of: Table, Column, Constraint, Index, View, Function, Stored Procedure, Materialized View, Sequence, UDT | +| `filter` | `object` | A filter defining the entities that a mapping rule should be applied to. When more than one field is specified, the rule is applied only to entities which match all the fields. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | | `singlePackageChange` | `object` | Options to configure rule type SinglePackageChange. The rule is used to alter the sql code for a package entities. The rule filter field can refer to one entity. The rule scope can be: Package | -| `filterTableColumns` | `object` | Options to configure rule type FilterTableColumns. The rule is used to filter the list of columns to include or exclude from a table. The rule filter field can refer to one entity. The rule scope can be: Table Only one of the two lists can be specified for the rule. | -| `multiColumnDataTypeChange` | `object` | Options to configure rule type MultiColumnDatatypeChange. The rule is used to change the data type and associated properties of multiple columns at once. The rule filter field can refer to one or more entities. The rule scope can be one of:Column. This rule requires additional filters to be specified beyond the basic rule filter field, which is the source data type, but the rule supports additional filtering capabilities such as the minimum and maximum field length. All additional filters which are specified are required to be met in order for the rule to be applied (logical AND between the fields). | -| `conditionalColumnSetValue` | `object` | Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. | +| `ruleOrder` | `string` | Required. The order in which the rule is applied. Lower order rules are applied before higher value rules so they may end up being overridden. | | `setTablePrimaryKey` | `object` | Options to configure rule type SetTablePrimaryKey. The rule is used to specify the columns and name to configure/alter the primary key of a table. The rule filter field can refer to one entity. The rule scope can be one of: Table. | +| `state` | `string` | Optional. The mapping rule state | +| `conditionalColumnSetValue` | `object` | Options to configure rule type ConditionalColumnSetValue. The rule is used to transform the data which is being replicated/migrated. The rule filter field can refer to one or more entities. The rule scope can be one of: Column. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/migration_jobs/index.md b/docs/google-docs/providers/google/datamigration/migration_jobs/index.md index 7ed16aa1ce..6b9bc7305c 100644 --- a/docs/google-docs/providers/google/datamigration/migration_jobs/index.md +++ b/docs/google-docs/providers/google/datamigration/migration_jobs/index.md @@ -28,29 +28,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}. | -| `displayName` | `string` | The migration job display name. | -| `destinationDatabase` | `object` | A message defining the database engine and provider. | -| `conversionWorkspace` | `object` | A conversion workspace's version. | -| `dumpPath` | `string` | The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive. | -| `sourceDatabase` | `object` | A message defining the database engine and provider. | -| `performanceConfig` | `object` | Performance configuration definition. | -| `phase` | `string` | Output only. The current migration job phase. | -| `source` | `string` | Required. The resource name (URI) of the source connection profile. | | `createTime` | `string` | Output only. The timestamp when the migration job resource was created. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | -| `destination` | `string` | Required. The resource name (URI) of the destination connection profile. | -| `state` | `string` | The current migration job state. | | `dumpFlags` | `object` | Dump flags definition. | -| `filter` | `string` | This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. | -| `staticIpConnectivity` | `object` | The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. | -| `updateTime` | `string` | Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | +| `endTime` | `string` | Output only. If the migration job is completed, the time when it was completed. | +| `performanceConfig` | `object` | Performance configuration definition. | +| `vpcPeeringConnectivity` | `object` | The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. | +| `cmekKeyName` | `string` | The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME] | +| `sourceDatabase` | `object` | A message defining the database engine and provider. | +| `error` | `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). | +| `destination` | `string` | Required. The resource name (URI) of the destination connection profile. | +| `source` | `string` | Required. The resource name (URI) of the source connection profile. | | `reverseSshConnectivity` | `object` | The details needed to configure a reverse SSH tunnel between the source and destination databases. These details will be used when calling the generateSshScript method (see https://cloud.google.com/database-migration/docs/reference/rest/v1/projects.locations.migrationJobs/generateSshScript) to produce the script that will help set up the reverse SSH tunnel, and to set up the VPC peering between the Cloud SQL private network and the VPC. | +| `updateTime` | `string` | Output only. The timestamp when the migration job resource was last updated. A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z". | +| `staticIpConnectivity` | `object` | The source database will allow incoming connections from the public IP of the destination database. You can retrieve the public IP of the Cloud SQL instance from the Cloud SQL console or using Cloud SQL APIs. No additional configuration is required. | +| `filter` | `string` | This field can be used to select the entities to migrate as part of the migration job. It uses AIP-160 notation to select a subset of the entities configured on the associated conversion-workspace. This field should not be set on migration-jobs that are not associated with a conversion workspace. | +| `destinationDatabase` | `object` | A message defining the database engine and provider. | +| `conversionWorkspace` | `object` | A conversion workspace's version. | +| `type` | `string` | Required. The migration job type. | | `duration` | `string` | Output only. The duration of the migration job (in seconds). A duration in seconds with up to nine fractional digits, terminated by 's'. Example: "3.5s". | -| `error` | `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). | +| `displayName` | `string` | The migration job display name. | +| `state` | `string` | The current migration job state. | +| `phase` | `string` | Output only. The current migration job phase. | +| `dumpPath` | `string` | The path to the dump file in Google Cloud Storage, in the format: (gs://[BUCKET_NAME]/[OBJECT_NAME]). This field and the "dump_flags" field are mutually exclusive. | | `labels` | `object` | The resource labels for migration job to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. | -| `cmekKeyName` | `string` | The CMEK (customer-managed encryption key) fully qualified key name used for the migration job. This field supports all migration jobs types except for: * Mysql to Mysql (use the cmek field in the cloudsql connection profile instead). * PostrgeSQL to PostgreSQL (use the cmek field in the cloudsql connection profile instead). * PostgreSQL to AlloyDB (use the kms_key_name field in the alloydb connection profile instead). Each Cloud CMEK key has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME] | -| `endTime` | `string` | Output only. If the migration job is completed, the time when it was completed. | -| `type` | `string` | Required. The migration job type. | -| `vpcPeeringConnectivity` | `object` | The details of the VPC where the source database is located in Google Cloud. We will use this information to set up the VPC peering connection between Cloud SQL and this VPC. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/migration_jobs_iam_audit_configs/index.md b/docs/google-docs/providers/google/datamigration/migration_jobs_iam_audit_configs/index.md deleted file mode 100644 index e3c663dcb2..0000000000 --- a/docs/google-docs/providers/google/datamigration/migration_jobs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: migration_jobs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - migration_jobs_iam_audit_configs - - datamigration - - 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 ---- - - - -## Overview - - - - -
Namemigration_jobs_iam_audit_configs
TypeResource
Idgoogle.datamigration.migration_jobs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_migrationJobs_getIamPolicy` | `SELECT` | `locationsId, migrationJobsId, projectsId` | diff --git a/docs/google-docs/providers/google/datamigration/migration_jobs_iam_bindings/index.md b/docs/google-docs/providers/google/datamigration/migration_jobs_iam_bindings/index.md deleted file mode 100644 index 8d2a3e1527..0000000000 --- a/docs/google-docs/providers/google/datamigration/migration_jobs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: migration_jobs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - migration_jobs_iam_bindings - - datamigration - - 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 ---- - - - -## Overview - - - - -
Namemigration_jobs_iam_bindings
TypeResource
Idgoogle.datamigration.migration_jobs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_migrationJobs_getIamPolicy` | `SELECT` | `locationsId, migrationJobsId, projectsId` | diff --git a/docs/google-docs/providers/google/datamigration/operations/index.md b/docs/google-docs/providers/google/datamigration/operations/index.md index 57a6e510de..fd9731583c 100644 --- a/docs/google-docs/providers/google/datamigration/operations/index.md +++ b/docs/google-docs/providers/google/datamigration/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/private_connections/index.md b/docs/google-docs/providers/google/datamigration/private_connections/index.md index ced9d75d5e..06834d107e 100644 --- a/docs/google-docs/providers/google/datamigration/private_connections/index.md +++ b/docs/google-docs/providers/google/datamigration/private_connections/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the resource. | +| `state` | `string` | Output only. The state of the private connection. | +| `updateTime` | `string` | Output only. The last update time of the resource. | +| `vpcPeeringConfig` | `object` | The VPC peering configuration is used to create VPC peering with the consumer's VPC. | | `createTime` | `string` | Output only. The create time of the resource. | | `displayName` | `string` | The private connection display name. | | `error` | `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). | | `labels` | `object` | The resource labels for private connections to use to annotate any related underlying resources such as Compute Engine VMs. An object containing a list of "key": "value" pairs. Example: `{ "name": "wrench", "mass": "1.3kg", "count": "3" }`. | -| `state` | `string` | Output only. The state of the private connection. | -| `updateTime` | `string` | Output only. The last update time of the resource. | -| `vpcPeeringConfig` | `object` | The VPC peering configuration is used to create VPC peering with the consumer's VPC. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md b/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md index 193d5faa8e..6ab8e63c0a 100644 --- a/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/datamigration/private_connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datapipelines/jobs/index.md b/docs/google-docs/providers/google/datapipelines/jobs/index.md index 0cdec67dd9..c65ed95ae9 100644 --- a/docs/google-docs/providers/google/datapipelines/jobs/index.md +++ b/docs/google-docs/providers/google/datapipelines/jobs/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. The internal ID for the job. | | `name` | `string` | Required. The fully qualified resource name for the job. | -| `state` | `string` | The current state of the job. | -| `status` | `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). | | `createTime` | `string` | Output only. The time of job creation. | | `dataflowJobDetails` | `object` | Pipeline job details specific to the Dataflow API. This is encapsulated here to allow for more executors to store their specific details separately. | | `endTime` | `string` | Output only. The time of job termination. This is absent if the job is still running. | +| `state` | `string` | The current state of the job. | +| `status` | `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). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/datapipelines/pipelines/index.md b/docs/google-docs/providers/google/datapipelines/pipelines/index.md index ac7f466d3c..bbf2f17c54 100644 --- a/docs/google-docs/providers/google/datapipelines/pipelines/index.md +++ b/docs/google-docs/providers/google/datapipelines/pipelines/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The pipeline name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/pipelines/PIPELINE_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), and periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects). * `LOCATION_ID` is the canonical ID for the pipeline's location. The list of available locations can be obtained by calling `google.cloud.location.Locations.ListLocations`. Note that the Data Pipelines service is not available in all regions. It depends on Cloud Scheduler, an App Engine application, so it's only available in [App Engine regions](https://cloud.google.com/about/locations#region). * `PIPELINE_ID` is the ID of the pipeline. Must be unique for the selected project and location. | | `type` | `string` | Required. The type of the pipeline. This field affects the scheduling of the pipeline and the type of metrics to show for the pipeline. | -| `displayName` | `string` | Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). | -| `createTime` | `string` | Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. | -| `scheduleInfo` | `object` | Details of the schedule the pipeline runs on. | -| `state` | `string` | Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests. | -| `schedulerServiceAccountEmail` | `string` | Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used. | | `jobCount` | `integer` | Output only. Number of jobs. | | `pipelineSources` | `object` | Immutable. The sources of the pipeline (for example, Dataplex). The keys and values are set by the corresponding sources during pipeline creation. | +| `scheduleInfo` | `object` | Details of the schedule the pipeline runs on. | | `lastUpdateTime` | `string` | Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. | +| `schedulerServiceAccountEmail` | `string` | Optional. A service account email to be used with the Cloud Scheduler job. If not specified, the default compute engine service account will be used. | | `workload` | `object` | Workload details for creating the pipeline jobs. | +| `createTime` | `string` | Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. | +| `displayName` | `string` | Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). | +| `state` | `string` | Required. The state of the pipeline. When the pipeline is created, the state is set to 'PIPELINE_STATE_ACTIVE' by default. State changes can be requested by setting the state to stopping, paused, or resuming. State cannot be changed through UpdatePipeline requests. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/actions/index.md b/docs/google-docs/providers/google/dataplex/actions/index.md index d4f4887d95..84ee02417f 100644 --- a/docs/google-docs/providers/google/dataplex/actions/index.md +++ b/docs/google-docs/providers/google/dataplex/actions/index.md @@ -28,21 +28,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the action, of the form: projects/{project}/locations/{location}/lakes/{lake}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/actions/{action} projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/assets/{asset}/actions/{action}. | -| `failedSecurityPolicyApply` | `object` | Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource. | +| `incompatibleDataSchema` | `object` | Action details for incompatible schemas detected by discovery. | +| `unauthorizedResource` | `object` | Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset. | | `lake` | `string` | Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. | | `zone` | `string` | Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. | +| `invalidDataOrganization` | `object` | Action details for invalid data arrangement. | +| `failedSecurityPolicyApply` | `object` | Failed to apply security policy to the managed resource(s) under a lake, zone or an asset. For a lake or zone resource, one or more underlying assets has a failure applying security policy to the associated managed resource. | +| `invalidDataPartition` | `object` | Action details for invalid or unsupported partitions detected by discovery. | +| `asset` | `string` | Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. | | `category` | `string` | The category of issue associated with the action. | | `detectTime` | `string` | The time that the issue was detected. | -| `incompatibleDataSchema` | `object` | Action details for incompatible schemas detected by discovery. | -| `invalidDataPartition` | `object` | Action details for invalid or unsupported partitions detected by discovery. | +| `dataLocations` | `array` | The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id). | +| `missingResource` | `object` | Action details for resource references in assets that cannot be located. | | `invalidDataFormat` | `object` | Action details for invalid or unsupported data files detected by discovery. | -| `asset` | `string` | Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. | -| `invalidDataOrganization` | `object` | Action details for invalid data arrangement. | -| `unauthorizedResource` | `object` | Action details for unauthorized resource issues raised to indicate that the service account associated with the lake instance is not authorized to access or manage the resource associated with an asset. | -| `missingData` | `object` | Action details for absence of data detected by discovery. | | `issue` | `string` | Detailed description of the issue requiring action. | -| `missingResource` | `object` | Action details for resource references in assets that cannot be located. | -| `dataLocations` | `array` | The list of data locations associated with this action. Cloud Storage locations are represented as URI paths(E.g. gs://bucket/table1/year=2020/month=Jan/). BigQuery locations refer to resource names(E.g. bigquery.googleapis.com/projects/project-id/datasets/dataset-id). | +| `missingData` | `object` | Action details for absence of data detected by discovery. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/assets/index.md b/docs/google-docs/providers/google/dataplex/assets/index.md index 51eef7f6bc..569cdc37b6 100644 --- a/docs/google-docs/providers/google/dataplex/assets/index.md +++ b/docs/google-docs/providers/google/dataplex/assets/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the asset, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/assets/{asset_id}. | | `description` | `string` | Optional. Description of the asset. | -| `uid` | `string` | Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name. | -| `createTime` | `string` | Output only. The time when the asset was created. | -| `securityStatus` | `object` | Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy. | -| `state` | `string` | Output only. Current state of the asset. | -| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing for an asset. | | `resourceSpec` | `object` | Identifies the cloud resource that is referenced by this asset. | -| `resourceStatus` | `object` | Status of the resource referenced by an asset. | +| `displayName` | `string` | Optional. User friendly display name. | +| `discoveryStatus` | `object` | Status of discovery for an asset. | | `labels` | `object` | Optional. User defined labels for the asset. | +| `state` | `string` | Output only. Current state of the asset. | +| `createTime` | `string` | Output only. The time when the asset was created. | +| `resourceStatus` | `object` | Status of the resource referenced by an asset. | +| `securityStatus` | `object` | Security policy status of the asset. Data security policy, i.e., readers, writers & owners, should be specified in the lake/zone/asset IAM policy. | | `updateTime` | `string` | Output only. The time when the asset was last updated. | -| `discoveryStatus` | `object` | Status of discovery for an asset. | -| `displayName` | `string` | Optional. User friendly display name. | +| `uid` | `string` | Output only. System generated globally unique ID for the asset. This ID will be different if the asset is deleted and re-created with the same name. | +| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing for an asset. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/assets_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/assets_iam_audit_configs/index.md deleted file mode 100644 index 1d4a7c5c8c..0000000000 --- a/docs/google-docs/providers/google/dataplex/assets_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: assets_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - assets_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nameassets_iam_audit_configs
TypeResource
Idgoogle.dataplex.assets_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_zones_assets_getIamPolicy` | `SELECT` | `assetsId, lakesId, locationsId, projectsId, zonesId` | diff --git a/docs/google-docs/providers/google/dataplex/assets_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/assets_iam_bindings/index.md deleted file mode 100644 index b5763f19b4..0000000000 --- a/docs/google-docs/providers/google/dataplex/assets_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: assets_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - assets_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nameassets_iam_bindings
TypeResource
Idgoogle.dataplex.assets_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_zones_assets_getIamPolicy` | `SELECT` | `assetsId, lakesId, locationsId, projectsId, zonesId` | diff --git a/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md index 19c992cce6..53d8bdbbc2 100644 --- a/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/assets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/attributes/index.md b/docs/google-docs/providers/google/dataplex/attributes/index.md index 8ab6c579f5..bb31d0f4cc 100644 --- a/docs/google-docs/providers/google/dataplex/attributes/index.md +++ b/docs/google-docs/providers/google/dataplex/attributes/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}. | | `description` | `string` | Optional. Description of the DataAttribute. | +| `uid` | `string` | Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name. | +| `createTime` | `string` | Output only. The time when the DataAttribute was created. | +| `labels` | `object` | Optional. User-defined labels for the DataAttribute. | | `resourceAccessSpec` | `object` | ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table. | -| `dataAccessSpec` | `object` | DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. | +| `parentId` | `string` | Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4 | | `displayName` | `string` | Optional. User friendly display name. | | `updateTime` | `string` | Output only. The time when the DataAttribute was last updated. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `labels` | `object` | Optional. User-defined labels for the DataAttribute. | -| `uid` | `string` | Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name. | -| `parentId` | `string` | Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4 | | `attributeCount` | `integer` | Output only. The number of child attributes present for this attribute. | -| `createTime` | `string` | Output only. The time when the DataAttribute was created. | +| `dataAccessSpec` | `object` | DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/attributes_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/attributes_iam_audit_configs/index.md deleted file mode 100644 index 8ccf5563b8..0000000000 --- a/docs/google-docs/providers/google/dataplex/attributes_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: attributes_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - attributes_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nameattributes_iam_audit_configs
TypeResource
Idgoogle.dataplex.attributes_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataTaxonomies_attributes_getIamPolicy` | `SELECT` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/attributes_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/attributes_iam_bindings/index.md deleted file mode 100644 index f118f871df..0000000000 --- a/docs/google-docs/providers/google/dataplex/attributes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: attributes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - attributes_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nameattributes_iam_bindings
TypeResource
Idgoogle.dataplex.attributes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataTaxonomies_attributes_getIamPolicy` | `SELECT` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md index 9362f6b88e..2b00ea8135 100644 --- a/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/attributes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/content/index.md b/docs/google-docs/providers/google/dataplex/content/index.md index af419a2f4e..60bedfbd85 100644 --- a/docs/google-docs/providers/google/dataplex/content/index.md +++ b/docs/google-docs/providers/google/dataplex/content/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} | | `description` | `string` | Optional. Description of the content. | -| `path` | `string` | Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes. | -| `updateTime` | `string` | Output only. The time when the content was last updated. | | `sqlScript` | `object` | Configuration for the Sql Script content. | +| `path` | `string` | Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes. | | `uid` | `string` | Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name. | -| `createTime` | `string` | Output only. Content creation time. | +| `notebook` | `object` | Configuration for Notebook content. | +| `updateTime` | `string` | Output only. The time when the content was last updated. | | `labels` | `object` | Optional. User defined labels for the content. | +| `createTime` | `string` | Output only. Content creation time. | | `dataText` | `string` | Required. Content data in string format. | -| `notebook` | `object` | Configuration for Notebook content. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/content_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/content_iam_audit_configs/index.md deleted file mode 100644 index 93180f6104..0000000000 --- a/docs/google-docs/providers/google/dataplex/content_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: content_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - content_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namecontent_iam_audit_configs
TypeResource
Idgoogle.dataplex.content_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_content_getIamPolicy` | `SELECT` | `contentId, lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/content_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/content_iam_bindings/index.md deleted file mode 100644 index 8af744ba38..0000000000 --- a/docs/google-docs/providers/google/dataplex/content_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: content_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - content_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namecontent_iam_bindings
TypeResource
Idgoogle.dataplex.content_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_content_getIamPolicy` | `SELECT` | `contentId, lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/contentitems/index.md b/docs/google-docs/providers/google/dataplex/contentitems/index.md index 526569c3f1..ff0734aeb4 100644 --- a/docs/google-docs/providers/google/dataplex/contentitems/index.md +++ b/docs/google-docs/providers/google/dataplex/contentitems/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} | | `description` | `string` | Optional. Description of the content. | -| `path` | `string` | Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes. | -| `dataText` | `string` | Required. Content data in string format. | -| `updateTime` | `string` | Output only. The time when the content was last updated. | | `sqlScript` | `object` | Configuration for the Sql Script content. | -| `createTime` | `string` | Output only. Content creation time. | | `labels` | `object` | Optional. User defined labels for the content. | +| `dataText` | `string` | Required. Content data in string format. | | `notebook` | `object` | Configuration for Notebook content. | +| `path` | `string` | Required. The path for the Content file, represented as directory structure. Unique within a lake. Limited to alphanumerics, hyphens, underscores, dots and slashes. | +| `createTime` | `string` | Output only. Content creation time. | +| `updateTime` | `string` | Output only. The time when the content was last updated. | | `uid` | `string` | Output only. System generated globally unique ID for the content. This ID will be different if the content is deleted and re-created with the same name. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/dataplex/contentitems_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/contentitems_iam_audit_configs/index.md deleted file mode 100644 index 58af3a55c1..0000000000 --- a/docs/google-docs/providers/google/dataplex/contentitems_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: contentitems_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - contentitems_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namecontentitems_iam_audit_configs
TypeResource
Idgoogle.dataplex.contentitems_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_contentitems_getIamPolicy` | `SELECT` | `contentitemsId, lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/contentitems_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/contentitems_iam_bindings/index.md deleted file mode 100644 index c66267b74c..0000000000 --- a/docs/google-docs/providers/google/dataplex/contentitems_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: contentitems_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - contentitems_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namecontentitems_iam_bindings
TypeResource
Idgoogle.dataplex.contentitems_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_contentitems_getIamPolicy` | `SELECT` | `contentitemsId, lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md index 7b042c0bd2..26ee6082d2 100644 --- a/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/contentitems_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md b/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md index ce708db7d9..fc58df1fc1 100644 --- a/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md +++ b/docs/google-docs/providers/google/dataplex/data_attribute_bindings/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id} | | `description` | `string` | Optional. Description of the DataAttributeBinding. | -| `labels` | `object` | Optional. User-defined labels for the DataAttributeBinding. | -| `paths` | `array` | Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings. | -| `attributes` | `array` | Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} | +| `uid` | `string` | Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name. | | `displayName` | `string` | Optional. User friendly display name. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method. | -| `createTime` | `string` | Output only. The time when the DataAttributeBinding was created. | +| `paths` | `array` | Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings. | | `resource` | `string` | Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource. | | `updateTime` | `string` | Output only. The time when the DataAttributeBinding was last updated. | -| `uid` | `string` | Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method. | +| `labels` | `object` | Optional. User-defined labels for the DataAttributeBinding. | +| `createTime` | `string` | Output only. The time when the DataAttributeBinding was created. | +| `attributes` | `array` | Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_audit_configs/index.md deleted file mode 100644 index b3fdc84abf..0000000000 --- a/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: data_attribute_bindings_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - data_attribute_bindings_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namedata_attribute_bindings_iam_audit_configs
TypeResource
Idgoogle.dataplex.data_attribute_bindings_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataAttributeBindings_getIamPolicy` | `SELECT` | `dataAttributeBindingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_bindings/index.md deleted file mode 100644 index 087c1cacf0..0000000000 --- a/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: data_attribute_bindings_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - data_attribute_bindings_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namedata_attribute_bindings_iam_bindings
TypeResource
Idgoogle.dataplex.data_attribute_bindings_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataAttributeBindings_getIamPolicy` | `SELECT` | `dataAttributeBindingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_policies/index.md index 4e64c16f2d..d6325cafbe 100644 --- a/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/data_attribute_bindings_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_scans/index.md b/docs/google-docs/providers/google/dataplex/data_scans/index.md index 908cea1d60..037da9699a 100644 --- a/docs/google-docs/providers/google/dataplex/data_scans/index.md +++ b/docs/google-docs/providers/google/dataplex/data_scans/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the scan, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. | | `description` | `string` | Optional. Description of the scan. Must be between 1-1024 characters. | -| `state` | `string` | Output only. Current state of the DataScan. | | `dataQualityResult` | `object` | The output of a DataQualityScan. | +| `updateTime` | `string` | Output only. The time when the scan was last updated. | | `executionSpec` | `object` | DataScan execution settings. | -| `dataProfileResult` | `object` | DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. | -| `uid` | `string` | Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name. | +| `createTime` | `string` | Output only. The time when the scan was created. | | `dataProfileSpec` | `object` | DataProfileScan related setting. | -| `labels` | `object` | Optional. User-defined labels for the scan. | +| `data` | `object` | The data source for DataScan. | +| `dataProfileResult` | `object` | DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. | +| `dataQualitySpec` | `object` | DataQualityScan related setting. | | `displayName` | `string` | Optional. User friendly display name. Must be between 1-256 characters. | -| `createTime` | `string` | Output only. The time when the scan was created. | +| `uid` | `string` | Output only. System generated globally unique ID for the scan. This ID will be different if the scan is deleted and re-created with the same name. | | `executionStatus` | `object` | Status of the data scan execution. | -| `data` | `object` | The data source for DataScan. | +| `state` | `string` | Output only. Current state of the DataScan. | | `type` | `string` | Output only. The type of DataScan. | -| `updateTime` | `string` | Output only. The time when the scan was last updated. | -| `dataQualitySpec` | `object` | DataQualityScan related setting. | +| `labels` | `object` | Optional. User-defined labels for the scan. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_scans_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/data_scans_iam_audit_configs/index.md deleted file mode 100644 index 409b3a028f..0000000000 --- a/docs/google-docs/providers/google/dataplex/data_scans_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: data_scans_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - data_scans_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namedata_scans_iam_audit_configs
TypeResource
Idgoogle.dataplex.data_scans_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataScans_getIamPolicy` | `SELECT` | `dataScansId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/data_scans_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/data_scans_iam_bindings/index.md deleted file mode 100644 index c72e3edcf1..0000000000 --- a/docs/google-docs/providers/google/dataplex/data_scans_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: data_scans_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - data_scans_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namedata_scans_iam_bindings
TypeResource
Idgoogle.dataplex.data_scans_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataScans_getIamPolicy` | `SELECT` | `dataScansId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md index 10610ee667..c8ba9b9f8a 100644 --- a/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/data_scans_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md b/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md index 9fa1e6212c..b0f9e06476 100644 --- a/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md +++ b/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}. | | `description` | `string` | Optional. Description of the DataTaxonomy. | +| `attributeCount` | `integer` | Output only. The number of attributes in the DataTaxonomy. | +| `labels` | `object` | Optional. User-defined labels for the DataTaxonomy. | | `classCount` | `integer` | Output only. The number of classes in the DataTaxonomy. | +| `uid` | `string` | Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name. | +| `displayName` | `string` | Optional. User friendly display name. | +| `createTime` | `string` | Output only. The time when the DataTaxonomy was created. | | `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | | `updateTime` | `string` | Output only. The time when the DataTaxonomy was last updated. | -| `createTime` | `string` | Output only. The time when the DataTaxonomy was created. | -| `labels` | `object` | Optional. User-defined labels for the DataTaxonomy. | -| `attributeCount` | `integer` | Output only. The number of attributes in the DataTaxonomy. | -| `displayName` | `string` | Optional. User friendly display name. | -| `uid` | `string` | Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_audit_configs/index.md deleted file mode 100644 index 4349ee01f0..0000000000 --- a/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: data_taxonomies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - data_taxonomies_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namedata_taxonomies_iam_audit_configs
TypeResource
Idgoogle.dataplex.data_taxonomies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataTaxonomies_getIamPolicy` | `SELECT` | `dataTaxonomiesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_bindings/index.md deleted file mode 100644 index c390ebda9a..0000000000 --- a/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: data_taxonomies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - data_taxonomies_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namedata_taxonomies_iam_bindings
TypeResource
Idgoogle.dataplex.data_taxonomies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_dataTaxonomies_getIamPolicy` | `SELECT` | `dataTaxonomiesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_policies/index.md index ee783f0c9a..8cabb2021d 100644 --- a/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/data_taxonomies_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/entities/index.md b/docs/google-docs/providers/google/dataplex/entities/index.md index d02387c009..77b2a3443a 100644 --- a/docs/google-docs/providers/google/dataplex/entities/index.md +++ b/docs/google-docs/providers/google/dataplex/entities/index.md @@ -30,21 +30,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Required. A user-provided entity ID. It is mutable, and will be used as the published table name. Specifying a new ID in an update entity request will override the existing value. The ID must contain only letters (a-z, A-Z), numbers (0-9), and underscores, and consist of 256 or fewer characters. | | `name` | `string` | Output only. The resource name of the entity, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{id}. | | `description` | `string` | Optional. User friendly longer description text. Must be shorter than or equal to 1024 characters. | -| `createTime` | `string` | Output only. The time when the entity was created. | -| `schema` | `object` | Schema information describing the structure and layout of the data. | +| `asset` | `string` | Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. | +| `access` | `object` | Describes the access mechanism of the data within its storage location. | +| `updateTime` | `string` | Output only. The time when the entity was last updated. | +| `system` | `string` | Required. Immutable. Identifies the storage system of the entity data. | | `type` | `string` | Required. Immutable. The type of entity. | -| `catalogEntry` | `string` | Output only. The name of the associated Data Catalog entry. | | `dataPathPattern` | `string` | Optional. The set of items within the data path constituting the data in the entity, represented as a glob path. Example: gs://bucket/path/to/data/**/*.csv. | -| `compatibility` | `object` | Provides compatibility information for various metadata stores. | -| `access` | `object` | Describes the access mechanism of the data within its storage location. | +| `createTime` | `string` | Output only. The time when the entity was created. | | `format` | `object` | Describes the format of the data within its storage location. | -| `asset` | `string` | Required. Immutable. The ID of the asset associated with the storage location containing the entity data. The entity must be with in the same zone with the asset. | -| `dataPath` | `string` | Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id. | -| `system` | `string` | Required. Immutable. Identifies the storage system of the entity data. | | `uid` | `string` | Output only. System generated unique ID for the Entity. This ID will be different if the Entity is deleted and re-created with the same name. | -| `displayName` | `string` | Optional. Display name must be shorter than or equal to 256 characters. | +| `schema` | `object` | Schema information describing the structure and layout of the data. | +| `dataPath` | `string` | Required. Immutable. The storage path of the entity data. For Cloud Storage data, this is the fully-qualified path to the entity, such as gs://bucket/path/to/data. For BigQuery data, this is the name of the table resource, such as projects/project_id/datasets/dataset_id/tables/table_id. | | `etag` | `string` | Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests. | -| `updateTime` | `string` | Output only. The time when the entity was last updated. | +| `catalogEntry` | `string` | Output only. The name of the associated Data Catalog entry. | +| `compatibility` | `object` | Provides compatibility information for various metadata stores. | +| `displayName` | `string` | Optional. Display name must be shorter than or equal to 256 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md index 945ff5d115..4d969e7b38 100644 --- a/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/entry_groups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md index df6eda792a..2b10107a16 100644 --- a/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/entry_types_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/environments/index.md b/docs/google-docs/providers/google/dataplex/environments/index.md index a3edcccb9f..72fce10c09 100644 --- a/docs/google-docs/providers/google/dataplex/environments/index.md +++ b/docs/google-docs/providers/google/dataplex/environments/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the environment, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id} | | `description` | `string` | Optional. Description of the environment. | +| `createTime` | `string` | Output only. Environment creation time. | | `endpoints` | `object` | URI Endpoints to access sessions associated with the Environment. | -| `state` | `string` | Output only. Current state of the environment. | +| `labels` | `object` | Optional. User defined labels for the environment. | +| `sessionStatus` | `object` | Status of sessions created for this environment. | | `uid` | `string` | Output only. System generated globally unique ID for the environment. This ID will be different if the environment is deleted and re-created with the same name. | | `updateTime` | `string` | Output only. The time when the environment was last updated. | -| `sessionSpec` | `object` | Configuration for sessions created for this environment. | -| `labels` | `object` | Optional. User defined labels for the environment. | -| `createTime` | `string` | Output only. Environment creation time. | | `infrastructureSpec` | `object` | Configuration for the underlying infrastructure used to run workloads. | -| `sessionStatus` | `object` | Status of sessions created for this environment. | +| `state` | `string` | Output only. Current state of the environment. | +| `sessionSpec` | `object` | Configuration for sessions created for this environment. | | `displayName` | `string` | Optional. User friendly display name. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/dataplex/environments_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/environments_iam_audit_configs/index.md deleted file mode 100644 index a53a7c0b14..0000000000 --- a/docs/google-docs/providers/google/dataplex/environments_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: environments_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - environments_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nameenvironments_iam_audit_configs
TypeResource
Idgoogle.dataplex.environments_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_environments_getIamPolicy` | `SELECT` | `environmentsId, lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/environments_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/environments_iam_bindings/index.md deleted file mode 100644 index b963648e67..0000000000 --- a/docs/google-docs/providers/google/dataplex/environments_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: environments_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - environments_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nameenvironments_iam_bindings
TypeResource
Idgoogle.dataplex.environments_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_environments_getIamPolicy` | `SELECT` | `environmentsId, lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/jobs/index.md b/docs/google-docs/providers/google/dataplex/jobs/index.md index 11082dcb76..76c218ed4a 100644 --- a/docs/google-docs/providers/google/dataplex/jobs/index.md +++ b/docs/google-docs/providers/google/dataplex/jobs/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the DataScanJob, of the form: projects/{project}/locations/{location_id}/dataScans/{datascan_id}/jobs/{job_id}, where project refers to a project_id or project_number and location_id refers to a GCP region. | -| `dataQualityResult` | `object` | The output of a DataQualityScan. | -| `message` | `string` | Output only. Additional information about the current state. | -| `dataProfileSpec` | `object` | DataProfileScan related setting. | | `startTime` | `string` | Output only. The time when the DataScanJob was started. | -| `state` | `string` | Output only. Execution state for the DataScanJob. | | `dataProfileResult` | `object` | DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. | -| `type` | `string` | Output only. The type of the parent DataScan. | -| `dataQualitySpec` | `object` | DataQualityScan related setting. | | `endTime` | `string` | Output only. The time when the DataScanJob ended. | +| `type` | `string` | Output only. The type of the parent DataScan. | | `uid` | `string` | Output only. System generated globally unique ID for the DataScanJob. | +| `dataProfileSpec` | `object` | DataProfileScan related setting. | +| `dataQualitySpec` | `object` | DataQualityScan related setting. | +| `dataQualityResult` | `object` | The output of a DataQualityScan. | +| `state` | `string` | Output only. Execution state for the DataScanJob. | +| `message` | `string` | Output only. Additional information about the current state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/lakes/index.md b/docs/google-docs/providers/google/dataplex/lakes/index.md index 20dce3693a..268c432c8d 100644 --- a/docs/google-docs/providers/google/dataplex/lakes/index.md +++ b/docs/google-docs/providers/google/dataplex/lakes/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. | | `description` | `string` | Optional. Description of the lake. | -| `createTime` | `string` | Output only. The time when the lake was created. | -| `uid` | `string` | Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name. | -| `labels` | `object` | Optional. User-defined labels for the lake. | -| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | -| `serviceAccount` | `string` | Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake. | +| `displayName` | `string` | Optional. User friendly display name. | +| `metastoreStatus` | `object` | Status of Lake and Dataproc Metastore service instance association. | | `state` | `string` | Output only. Current state of the lake. | | `updateTime` | `string` | Output only. The time when the lake was last updated. | -| `displayName` | `string` | Optional. User friendly display name. | +| `serviceAccount` | `string` | Output only. Service account associated with this lake. This service account must be authorized to access or operate on resources managed by the lake. | +| `createTime` | `string` | Output only. The time when the lake was created. | +| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | +| `labels` | `object` | Optional. User-defined labels for the lake. | | `metastore` | `object` | Settings to manage association of Dataproc Metastore with a lake. | -| `metastoreStatus` | `object` | Status of Lake and Dataproc Metastore service instance association. | +| `uid` | `string` | Output only. System generated globally unique ID for the lake. This ID will be different if the lake is deleted and re-created with the same name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/lakes_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/lakes_iam_audit_configs/index.md deleted file mode 100644 index e086709fd4..0000000000 --- a/docs/google-docs/providers/google/dataplex/lakes_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: lakes_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - lakes_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namelakes_iam_audit_configs
TypeResource
Idgoogle.dataplex.lakes_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_getIamPolicy` | `SELECT` | `lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/lakes_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/lakes_iam_bindings/index.md deleted file mode 100644 index 3b23efd48e..0000000000 --- a/docs/google-docs/providers/google/dataplex/lakes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: lakes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - lakes_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namelakes_iam_bindings
TypeResource
Idgoogle.dataplex.lakes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_getIamPolicy` | `SELECT` | `lakesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md index 6e69884aa8..0f7f39cd1f 100644 --- a/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/lakes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/locations/index.md b/docs/google-docs/providers/google/dataplex/locations/index.md index 148bb7336a..310b2d59ac 100644 --- a/docs/google-docs/providers/google/dataplex/locations/index.md +++ b/docs/google-docs/providers/google/dataplex/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: "us-east1". | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/operations/index.md b/docs/google-docs/providers/google/dataplex/operations/index.md index 1992d5d053..8148ac5f35 100644 --- a/docs/google-docs/providers/google/dataplex/operations/index.md +++ b/docs/google-docs/providers/google/dataplex/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/tasks/index.md b/docs/google-docs/providers/google/dataplex/tasks/index.md index 087d4174d9..5b7a30c8ce 100644 --- a/docs/google-docs/providers/google/dataplex/tasks/index.md +++ b/docs/google-docs/providers/google/dataplex/tasks/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the task, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/ tasks/{task_id}. | | `description` | `string` | Optional. Description of the task. | -| `executionSpec` | `object` | Execution related settings, like retry and service_account. | -| `executionStatus` | `object` | Status of the task execution (e.g. Jobs). | -| `notebook` | `object` | Config for running scheduled notebooks. | -| `spark` | `object` | User-specified config for running a Spark task. | +| `labels` | `object` | Optional. User-defined labels for the task. | +| `uid` | `string` | Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name. | | `updateTime` | `string` | Output only. The time when the task was last updated. | -| `triggerSpec` | `object` | Task scheduling and trigger settings. | +| `createTime` | `string` | Output only. The time when the task was created. | +| `notebook` | `object` | Config for running scheduled notebooks. | | `displayName` | `string` | Optional. User friendly display name. | | `state` | `string` | Output only. Current state of the task. | -| `uid` | `string` | Output only. System generated globally unique ID for the task. This ID will be different if the task is deleted and re-created with the same name. | -| `createTime` | `string` | Output only. The time when the task was created. | -| `labels` | `object` | Optional. User-defined labels for the task. | +| `spark` | `object` | User-specified config for running a Spark task. | +| `executionStatus` | `object` | Status of the task execution (e.g. Jobs). | +| `triggerSpec` | `object` | Task scheduling and trigger settings. | +| `executionSpec` | `object` | Execution related settings, like retry and service_account. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/tasks_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/tasks_iam_audit_configs/index.md deleted file mode 100644 index da378addba..0000000000 --- a/docs/google-docs/providers/google/dataplex/tasks_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: tasks_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - tasks_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nametasks_iam_audit_configs
TypeResource
Idgoogle.dataplex.tasks_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_tasks_getIamPolicy` | `SELECT` | `lakesId, locationsId, projectsId, tasksId` | diff --git a/docs/google-docs/providers/google/dataplex/tasks_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/tasks_iam_bindings/index.md deleted file mode 100644 index 50d92b98b1..0000000000 --- a/docs/google-docs/providers/google/dataplex/tasks_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: tasks_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - tasks_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Nametasks_iam_bindings
TypeResource
Idgoogle.dataplex.tasks_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_tasks_getIamPolicy` | `SELECT` | `lakesId, locationsId, projectsId, tasksId` | diff --git a/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md index beea288259..08e5df3233 100644 --- a/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/tasks_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | -| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | | `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | +| `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/zones/index.md b/docs/google-docs/providers/google/dataplex/zones/index.md index ed806a6fb6..a676cee2ba 100644 --- a/docs/google-docs/providers/google/dataplex/zones/index.md +++ b/docs/google-docs/providers/google/dataplex/zones/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the zone, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}. | | `description` | `string` | Optional. Description of the zone. | -| `createTime` | `string` | Output only. The time when the zone was created. | -| `uid` | `string` | Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name. | -| `updateTime` | `string` | Output only. The time when the zone was last updated. | -| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | | `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing in a zone. | | `displayName` | `string` | Optional. User friendly display name. | | `labels` | `object` | Optional. User defined labels for the zone. | | `type` | `string` | Required. Immutable. The type of the zone. | +| `uid` | `string` | Output only. System generated globally unique ID for the zone. This ID will be different if the zone is deleted and re-created with the same name. | +| `createTime` | `string` | Output only. The time when the zone was created. | +| `updateTime` | `string` | Output only. The time when the zone was last updated. | +| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | | `resourceSpec` | `object` | Settings for resources attached as assets within a zone. | | `state` | `string` | Output only. Current state of the zone. | ## Methods diff --git a/docs/google-docs/providers/google/dataplex/zones_iam_audit_configs/index.md b/docs/google-docs/providers/google/dataplex/zones_iam_audit_configs/index.md deleted file mode 100644 index c04d6dd0b1..0000000000 --- a/docs/google-docs/providers/google/dataplex/zones_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: zones_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - zones_iam_audit_configs - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namezones_iam_audit_configs
TypeResource
Idgoogle.dataplex.zones_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_zones_getIamPolicy` | `SELECT` | `lakesId, locationsId, projectsId, zonesId` | diff --git a/docs/google-docs/providers/google/dataplex/zones_iam_bindings/index.md b/docs/google-docs/providers/google/dataplex/zones_iam_bindings/index.md deleted file mode 100644 index 5200af4427..0000000000 --- a/docs/google-docs/providers/google/dataplex/zones_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: zones_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - zones_iam_bindings - - dataplex - - 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 ---- - - - -## Overview - - - - -
Namezones_iam_bindings
TypeResource
Idgoogle.dataplex.zones_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_lakes_zones_getIamPolicy` | `SELECT` | `lakesId, locationsId, projectsId, zonesId` | diff --git a/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md index 34dcb66ccb..dd9291966e 100644 --- a/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/zones_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md b/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md index 074bdb5d27..825799fdde 100644 --- a/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Required. The policy id.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters. | | `name` | `string` | Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id} | -| `workerConfig` | `object` | Configuration for the size bounds of an instance group, including its proportional size to other groups. | | `basicAlgorithm` | `object` | Basic algorithm for autoscaling. | | `labels` | `object` | Optional. The labels to associate with this autoscaling policy. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with an autoscaling policy. | | `secondaryWorkerConfig` | `object` | Configuration for the size bounds of an instance group, including its proportional size to other groups. | +| `workerConfig` | `object` | Configuration for the size bounds of an instance group, including its proportional size to other groups. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_bindings/index.md b/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_bindings/index.md deleted file mode 100644 index ff25c1f017..0000000000 --- a/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: autoscaling_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - autoscaling_policies_iam_bindings - - dataproc - - 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 ---- - - - -## Overview - - - - -
Nameautoscaling_policies_iam_bindings
TypeResource
Idgoogle.dataproc.autoscaling_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_autoscalingPolicies_getIamPolicy` | `SELECT` | `autoscalingPoliciesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md index ecc8e76393..cfb8879a00 100644 --- a/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/autoscaling_policies_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/batches/index.md b/docs/google-docs/providers/google/dataproc/batches/index.md index 029dde740a..f7495610b5 100644 --- a/docs/google-docs/providers/google/dataproc/batches/index.md +++ b/docs/google-docs/providers/google/dataproc/batches/index.md @@ -28,22 +28,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the batch. | -| `uuid` | `string` | Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch. | -| `operation` | `string` | Output only. The resource name of the operation associated with this batch. | +| `stateMessage` | `string` | Output only. Batch state details, such as a failure description if the state is FAILED. | | `sparkSqlBatch` | `object` | A configuration for running Apache Spark SQL (https://spark.apache.org/sql/) queries as a batch workload. | -| `state` | `string` | Output only. The state of the batch. | -| `sparkBatch` | `object` | A configuration for running an Apache Spark (https://spark.apache.org/) batch workload. | -| `pysparkBatch` | `object` | A configuration for running an Apache PySpark (https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html) batch workload. | +| `createTime` | `string` | Output only. The time when the batch was created. | | `runtimeInfo` | `object` | Runtime information about workload execution. | +| `uuid` | `string` | Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch. | +| `sparkRBatch` | `object` | A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload. | | `runtimeConfig` | `object` | Runtime configuration for a workload. | -| `environmentConfig` | `object` | Environment configuration for a workload. | -| `stateHistory` | `array` | Output only. Historical state information for the batch. | -| `createTime` | `string` | Output only. The time when the batch was created. | +| `stateTime` | `string` | Output only. The time when the batch entered a current state. | | `labels` | `object` | Optional. The labels to associate with this batch. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a batch. | +| `stateHistory` | `array` | Output only. Historical state information for the batch. | | `creator` | `string` | Output only. The email address of the user who created the batch. | -| `stateTime` | `string` | Output only. The time when the batch entered a current state. | -| `stateMessage` | `string` | Output only. Batch state details, such as a failure description if the state is FAILED. | -| `sparkRBatch` | `object` | A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload. | +| `environmentConfig` | `object` | Environment configuration for a workload. | +| `sparkBatch` | `object` | A configuration for running an Apache Spark (https://spark.apache.org/) batch workload. | +| `pysparkBatch` | `object` | A configuration for running an Apache PySpark (https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html) batch workload. | +| `operation` | `string` | Output only. The resource name of the operation associated with this batch. | +| `state` | `string` | Output only. The state of the batch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/clusters/index.md b/docs/google-docs/providers/google/dataproc/clusters/index.md index e23133c654..80f12352ad 100644 --- a/docs/google-docs/providers/google/dataproc/clusters/index.md +++ b/docs/google-docs/providers/google/dataproc/clusters/index.md @@ -27,14 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `projectId` | `string` | Required. The Google Cloud Platform project ID that the cluster belongs to. | +| `metrics` | `object` | Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. | +| `virtualClusterConfig` | `object` | The Dataproc cluster config for a cluster that does not directly control the underlying compute resources, such as a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). | | `clusterName` | `string` | Required. The cluster name, which must be unique within a project. The name must start with a lowercase letter, and can contain up to 51 lowercase letters, numbers, and hyphens. It cannot end with a hyphen. The name of a deleted cluster can be reused. | | `clusterUuid` | `string` | Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. | | `status` | `object` | The status of a cluster and its instances. | -| `config` | `object` | The cluster config. | -| `projectId` | `string` | Required. The Google Cloud Platform project ID that the cluster belongs to. | -| `virtualClusterConfig` | `object` | The Dataproc cluster config for a cluster that does not directly control the underlying compute resources, such as a Dataproc-on-GKE cluster (https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview). | -| `metrics` | `object` | Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. | | `labels` | `object` | Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster. | +| `config` | `object` | The cluster config. | | `statusHistory` | `array` | Output only. The previous cluster status. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/dataproc/clusters_iam_bindings/index.md b/docs/google-docs/providers/google/dataproc/clusters_iam_bindings/index.md deleted file mode 100644 index 7169aa2257..0000000000 --- a/docs/google-docs/providers/google/dataproc/clusters_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: clusters_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - clusters_iam_bindings - - dataproc - - 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 ---- - - - -## Overview - - - - -
Nameclusters_iam_bindings
TypeResource
Idgoogle.dataproc.clusters_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_regions_clusters_getIamPolicy` | `SELECT` | `clustersId, projectsId, regionsId` | diff --git a/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md index 3fd5f7aebb..f5edbebe09 100644 --- a/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/clusters_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/jobs/index.md b/docs/google-docs/providers/google/dataproc/jobs/index.md index 98cfe2f5c0..8a56a91ec0 100644 --- a/docs/google-docs/providers/google/dataproc/jobs/index.md +++ b/docs/google-docs/providers/google/dataproc/jobs/index.md @@ -27,28 +27,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `driverOutputResourceUri` | `string` | Output only. A URI pointing to the location of the stdout of the job's driver program. | -| `sparkSqlJob` | `object` | A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries. | -| `driverControlFilesUri` | `string` | Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. | +| `trinoJob` | `object` | A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster. | +| `yarnApplications` | `array` | Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release. | | `flinkJob` | `object` | A Dataproc job for running Apache Flink (https://flink.apache.org/) applications on YARN. | | `jobUuid` | `string` | Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time. | -| `driverSchedulingConfig` | `object` | Driver scheduling configuration. | -| `hiveJob` | `object` | A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. | +| `statusHistory` | `array` | Output only. The previous job status. | +| `driverControlFilesUri` | `string` | Output only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri. | +| `driverOutputResourceUri` | `string` | Output only. A URI pointing to the location of the stdout of the job's driver program. | +| `reference` | `object` | Encapsulates the full scoping used to reference a job. | | `prestoJob` | `object` | A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. | -| `hadoopJob` | `object` | A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). | | `pigJob` | `object` | A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. | +| `sparkRJob` | `object` | A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. | +| `sparkSqlJob` | `object` | A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries. | | `done` | `boolean` | Output only. Indicates whether the job is completed. If the value is false, the job is still in progress. If true, the job is completed, and status.state field will indicate if it was successful, failed, or cancelled. | -| `yarnApplications` | `array` | Output only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release. | -| `scheduling` | `object` | Job scheduling options. | -| `statusHistory` | `array` | Output only. The previous job status. | -| `reference` | `object` | Encapsulates the full scoping used to reference a job. | +| `sparkJob` | `object` | A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN. | | `status` | `object` | Dataproc job status. | -| `trinoJob` | `object` | A Dataproc job for running Trino (https://trino.io/) queries. IMPORTANT: The Dataproc Trino Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/trino) must be enabled when the cluster is created to submit a Trino job to the cluster. | -| `pysparkJob` | `object` | A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. | -| `sparkRJob` | `object` | A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. | -| `placement` | `object` | Dataproc job config. | | `labels` | `object` | Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job. | -| `sparkJob` | `object` | A Dataproc job for running Apache Spark (https://spark.apache.org/) applications on YARN. | +| `placement` | `object` | Dataproc job config. | +| `hadoopJob` | `object` | A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). | +| `hiveJob` | `object` | A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. | +| `scheduling` | `object` | Job scheduling options. | +| `driverSchedulingConfig` | `object` | Driver scheduling configuration. | +| `pysparkJob` | `object` | A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/jobs_iam_bindings/index.md b/docs/google-docs/providers/google/dataproc/jobs_iam_bindings/index.md deleted file mode 100644 index 060c556f93..0000000000 --- a/docs/google-docs/providers/google/dataproc/jobs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: jobs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_bindings - - dataproc - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_bindings
TypeResource
Idgoogle.dataproc.jobs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_regions_jobs_getIamPolicy` | `SELECT` | `jobsId, projectsId, regionsId` | diff --git a/docs/google-docs/providers/google/dataproc/operations/index.md b/docs/google-docs/providers/google/dataproc/operations/index.md index 12d1712575..c4e82e450a 100644 --- a/docs/google-docs/providers/google/dataproc/operations/index.md +++ b/docs/google-docs/providers/google/dataproc/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}. | -| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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. | | `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataproc/operations_iam_bindings/index.md b/docs/google-docs/providers/google/dataproc/operations_iam_bindings/index.md deleted file mode 100644 index d7e4b849ce..0000000000 --- a/docs/google-docs/providers/google/dataproc/operations_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: operations_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - operations_iam_bindings - - dataproc - - 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 ---- - - - -## Overview - - - - -
Nameoperations_iam_bindings
TypeResource
Idgoogle.dataproc.operations_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_regions_operations_getIamPolicy` | `SELECT` | `operationsId, projectsId, regionsId` | diff --git a/docs/google-docs/providers/google/dataproc/workflow_templates/index.md b/docs/google-docs/providers/google/dataproc/workflow_templates/index.md index 108b182428..6278c6c815 100644 --- a/docs/google-docs/providers/google/dataproc/workflow_templates/index.md +++ b/docs/google-docs/providers/google/dataproc/workflow_templates/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | | | `name` | `string` | Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} | +| `labels` | `object` | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. | +| `parameters` | `array` | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. | | `createTime` | `string` | Output only. The time template was created. | +| `version` | `integer` | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. | | `dagTimeout` | `string` | Optional. Timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration (https://developers.google.com/protocol-buffers/docs/proto3#json)). The timeout duration must be from 10 minutes ("600s") to 24 hours ("86400s"). The timer begins when the first job is submitted. If the workflow is running at the end of the timeout period, any remaining jobs are cancelled, the workflow is ended, and if the workflow was running on a managed cluster, the cluster is deleted. | -| `jobs` | `array` | Required. The Directed Acyclic Graph of Jobs to submit. | -| `parameters` | `array` | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. | | `updateTime` | `string` | Output only. The time template was last updated. | -| `labels` | `object` | Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template. | -| `version` | `integer` | Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request. | +| `jobs` | `array` | Required. The Directed Acyclic Graph of Jobs to submit. | | `placement` | `object` | Specifies workflow execution target.Either managed_cluster or cluster_selector is required. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/dataproc/workflow_templates_iam_bindings/index.md b/docs/google-docs/providers/google/dataproc/workflow_templates_iam_bindings/index.md deleted file mode 100644 index 76e91760e3..0000000000 --- a/docs/google-docs/providers/google/dataproc/workflow_templates_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: workflow_templates_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - workflow_templates_iam_bindings - - dataproc - - 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 ---- - - - -## Overview - - - - -
Nameworkflow_templates_iam_bindings
TypeResource
Idgoogle.dataproc.workflow_templates_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_workflowTemplates_getIamPolicy` | `SELECT` | `locationsId, projectsId, workflowTemplatesId` | diff --git a/docs/google-docs/providers/google/datastore/indexes/index.md b/docs/google-docs/providers/google/datastore/indexes/index.md index b09aea9c0b..018658137c 100644 --- a/docs/google-docs/providers/google/datastore/indexes/index.md +++ b/docs/google-docs/providers/google/datastore/indexes/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `projectId` | `string` | Output only. Project ID. | +| `properties` | `array` | Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties. | | `state` | `string` | Output only. The state of the index. | | `ancestor` | `string` | Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. | | `indexId` | `string` | Output only. The resource ID of the index. | | `kind` | `string` | Required. The entity kind to which this index applies. | -| `projectId` | `string` | Output only. Project ID. | -| `properties` | `array` | Required. An ordered sequence of property names and their index attributes. Requires: * A maximum of 100 properties. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastore/operations/index.md b/docs/google-docs/providers/google/datastore/operations/index.md index 9ee80efc20..8c30e6874c 100644 --- a/docs/google-docs/providers/google/datastore/operations/index.md +++ b/docs/google-docs/providers/google/datastore/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | | `response` | `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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastream/connection_profiles/index.md b/docs/google-docs/providers/google/datastream/connection_profiles/index.md index 0d047fdcf5..075b48c524 100644 --- a/docs/google-docs/providers/google/datastream/connection_profiles/index.md +++ b/docs/google-docs/providers/google/datastream/connection_profiles/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource's name. | -| `oracleProfile` | `object` | Oracle database profile. | -| `mysqlProfile` | `object` | MySQL database profile. | -| `postgresqlProfile` | `object` | PostgreSQL database profile. | -| `staticServiceIpConnectivity` | `object` | Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. | -| `createTime` | `string` | Output only. The create time of the resource. | -| `privateConnectivity` | `object` | Private Connectivity | -| `updateTime` | `string` | Output only. The update time of the resource. | +| `gcsProfile` | `object` | Cloud Storage bucket profile. | | `labels` | `object` | Labels. | +| `oracleProfile` | `object` | Oracle database profile. | | `displayName` | `string` | Required. Display name. | +| `createTime` | `string` | Output only. The create time of the resource. | | `forwardSshConnectivity` | `object` | Forward SSH Tunnel connectivity. | +| `updateTime` | `string` | Output only. The update time of the resource. | +| `postgresqlProfile` | `object` | PostgreSQL database profile. | +| `mysqlProfile` | `object` | MySQL database profile. | +| `staticServiceIpConnectivity` | `object` | Static IP address connectivity. Used when the source database is configured to allow incoming connections from the Datastream public IP addresses for the region specified in the connection profile. | | `bigqueryProfile` | `object` | BigQuery warehouse profile. | -| `gcsProfile` | `object` | Cloud Storage bucket profile. | +| `privateConnectivity` | `object` | Private Connectivity | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastream/locations_static_ips/index.md b/docs/google-docs/providers/google/datastream/locations_static_ips/index.md deleted file mode 100644 index 04e9e177be..0000000000 --- a/docs/google-docs/providers/google/datastream/locations_static_ips/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: locations_static_ips -hide_title: false -hide_table_of_contents: false -keywords: - - locations_static_ips - - datastream - - 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 ---- - - - -## Overview - - - - -
Namelocations_static_ips
TypeResource
Idgoogle.datastream.locations_static_ips
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -| `staticIps` | `array` | list of static ips by account | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_fetchStaticIps` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/datastream/objects/index.md b/docs/google-docs/providers/google/datastream/objects/index.md index 11794b5ad1..59c8af19f9 100644 --- a/docs/google-docs/providers/google/datastream/objects/index.md +++ b/docs/google-docs/providers/google/datastream/objects/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The object resource's name. | -| `backfillJob` | `object` | Represents a backfill job on a specific stream object. | -| `createTime` | `string` | Output only. The creation time of the object. | | `displayName` | `string` | Required. Display name. | | `errors` | `array` | Output only. Active errors on the object. | | `sourceObject` | `object` | Represents an identifier of an object in the data source. | | `updateTime` | `string` | Output only. The last update time of the object. | +| `backfillJob` | `object` | Represents a backfill job on a specific stream object. | +| `createTime` | `string` | Output only. The creation time of the object. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastream/operations/index.md b/docs/google-docs/providers/google/datastream/operations/index.md index a8df4c5a5b..3bb5fcd9e3 100644 --- a/docs/google-docs/providers/google/datastream/operations/index.md +++ b/docs/google-docs/providers/google/datastream/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastream/private_connections/index.md b/docs/google-docs/providers/google/datastream/private_connections/index.md index ec8402ad9e..14ff3a0c47 100644 --- a/docs/google-docs/providers/google/datastream/private_connections/index.md +++ b/docs/google-docs/providers/google/datastream/private_connections/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource's name. | +| `createTime` | `string` | Output only. The create time of the resource. | +| `displayName` | `string` | Required. Display name. | +| `error` | `object` | Represent a user-facing Error. | | `labels` | `object` | Labels. | | `state` | `string` | Output only. The state of the Private Connection. | | `updateTime` | `string` | Output only. The update time of the resource. | | `vpcPeeringConfig` | `object` | The VPC Peering configuration is used to create VPC peering between Datastream and the consumer's VPC. | -| `createTime` | `string` | Output only. The create time of the resource. | -| `displayName` | `string` | Required. Display name. | -| `error` | `object` | Represent a user-facing Error. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastream/routes/index.md b/docs/google-docs/providers/google/datastream/routes/index.md index db3c000933..7ba71b5979 100644 --- a/docs/google-docs/providers/google/datastream/routes/index.md +++ b/docs/google-docs/providers/google/datastream/routes/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource's name. | +| `labels` | `object` | Labels. | | `updateTime` | `string` | Output only. The update time of the resource. | | `createTime` | `string` | Output only. The create time of the resource. | | `destinationAddress` | `string` | Required. Destination address for connection | | `destinationPort` | `integer` | Destination port for connection | | `displayName` | `string` | Required. Display name. | -| `labels` | `object` | Labels. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastream/streams/index.md b/docs/google-docs/providers/google/datastream/streams/index.md index e2c4ed04da..01c3f6b215 100644 --- a/docs/google-docs/providers/google/datastream/streams/index.md +++ b/docs/google-docs/providers/google/datastream/streams/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The stream's name. | -| `backfillNone` | `object` | Backfill strategy to disable automatic backfill for the Stream's objects. | -| `customerManagedEncryptionKey` | `string` | Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. | -| `destinationConfig` | `object` | The configuration of the stream destination. | | `errors` | `array` | Output only. Errors on the Stream. | -| `backfillAll` | `object` | Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. | | `displayName` | `string` | Required. Display name. | +| `customerManagedEncryptionKey` | `string` | Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS. | | `createTime` | `string` | Output only. The creation time of the stream. | +| `backfillAll` | `object` | Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. | +| `backfillNone` | `object` | Backfill strategy to disable automatic backfill for the Stream's objects. | | `labels` | `object` | Labels. | -| `updateTime` | `string` | Output only. The last update time of the stream. | | `state` | `string` | The state of the stream. | +| `updateTime` | `string` | Output only. The last update time of the stream. | +| `destinationConfig` | `object` | The configuration of the stream destination. | | `sourceConfig` | `object` | The configuration of the stream source. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/deploymentmanager/deployments/index.md b/docs/google-docs/providers/google/deploymentmanager/deployments/index.md index d580614024..d639aa3056 100644 --- a/docs/google-docs/providers/google/deploymentmanager/deployments/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/deployments/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | | | `name` | `string` | Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. | | `description` | `string` | An optional user-provided description of the deployment. | -| `update` | `object` | | | `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | -| `labels` | `array` | Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. | -| `operation` | `object` | Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. | +| `selfLink` | `string` | Output only. Server defined URL for the resource. | +| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | | `target` | `object` | | | `manifest` | `string` | Output only. URL of the manifest representing the last manifest that was successfully deployed. If no manifest has been successfully deployed, this field will be absent. | +| `operation` | `object` | Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. | +| `update` | `object` | | | `fingerprint` | `string` | Provides a fingerprint to use in requests to modify a deployment, such as `update()`, `stop()`, and `cancelPreview()` requests. A fingerprint is a randomly generated value that must be provided with `update()`, `stop()`, and `cancelPreview()` requests to perform optimistic locking. This ensures optimistic concurrency so that only one request happens at a time. The fingerprint is initially generated by Deployment Manager and changes after every request to modify data. To get the latest fingerprint value, perform a `get()` request to a deployment. | -| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | -| `selfLink` | `string` | Output only. Server defined URL for the resource. | +| `labels` | `array` | Map of One Platform labels; provided by the client when the resource is created or updated. Specifically: Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?` Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_audit_configs/index.md b/docs/google-docs/providers/google/deploymentmanager/deployments_iam_audit_configs/index.md deleted file mode 100644 index bc651bdb7c..0000000000 --- a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: deployments_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - deployments_iam_audit_configs - - deploymentmanager - - 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 ---- - - - -## Overview - - - - -
Namedeployments_iam_audit_configs
TypeResource
Idgoogle.deploymentmanager.deployments_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `deployments_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_bindings/index.md b/docs/google-docs/providers/google/deploymentmanager/deployments_iam_bindings/index.md deleted file mode 100644 index 6d253cd9ff..0000000000 --- a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: deployments_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - deployments_iam_bindings - - deploymentmanager - - 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 ---- - - - -## Overview - - - - -
Namedeployments_iam_bindings
TypeResource
Idgoogle.deploymentmanager.deployments_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `deployments_getIamPolicy` | `SELECT` | `project, resource` | diff --git a/docs/google-docs/providers/google/deploymentmanager/manifests/index.md b/docs/google-docs/providers/google/deploymentmanager/manifests/index.md index f6b7e5a0f5..b7ba57c003 100644 --- a/docs/google-docs/providers/google/deploymentmanager/manifests/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/manifests/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | | | `name` | `string` | Output only. The name of the manifest. | -| `selfLink` | `string` | Output only. Self link for the manifest. | | `expandedConfig` | `string` | Output only. The fully-expanded configuration file, including any templates and references. | -| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | -| `manifestSizeLimitBytes` | `string` | Output only. The size limit for expanded manifests in the project. | | `imports` | `array` | Output only. The imported files for this manifest. | -| `config` | `object` | | +| `manifestSizeLimitBytes` | `string` | Output only. The size limit for expanded manifests in the project. | +| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | Output only. Self link for the manifest. | | `manifestSizeBytes` | `string` | Output only. The computed size of the fully expanded manifest. | +| `config` | `object` | | | `layout` | `string` | Output only. The YAML layout for this manifest. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/deploymentmanager/operations/index.md b/docs/google-docs/providers/google/deploymentmanager/operations/index.md index b5e9cb8520..97904e8988 100644 --- a/docs/google-docs/providers/google/deploymentmanager/operations/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/operations/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | [Output Only] The unique identifier for the operation. This identifier is defined by the server. | | `name` | `string` | [Output Only] Name of the operation. | | `description` | `string` | [Output Only] A textual description of the operation, which is set when the operation is created. | -| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com`. | -| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | | `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | -| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | | `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | -| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | | `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | | `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | | `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com`. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `progress` | `integer` | [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | | `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `operationGroupId` | `string` | [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. | +| `httpErrorStatusCode` | `integer` | [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | | `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `targetLink` | `string` | [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/deploymentmanager/resources/index.md b/docs/google-docs/providers/google/deploymentmanager/resources/index.md index e56991d5fd..663ece072b 100644 --- a/docs/google-docs/providers/google/deploymentmanager/resources/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/resources/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | | | `name` | `string` | Output only. The name of the resource as it appears in the YAML config. | -| `finalProperties` | `string` | Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. | +| `properties` | `string` | Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. | +| `accessControl` | `object` | The access controls set on the resource. | +| `url` | `string` | Output only. The URL of the actual resource. | +| `update` | `object` | | | `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | +| `finalProperties` | `string` | Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. | | `manifest` | `string` | Output only. URL of the manifest representing the current configuration of this resource. | +| `warnings` | `array` | Output only. If warning messages are generated during processing of this resource, this field will be populated. | | `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | -| `update` | `object` | | -| `accessControl` | `object` | The access controls set on the resource. | | `type` | `string` | Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`. | -| `url` | `string` | Output only. The URL of the actual resource. | -| `warnings` | `array` | Output only. If warning messages are generated during processing of this resource, this field will be populated. | -| `properties` | `string` | Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/agents/index.md b/docs/google-docs/providers/google/dialogflow/agents/index.md index a43c5c7c94..ee755de5c3 100644 --- a/docs/google-docs/providers/google/dialogflow/agents/index.md +++ b/docs/google-docs/providers/google/dialogflow/agents/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the agent. Required for the Agents.UpdateAgent method. Agents.CreateAgent populates the name automatically. Format: `projects//locations//agents/`. | | `description` | `string` | The description of the agent. The maximum length is 500 characters. If exceeded, the request is rejected. | -| `advancedSettings` | `object` | Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. | +| `gitIntegrationSettings` | `object` | Settings for connecting to Git repository for an agent. | | `enableStackdriverLogging` | `boolean` | Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. | -| `supportedLanguageCodes` | `array` | The list of all languages supported by the agent (except for the `default_language_code`). | -| `avatarUri` | `string` | The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. | +| `securitySettings` | `string` | Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. | | `timeZone` | `string` | Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris. | -| `displayName` | `string` | Required. The human-readable name of the agent, unique within the location. | -| `gitIntegrationSettings` | `object` | Settings for connecting to Git repository for an agent. | | `textToSpeechSettings` | `object` | Settings related to speech synthesizing. | -| `startFlow` | `string` | Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. | -| `enableSpellCorrection` | `boolean` | Indicates if automatic spell correction is enabled in detect intent requests. | +| `advancedSettings` | `object` | Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. | +| `locked` | `boolean` | Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. | | `speechToTextSettings` | `object` | Settings related to speech recognition. | +| `displayName` | `string` | Required. The human-readable name of the agent, unique within the location. | +| `avatarUri` | `string` | The URI of the agent's avatar. Avatars are used throughout the Dialogflow console and in the self-hosted [Web Demo](https://cloud.google.com/dialogflow/docs/integrations/web-demo) integration. | | `defaultLanguageCode` | `string` | Required. Immutable. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/cx/docs/reference/language) for a list of the currently supported language codes. This field cannot be set by the Agents.UpdateAgent method. | -| `locked` | `boolean` | Indicates whether the agent is locked for changes. If the agent is locked, modifications to the agent will be rejected except for RestoreAgent. | -| `securitySettings` | `string` | Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. | +| `startFlow` | `string` | Immutable. Name of the start flow in this agent. A start flow will be automatically created when the agent is created, and can only be deleted by deleting the agent. Format: `projects//locations//agents//flows/`. | +| `supportedLanguageCodes` | `array` | The list of all languages supported by the agent (except for the `default_language_code`). | +| `enableSpellCorrection` | `boolean` | Indicates if automatic spell correction is enabled in detect intent requests. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md b/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md index 0ea5385677..b919b0c206 100644 --- a/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md +++ b/docs/google-docs/providers/google/dialogflow/continuous_test_results/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the continuous test result. Format: `projects//locations//agents//environments//continuousTestResults/`. | -| `testCaseResults` | `array` | A list of individual test case results names in this continuous test run. | | `result` | `string` | The result of this continuous test run, i.e. whether all the tests in this continuous test run pass or not. | | `runTime` | `string` | Time when the continuous testing run starts. | +| `testCaseResults` | `array` | A list of individual test case results names in this continuous test run. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dialogflow/deployments/index.md b/docs/google-docs/providers/google/dialogflow/deployments/index.md index 5e98edd0f0..e1590c6964 100644 --- a/docs/google-docs/providers/google/dialogflow/deployments/index.md +++ b/docs/google-docs/providers/google/dialogflow/deployments/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the deployment. Format: projects//locations//agents//environments//deployments/. | -| `result` | `object` | Result of the deployment. | | `startTime` | `string` | Start time of this deployment. | | `state` | `string` | The current state of the deployment. | | `endTime` | `string` | End time of this deployment. | | `flowVersion` | `string` | The name of the flow version for this deployment. Format: projects//locations//agents//flows//versions/. | +| `result` | `object` | Result of the deployment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/entity_types/index.md b/docs/google-docs/providers/google/dialogflow/entity_types/index.md index 5df17f1929..0971363540 100644 --- a/docs/google-docs/providers/google/dialogflow/entity_types/index.md +++ b/docs/google-docs/providers/google/dialogflow/entity_types/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the entity type. Required for EntityTypes.UpdateEntityType. Format: `projects//locations//agents//entityTypes/`. | +| `redact` | `boolean` | Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging. | | `autoExpansionMode` | `string` | Indicates whether the entity type can be automatically expanded. | | `displayName` | `string` | Required. The human-readable name of the entity type, unique within the agent. | | `enableFuzzyExtraction` | `boolean` | Enables fuzzy entity extraction during classification. | | `entities` | `array` | The collection of entity entries associated with the entity type. | | `excludedPhrases` | `array` | Collection of exceptional words and phrases that shouldn't be matched. For example, if you have a size entity type with entry `giant`(an adjective), you might consider adding `giants`(a noun) as an exclusion. If the kind of entity type is `KIND_MAP`, then the phrases specified by entities and excluded phrases should be mutually exclusive. | | `kind` | `string` | Required. Indicates the kind of entity type. | -| `redact` | `boolean` | Indicates whether parameters of the entity type should be redacted in log. If redaction is enabled, page parameters and intent parameters referring to the entity type will be replaced by parameter name when logging. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/experiments/index.md b/docs/google-docs/providers/google/dialogflow/experiments/index.md index 0cf0867ded..0ed2016244 100644 --- a/docs/google-docs/providers/google/dialogflow/experiments/index.md +++ b/docs/google-docs/providers/google/dialogflow/experiments/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The name of the experiment. Format: projects//locations//agents//environments//experiments/.. | | `description` | `string` | The human-readable description of the experiment. | -| `definition` | `object` | Definition of the experiment. | -| `createTime` | `string` | Creation time of this experiment. | -| `rolloutFailureReason` | `string` | The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED. | -| `result` | `object` | The inference result which includes an objective metric to optimize and the confidence interval. | +| `variantsHistory` | `array` | The history of updates to the experiment variants. | +| `state` | `string` | The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE. | | `rolloutConfig` | `object` | The configuration for auto rollout. | -| `displayName` | `string` | Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters. | -| `startTime` | `string` | Start time of this experiment. | +| `definition` | `object` | Definition of the experiment. | | `endTime` | `string` | End time of this experiment. | -| `lastUpdateTime` | `string` | Last update time of this experiment. | | `rolloutState` | `object` | State of the auto-rollout process. | -| `variantsHistory` | `array` | The history of updates to the experiment variants. | +| `result` | `object` | The inference result which includes an objective metric to optimize and the confidence interval. | +| `rolloutFailureReason` | `string` | The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED. | +| `createTime` | `string` | Creation time of this experiment. | +| `lastUpdateTime` | `string` | Last update time of this experiment. | +| `displayName` | `string` | Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters. | | `experimentLength` | `string` | Maximum number of days to run the experiment/rollout. If auto-rollout is not enabled, default value and maximum will be 30 days. If auto-rollout is enabled, default value and maximum will be 6 days. | -| `state` | `string` | The current state of the experiment. Transition triggered by Experiments.StartExperiment: DRAFT->RUNNING. Transition triggered by Experiments.CancelExperiment: DRAFT->DONE or RUNNING->DONE. | +| `startTime` | `string` | Start time of this experiment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/flows/index.md b/docs/google-docs/providers/google/dialogflow/flows/index.md index 41a534b693..8fb0e136e9 100644 --- a/docs/google-docs/providers/google/dialogflow/flows/index.md +++ b/docs/google-docs/providers/google/dialogflow/flows/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the flow. Format: `projects//locations//agents//flows/`. | | `description` | `string` | The description of the flow. The maximum length is 500 characters. If exceeded, the request is rejected. | +| `eventHandlers` | `array` | A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. | | `nluSettings` | `object` | Settings related to NLU. | | `transitionRouteGroups` | `array` | A flow's transition route group serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition route groups. Transition route groups defined in the page have higher priority than those defined in the flow. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. | | `transitionRoutes` | `array` | A flow's transition routes serve two purposes: * They are responsible for matching the user's first utterances in the flow. * They are inherited by every page's transition routes and can support use cases such as the user saying "help" or "can I talk to a human?", which can be handled in a common way regardless of the current page. Transition routes defined in the page have higher priority than those defined in the flow. TransitionRoutes are evalauted in the following order: * TransitionRoutes with intent specified. * TransitionRoutes with only condition specified. TransitionRoutes with intent specified are inherited by pages in the flow. | | `displayName` | `string` | Required. The human-readable name of the flow. | -| `eventHandlers` | `array` | A flow's event handlers serve two purposes: * They are responsible for handling events (e.g. no match, webhook errors) in the flow. * They are inherited by every page's event handlers, which can be used to handle common events regardless of the current page. Event handlers defined in the page have higher priority than those defined in the flow. Unlike transition_routes, these handlers are evaluated on a first-match basis. The first one that matches the event get executed, with the rest being ignored. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md b/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md index 1f23e02570..5279dcaa73 100644 --- a/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md +++ b/docs/google-docs/providers/google/dialogflow/flows_validation_result/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the flow validation result. Format: `projects//locations//agents//flows//validationResult`. | -| `validationMessages` | `array` | Contains all validation messages. | | `updateTime` | `string` | Last time the flow was validated. | +| `validationMessages` | `array` | Contains all validation messages. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dialogflow/intents/index.md b/docs/google-docs/providers/google/dialogflow/intents/index.md index e5e5f96035..5b692883e7 100644 --- a/docs/google-docs/providers/google/dialogflow/intents/index.md +++ b/docs/google-docs/providers/google/dialogflow/intents/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the intent. Required for the Intents.UpdateIntent method. Intents.CreateIntent populates the name automatically. Format: `projects//locations//agents//intents/`. | | `description` | `string` | Human readable description for better understanding an intent like its scope, content, result etc. Maximum character limit: 140 characters. | +| `priority` | `integer` | The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. | +| `trainingPhrases` | `array` | The collection of training phrases the agent is trained on to identify the intent. | | `displayName` | `string` | Required. The human-readable name of the intent, unique within the agent. | | `isFallback` | `boolean` | Indicates whether this is a fallback intent. Currently only default fallback intent is allowed in the agent, which is added upon agent creation. Adding training phrases to fallback intent is useful in the case of requests that are mistakenly matched, since training phrases assigned to fallback intents act as negative examples that triggers no-match event. | | `labels` | `object` | The key/value metadata to label an intent. Labels can contain lowercase letters, digits and the symbols '-' and '_'. International characters are allowed, including letters from unicase alphabets. Keys must start with a letter. Keys and values can be no longer than 63 characters and no more than 128 bytes. Prefix "sys-" is reserved for Dialogflow defined labels. Currently allowed Dialogflow defined labels include: * sys-head * sys-contextual The above labels do not require value. "sys-head" means the intent is a head intent. "sys.contextual" means the intent is a contextual intent. | | `parameters` | `array` | The collection of parameters associated with the intent. | -| `priority` | `integer` | The priority of this intent. Higher numbers represent higher priorities. - If the supplied value is unspecified or 0, the service translates the value to 500,000, which corresponds to the `Normal` priority in the console. - If the supplied value is negative, the intent is ignored in runtime detect intent requests. | -| `trainingPhrases` | `array` | The collection of training phrases the agent is trained on to identify the intent. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/pages/index.md b/docs/google-docs/providers/google/dialogflow/pages/index.md index 4c69d918d2..def2fa7470 100644 --- a/docs/google-docs/providers/google/dialogflow/pages/index.md +++ b/docs/google-docs/providers/google/dialogflow/pages/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the page. Required for the Pages.UpdatePage method. Pages.CreatePage populates the name automatically. Format: `projects//locations//agents//flows//pages/`. | -| `transitionRouteGroups` | `array` | Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. | -| `transitionRoutes` | `array` | A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. | -| `displayName` | `string` | Required. The human-readable name of the page, unique within the flow. | | `entryFulfillment` | `object` | A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. | | `eventHandlers` | `array` | Handlers associated with the page to handle events such as webhook errors, no match or no input. | | `form` | `object` | A form is a data model that groups related parameters that can be collected from the user. The process in which the agent prompts the user and collects parameter values from the user is called form filling. A form can be added to a page. When form filling is done, the filled parameters will be written to the session. | +| `transitionRouteGroups` | `array` | Ordered list of `TransitionRouteGroups` associated with the page. Transition route groups must be unique within a page. * If multiple transition routes within a page scope refer to the same intent, then the precedence order is: page's transition route -> page's transition route group -> flow's transition routes. * If multiple transition route groups within a page contain the same intent, then the first group in the ordered list takes precedence. Format:`projects//locations//agents//flows//transitionRouteGroups/` or `projects//locations//agents//transitionRouteGroups/` for agent-level groups. | +| `transitionRoutes` | `array` | A list of transitions for the transition rules of this page. They route the conversation to another page in the same flow, or another flow. When we are in a certain page, the TransitionRoutes are evalauted in the following order: * TransitionRoutes defined in the page with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in flow with intent specified. * TransitionRoutes defined in the transition route groups with intent specified. * TransitionRoutes defined in the page with only condition specified. * TransitionRoutes defined in the transition route groups with only condition specified. | +| `displayName` | `string` | Required. The human-readable name of the page, unique within the flow. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/results/index.md b/docs/google-docs/providers/google/dialogflow/results/index.md index 5c7a3ae721..9bb4edf52c 100644 --- a/docs/google-docs/providers/google/dialogflow/results/index.md +++ b/docs/google-docs/providers/google/dialogflow/results/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the test case result. Format: `projects//locations//agents//testCases/ /results/`. | +| `environment` | `string` | Environment where the test was run. If not set, it indicates the draft environment. | | `testResult` | `string` | Whether the test case passed in the agent environment. | | `testTime` | `string` | The time that the test was run. | | `conversationTurns` | `array` | The conversation turns uttered during the test case replay in chronological order. | -| `environment` | `string` | Environment where the test was run. If not set, it indicates the draft environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/security_settings/index.md b/docs/google-docs/providers/google/dialogflow/security_settings/index.md index 933e6ec982..e1612a5bd4 100644 --- a/docs/google-docs/providers/google/dialogflow/security_settings/index.md +++ b/docs/google-docs/providers/google/dialogflow/security_settings/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name of the settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`. | | `redactionStrategy` | `string` | Strategy that defines how we do redaction. | -| `redactionScope` | `string` | Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging. | -| `insightsExportSettings` | `object` | Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs). | -| `audioExportSettings` | `object` | Settings for exporting audio. | -| `displayName` | `string` | Required. The human-readable name of the security settings, unique within the location. | -| `inspectTemplate` | `string` | [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. The `DLP Inspect Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//locations//inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `inspect_template` must be located in the same region as the `SecuritySettings`. | -| `retentionWindowDays` | `integer` | Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. | | `purgeDataTypes` | `array` | List of types of data to remove when retention settings triggers purge. | +| `inspectTemplate` | `string` | [DLP](https://cloud.google.com/dlp/docs) inspect template name. Use this template to define inspect base settings. The `DLP Inspect Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, we use the default DLP inspect config. The template name will have one of the following formats: `projects//locations//inspectTemplates/` OR `organizations//locations//inspectTemplates/` Note: `inspect_template` must be located in the same region as the `SecuritySettings`. | | `deidentifyTemplate` | `string` | [DLP](https://cloud.google.com/dlp/docs) deidentify template name. Use this template to define de-identification configuration for the content. The `DLP De-identify Templates Reader` role is needed on the Dialogflow service identity service account (has the form `service-PROJECT_NUMBER@gcp-sa-dialogflow.iam.gserviceaccount.com`) for your agent's project. If empty, Dialogflow replaces sensitive info with `[redacted]` text. The template name will have one of the following formats: `projects//locations//deidentifyTemplates/` OR `organizations//locations//deidentifyTemplates/` Note: `deidentify_template` must be located in the same region as the `SecuritySettings`. | +| `displayName` | `string` | Required. The human-readable name of the security settings, unique within the location. | +| `audioExportSettings` | `object` | Settings for exporting audio. | +| `redactionScope` | `string` | Defines the data for which Dialogflow applies redaction. Dialogflow does not redact data that it does not have access to – for example, Cloud logging. | +| `retentionWindowDays` | `integer` | Retains the data for the specified number of days. User must set a value lower than Dialogflow's default 365d TTL (30 days for Agent Assist traffic), higher value will be ignored and use default. Setting a value higher than that has no effect. A missing value or setting to 0 also means we use default TTL. | +| `insightsExportSettings` | `object` | Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/test_cases/index.md b/docs/google-docs/providers/google/dialogflow/test_cases/index.md index e8e02de7a4..371259e608 100644 --- a/docs/google-docs/providers/google/dialogflow/test_cases/index.md +++ b/docs/google-docs/providers/google/dialogflow/test_cases/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the test case. TestCases.CreateTestCase will populate the name automatically. Otherwise use format: `projects//locations//agents/ /testCases/`. | +| `tags` | `array` | Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters. | +| `testCaseConversationTurns` | `array` | The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly. | +| `testConfig` | `object` | Represents configurations for a test case. | | `creationTime` | `string` | Output only. When the test was created. | | `displayName` | `string` | Required. The human-readable name of the test case, unique within the agent. Limit of 200 characters. | | `lastTestResult` | `object` | Represents a result from running a test case in an agent environment. | | `notes` | `string` | Additional freeform notes about the test case. Limit of 400 characters. | -| `tags` | `array` | Tags are short descriptions that users may apply to test cases for organizational and filtering purposes. Each tag should start with "#" and has a limit of 30 characters. | -| `testCaseConversationTurns` | `array` | The conversation turns uttered when the test case was created, in chronological order. These include the canonical set of agent utterances that should occur when the agent is working properly. | -| `testConfig` | `object` | Represents configurations for a test case. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md b/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md index 4a549284e5..3175e7b34f 100644 --- a/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md +++ b/docs/google-docs/providers/google/dialogflow/transition_route_groups/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the transition route group. TransitionRouteGroups.CreateTransitionRouteGroup populates the name automatically. Format: `projects//locations//agents//flows//transitionRouteGroups/` . | -| `transitionRoutes` | `array` | Transition routes associated with the TransitionRouteGroup. | | `displayName` | `string` | Required. The human-readable name of the transition route group, unique within the flow. The display name can be no longer than 30 characters. | +| `transitionRoutes` | `array` | Transition routes associated with the TransitionRouteGroup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/webhooks/index.md b/docs/google-docs/providers/google/dialogflow/webhooks/index.md index 47f156b8ef..87725ccc64 100644 --- a/docs/google-docs/providers/google/dialogflow/webhooks/index.md +++ b/docs/google-docs/providers/google/dialogflow/webhooks/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique identifier of the webhook. Required for the Webhooks.UpdateWebhook method. Webhooks.CreateWebhook populates the name automatically. Format: `projects//locations//agents//webhooks/`. | +| `genericWebService` | `object` | Represents configuration for a generic web service. | | `serviceDirectory` | `object` | Represents configuration for a [Service Directory](https://cloud.google.com/service-directory) service. | | `timeout` | `string` | Webhook execution timeout. Execution is considered failed if Dialogflow doesn't receive a response from webhook at the end of the timeout period. Defaults to 5 seconds, maximum allowed timeout is 30 seconds. | | `disabled` | `boolean` | Indicates whether the webhook is disabled. | | `displayName` | `string` | Required. The human-readable name of the webhook, unique within the agent. | -| `genericWebService` | `object` | Represents configuration for a generic web service. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/discoveryengine/documents/index.md b/docs/google-docs/providers/google/discoveryengine/documents/index.md index 4ea59dda65..251fea420d 100644 --- a/docs/google-docs/providers/google/discoveryengine/documents/index.md +++ b/docs/google-docs/providers/google/discoveryengine/documents/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. | | `name` | `string` | Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. | +| `parentDocumentId` | `string` | The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. | | `schemaId` | `string` | The identifier of the schema located in the same data store. | | `structData` | `object` | The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. | | `jsonData` | `string` | The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. | -| `parentDocumentId` | `string` | The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/discoveryengine/operations/index.md b/docs/google-docs/providers/google/discoveryengine/operations/index.md index 782e010714..49afc8ec8b 100644 --- a/docs/google-docs/providers/google/discoveryengine/operations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | | `metadata` | `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. | | `response` | `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`. | | `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md b/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md index 65a7ff86e9..d792f43986 100644 --- a/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/target_site_operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | -| `response` | `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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dlp/deidentify_templates/index.md b/docs/google-docs/providers/google/dlp/deidentify_templates/index.md index b413077d25..44bee6495c 100644 --- a/docs/google-docs/providers/google/dlp/deidentify_templates/index.md +++ b/docs/google-docs/providers/google/dlp/deidentify_templates/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The template name. The template will have one of the following formats: `projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID` | | `description` | `string` | Short description (max 256 chars). | +| `createTime` | `string` | Output only. The creation timestamp of an inspectTemplate. | | `deidentifyConfig` | `object` | The configuration that controls how the data will change. | | `displayName` | `string` | Display name (max 256 chars). | | `updateTime` | `string` | Output only. The last update timestamp of an inspectTemplate. | -| `createTime` | `string` | Output only. The creation timestamp of an inspectTemplate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dlp/dlp_jobs/index.md b/docs/google-docs/providers/google/dlp/dlp_jobs/index.md index 0c489e17ff..befbb972a1 100644 --- a/docs/google-docs/providers/google/dlp/dlp_jobs/index.md +++ b/docs/google-docs/providers/google/dlp/dlp_jobs/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name. | -| `state` | `string` | State of a job. | -| `type` | `string` | The type of job. | +| `jobTriggerName` | `string` | If created by a job trigger, the resource name of the trigger that instantiated the job. | | `actionDetails` | `array` | Events that should occur after the job has completed. | -| `errors` | `array` | A stream of errors encountered running the job. | +| `state` | `string` | State of a job. | +| `endTime` | `string` | Time when the job finished. | | `inspectDetails` | `object` | The results of an inspect DataSource job. | -| `riskDetails` | `object` | Result of a risk analysis operation request. | | `startTime` | `string` | Time when the job started. | -| `endTime` | `string` | Time when the job finished. | -| `jobTriggerName` | `string` | If created by a job trigger, the resource name of the trigger that instantiated the job. | +| `errors` | `array` | A stream of errors encountered running the job. | +| `riskDetails` | `object` | Result of a risk analysis operation request. | +| `type` | `string` | The type of job. | | `createTime` | `string` | Time when the job was created. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/dlp/job_triggers/index.md b/docs/google-docs/providers/google/dlp/job_triggers/index.md index 2335719667..6e0f30f99a 100644 --- a/docs/google-docs/providers/google/dlp/job_triggers/index.md +++ b/docs/google-docs/providers/google/dlp/job_triggers/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Unique resource name for the triggeredJob, assigned by the service when the triggeredJob is created, for example `projects/dlp-test-project/jobTriggers/53234423`. | | `description` | `string` | User provided description (max 256 chars) | -| `errors` | `array` | Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. | +| `triggers` | `array` | A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. | | `lastRunTime` | `string` | Output only. The timestamp of the last time this trigger executed. | +| `inspectJob` | `object` | Controls what and how to inspect for findings. | +| `errors` | `array` | Output only. A stream of errors encountered when the trigger was activated. Repeated errors may result in the JobTrigger automatically being paused. Will return the last 100 errors. Whenever the JobTrigger is modified this list will be cleared. | | `status` | `string` | Required. A status for this trigger. | | `createTime` | `string` | Output only. The creation timestamp of a triggeredJob. | -| `displayName` | `string` | Display name (max 100 chars) | -| `triggers` | `array` | A list of triggers which will be OR'ed together. Only one in the list needs to trigger for a job to be started. The list may contain only a single Schedule trigger and must have at least one object. | -| `inspectJob` | `object` | Controls what and how to inspect for findings. | | `updateTime` | `string` | Output only. The last update timestamp of a triggeredJob. | +| `displayName` | `string` | Display name (max 100 chars) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dlp/stored_info_types/index.md b/docs/google-docs/providers/google/dlp/stored_info_types/index.md index 5602f2bafd..c83649140a 100644 --- a/docs/google-docs/providers/google/dlp/stored_info_types/index.md +++ b/docs/google-docs/providers/google/dlp/stored_info_types/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name. | -| `currentVersion` | `object` | Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. | | `pendingVersions` | `array` | Pending versions of the stored info type. Empty if no versions are pending. | +| `currentVersion` | `object` | Version of a StoredInfoType, including the configuration used to build it, create timestamp, and current state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/changes/index.md b/docs/google-docs/providers/google/dns/changes/index.md index 7e2ef7390c..2c862cb4d5 100644 --- a/docs/google-docs/providers/google/dns/changes/index.md +++ b/docs/google-docs/providers/google/dns/changes/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | Unique identifier for the resource; defined by the server (output only). | -| `kind` | `string` | | -| `startTime` | `string` | The time that this operation was started by the server (output only). This is in RFC3339 text format. | | `status` | `string` | Status of the operation (output only). A status of "done" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. | | `additions` | `array` | Which ResourceRecordSets to add? | | `deletions` | `array` | Which ResourceRecordSets to remove? Must match existing data exactly. | | `isServing` | `boolean` | If the DNS queries for the zone will be served. | +| `kind` | `string` | | +| `startTime` | `string` | The time that this operation was started by the server (output only). This is in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/dns_keys/index.md b/docs/google-docs/providers/google/dns/dns_keys/index.md index beaac92f2a..c2fe56100b 100644 --- a/docs/google-docs/providers/google/dns/dns_keys/index.md +++ b/docs/google-docs/providers/google/dns/dns_keys/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Unique identifier for the resource; defined by the server (output only). | | `description` | `string` | A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the resource's function. | -| `keyTag` | `integer` | The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. | | `isActive` | `boolean` | Active keys are used to sign subsequent changes to the ManagedZone. Inactive keys are still present as DNSKEY Resource Records for the use of resolvers validating existing signatures. | | `algorithm` | `string` | String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. | -| `type` | `string` | One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time. | -| `creationTime` | `string` | The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. | | `digests` | `array` | Cryptographic hashes of the DNSKEY resource record associated with this DnsKey. These digests are needed to construct a DS record that points at this DNS key. Output only. | -| `kind` | `string` | | | `keyLength` | `integer` | Length of the key in bits. Specified at creation time, and then immutable. | | `publicKey` | `string` | Base64 encoded public half of this key. Output only. | +| `type` | `string` | One of "KEY_SIGNING" or "ZONE_SIGNING". Keys of type KEY_SIGNING have the Secure Entry Point flag set and, when active, are used to sign only resource record sets of type DNSKEY. Otherwise, the Secure Entry Point flag is cleared, and this key is used to sign only resource record sets of other types. Immutable after creation time. | +| `creationTime` | `string` | The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. | +| `kind` | `string` | | +| `keyTag` | `integer` | The key tag is a non-cryptographic hash of the a DNSKEY resource record associated with this DnsKey. The key tag can be used to identify a DNSKEY more quickly (but it is not a unique identifier). In particular, the key tag is used in a parent zone's DS record to point at the DNSKEY in this child ManagedZone. The key tag is a number in the range [0, 65535] and the algorithm to calculate it is specified in RFC4034 Appendix B. Output only. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/managed_zone_operations/index.md b/docs/google-docs/providers/google/dns/managed_zone_operations/index.md index d460f92f64..f152193841 100644 --- a/docs/google-docs/providers/google/dns/managed_zone_operations/index.md +++ b/docs/google-docs/providers/google/dns/managed_zone_operations/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | Unique identifier for the resource. This is the client_operation_id if the client specified it when the mutation was initiated, otherwise, it is generated by the server. The name must be 1-63 characters long and match the regular expression [-a-z0-9]? (output only) | +| `type` | `string` | Type of the operation. Operations include insert, update, and delete (output only). | +| `user` | `string` | User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) | | `zoneContext` | `object` | | | `dnsKeyContext` | `object` | | | `kind` | `string` | | | `startTime` | `string` | The time that this operation was started by the server. This is in RFC3339 text format (output only). | | `status` | `string` | Status of the operation. Can be one of the following: "PENDING" or "DONE" (output only). A status of "DONE" means that the request to update the authoritative servers has been sent, but the servers might not be updated yet. | -| `type` | `string` | Type of the operation. Operations include insert, update, and delete (output only). | -| `user` | `string` | User who requested the operation, for example: user@example.com. cloud-dns-system for operations automatically done by the system. (output only) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/managed_zones/index.md b/docs/google-docs/providers/google/dns/managed_zones/index.md index 25cfd33737..7ff54d0e7f 100644 --- a/docs/google-docs/providers/google/dns/managed_zones/index.md +++ b/docs/google-docs/providers/google/dns/managed_zones/index.md @@ -30,20 +30,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Unique identifier for the resource; defined by the server (output only) | | `name` | `string` | User assigned name for this resource. Must be unique within the project. The name must be 1-63 characters long, must begin with a letter, end with a letter or digit, and only contain lowercase letters, digits or dashes. | | `description` | `string` | A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the managed zone's function. | -| `nameServers` | `array` | Delegate your managed_zone to these virtual name servers; defined by the server (output only) | -| `dnsName` | `string` | The DNS name of this managed zone, for instance "example.com.". | +| `labels` | `object` | User labels. | | `forwardingConfig` | `object` | | -| `peeringConfig` | `object` | | -| `privateVisibilityConfig` | `object` | | -| `visibility` | `string` | The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. | -| `kind` | `string` | | | `cloudLoggingConfig` | `object` | Cloud Logging configurations for publicly visible zones. | | `serviceDirectoryConfig` | `object` | Contains information about Service Directory-backed zones. | -| `labels` | `object` | User labels. | | `nameServerSet` | `string` | Optionally specifies the NameServerSet for this ManagedZone. A NameServerSet is a set of DNS name servers that all host the same ManagedZones. Most users leave this field unset. If you need to use this field, contact your account team. | | `reverseLookupConfig` | `object` | | | `creationTime` | `string` | The time that this resource was created on the server. This is in RFC3339 text format. Output only. | +| `nameServers` | `array` | Delegate your managed_zone to these virtual name servers; defined by the server (output only) | | `dnssecConfig` | `object` | | +| `dnsName` | `string` | The DNS name of this managed zone, for instance "example.com.". | +| `visibility` | `string` | The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. | +| `privateVisibilityConfig` | `object` | | +| `kind` | `string` | | +| `peeringConfig` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/managed_zones_iam_audit_configs/index.md b/docs/google-docs/providers/google/dns/managed_zones_iam_audit_configs/index.md deleted file mode 100644 index 37a469c3e3..0000000000 --- a/docs/google-docs/providers/google/dns/managed_zones_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: managed_zones_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - managed_zones_iam_audit_configs - - dns - - 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 ---- - - - -## Overview - - - - -
Namemanaged_zones_iam_audit_configs
TypeResource
Idgoogle.dns.managed_zones_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `managedZones_getIamPolicy` | `SELECT` | `managedZonesId, projectsId` | diff --git a/docs/google-docs/providers/google/dns/managed_zones_iam_bindings/index.md b/docs/google-docs/providers/google/dns/managed_zones_iam_bindings/index.md deleted file mode 100644 index 3697517970..0000000000 --- a/docs/google-docs/providers/google/dns/managed_zones_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: managed_zones_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - managed_zones_iam_bindings - - dns - - 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 ---- - - - -## Overview - - - - -
Namemanaged_zones_iam_bindings
TypeResource
Idgoogle.dns.managed_zones_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `managedZones_getIamPolicy` | `SELECT` | `managedZonesId, projectsId` | diff --git a/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md b/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md index 42dcef7a28..54010cbdae 100644 --- a/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md +++ b/docs/google-docs/providers/google/dns/managed_zones_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/response_policy_rules/index.md b/docs/google-docs/providers/google/dns/response_policy_rules/index.md index 5796d7cbd5..4df19df0ee 100644 --- a/docs/google-docs/providers/google/dns/response_policy_rules/index.md +++ b/docs/google-docs/providers/google/dns/response_policy_rules/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `dnsName` | `string` | The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. | -| `kind` | `string` | | | `localData` | `object` | | | `ruleName` | `string` | An identifier for this rule. Must be unique with the ResponsePolicy. | | `behavior` | `string` | Answer this query with a behavior rather than DNS data. | +| `dnsName` | `string` | The DNS name (wildcard or exact) to apply this rule to. Must be unique within the Response Policy Rule. | +| `kind` | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/documentai/evaluations/index.md b/docs/google-docs/providers/google/documentai/evaluations/index.md index d47fec2036..417d6e2cc5 100644 --- a/docs/google-docs/providers/google/documentai/evaluations/index.md +++ b/docs/google-docs/providers/google/documentai/evaluations/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` | -| `allEntitiesMetrics` | `object` | Metrics across multiple confidence levels. | | `createTime` | `string` | The time that the evaluation was created. | | `documentCounters` | `object` | Evaluation counters for the documents that were used. | | `entityMetrics` | `object` | Metrics across confidence levels, for different entities. | | `kmsKeyName` | `string` | The KMS key name used for encryption. | | `kmsKeyVersionName` | `string` | The KMS key version with which data is encrypted. | +| `allEntitiesMetrics` | `object` | Metrics across multiple confidence levels. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/documentai/locations_processor_types/index.md b/docs/google-docs/providers/google/documentai/locations_processor_types/index.md deleted file mode 100644 index 5dbd656605..0000000000 --- a/docs/google-docs/providers/google/documentai/locations_processor_types/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: locations_processor_types -hide_title: false -hide_table_of_contents: false -keywords: - - locations_processor_types - - documentai - - 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 ---- - - - -## Overview - - - - -
Namelocations_processor_types
TypeResource
Idgoogle.documentai.locations_processor_types
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_fetchProcessorTypes` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/documentai/processor_types/index.md b/docs/google-docs/providers/google/documentai/processor_types/index.md index aeaee01d57..dcf077df4d 100644 --- a/docs/google-docs/providers/google/documentai/processor_types/index.md +++ b/docs/google-docs/providers/google/documentai/processor_types/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the processor type. Format: `projects/{project}/processorTypes/{processor_type}` | +| `launchStage` | `string` | Launch stage of the processor type | +| `sampleDocumentUris` | `array` | A set of Cloud Storage URIs of sample documents for this processor. | | `type` | `string` | The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. | | `allowCreation` | `boolean` | Whether the processor type allows creation. If true, users can create a processor of this processor type. Otherwise, users need to request access. | | `availableLocations` | `array` | The locations in which this processor is available. | | `category` | `string` | The processor category, used by UI to group processor types. | -| `launchStage` | `string` | Launch stage of the processor type | -| `sampleDocumentUris` | `array` | A set of Cloud Storage URIs of sample documents for this processor. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/documentai/processor_versions/index.md b/docs/google-docs/providers/google/documentai/processor_versions/index.md index a28ddf9b18..cc057a9a2e 100644 --- a/docs/google-docs/providers/google/documentai/processor_versions/index.md +++ b/docs/google-docs/providers/google/documentai/processor_versions/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the processor version. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}` | +| `deprecationInfo` | `object` | Information about the upcoming deprecation of this processor version. | +| `googleManaged` | `boolean` | Output only. Denotes that this `ProcessorVersion` is managed by Google. | | `state` | `string` | The state of the processor version. | +| `latestEvaluation` | `object` | Gives a short summary of an evaluation, and links to the evaluation itself. | +| `createTime` | `string` | The time the processor version was created. | | `kmsKeyVersionName` | `string` | The KMS key version with which data is encrypted. | -| `deprecationInfo` | `object` | Information about the upcoming deprecation of this processor version. | | `displayName` | `string` | The display name of the processor version. | -| `latestEvaluation` | `object` | Gives a short summary of an evaluation, and links to the evaluation itself. | | `documentSchema` | `object` | The schema defines the output of the processed document by a processor. | -| `googleManaged` | `boolean` | Output only. Denotes that this `ProcessorVersion` is managed by Google. | | `kmsKeyName` | `string` | The KMS key name used for encryption. | -| `createTime` | `string` | The time the processor version was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/documentai/processors/index.md b/docs/google-docs/providers/google/documentai/processors/index.md index 6660d0699e..6fe1e4aa7a 100644 --- a/docs/google-docs/providers/google/documentai/processors/index.md +++ b/docs/google-docs/providers/google/documentai/processors/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Immutable. The resource name of the processor. Format: `projects/{project}/locations/{location}/processors/{processor}` | -| `type` | `string` | The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. | -| `createTime` | `string` | The time the processor was created. | -| `processorVersionAliases` | `array` | Output only. The processor version aliases. | -| `kmsKeyName` | `string` | The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. | -| `state` | `string` | Output only. The state of the processor. | | `defaultProcessorVersion` | `string` | The default processor version. | -| `processEndpoint` | `string` | Output only. Immutable. The http endpoint that can be called to invoke processing. | +| `kmsKeyName` | `string` | The [KMS key](https://cloud.google.com/security-key-management) used for encryption and decryption in CMEK scenarios. | | `displayName` | `string` | The display name of the processor. | +| `createTime` | `string` | The time the processor was created. | +| `processEndpoint` | `string` | Output only. Immutable. The http endpoint that can be called to invoke processing. | +| `type` | `string` | The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. | +| `state` | `string` | Output only. The state of the processor. | +| `processorVersionAliases` | `array` | Output only. The processor version aliases. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/domains/locations/index.md b/docs/google-docs/providers/google/domains/locations/index.md index e23fe5cc7a..80bd0f50d4 100644 --- a/docs/google-docs/providers/google/domains/locations/index.md +++ b/docs/google-docs/providers/google/domains/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/domains/operations/index.md b/docs/google-docs/providers/google/domains/operations/index.md index c98393dd8b..237e5c6376 100644 --- a/docs/google-docs/providers/google/domains/operations/index.md +++ b/docs/google-docs/providers/google/domains/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/domains/registrations/index.md b/docs/google-docs/providers/google/domains/registrations/index.md index 0079c681ee..5f27e6a6ba 100644 --- a/docs/google-docs/providers/google/domains/registrations/index.md +++ b/docs/google-docs/providers/google/domains/registrations/index.md @@ -28,19 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the `Registration` resource, in the format `projects/*/locations/*/registrations/`. | +| `supportedPrivacy` | `array` | Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports. | +| `domainName` | `string` | Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. | +| `contactSettings` | `object` | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. | | `managementSettings` | `object` | Defines renewal, billing, and transfer settings for a `Registration`. | -| `labels` | `object` | Set of labels associated with the `Registration`. | +| `registerFailureReason` | `string` | Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state. | | `issues` | `array` | Output only. The set of issues with the `Registration` that require attention. | -| `dnsSettings` | `object` | Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records. | -| `pendingContactSettings` | `object` | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. | -| `state` | `string` | Output only. The state of the `Registration` | +| `transferFailureReason` | `string` | Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state. | | `expireTime` | `string` | Output only. The expiration timestamp of the `Registration`. | +| `state` | `string` | Output only. The state of the `Registration` | +| `pendingContactSettings` | `object` | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. | | `createTime` | `string` | Output only. The creation timestamp of the `Registration` resource. | -| `contactSettings` | `object` | Defines the contact information associated with a `Registration`. [ICANN](https://icann.org/) requires all domain names to have associated contact information. The `registrant_contact` is considered the domain's legal owner, and often the other contacts are identical. | -| `domainName` | `string` | Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. | -| `supportedPrivacy` | `array` | Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports. | -| `transferFailureReason` | `string` | Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state. | -| `registerFailureReason` | `string` | Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state. | +| `labels` | `object` | Set of labels associated with the `Registration`. | +| `dnsSettings` | `object` | Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/domains/registrations_iam_audit_configs/index.md b/docs/google-docs/providers/google/domains/registrations_iam_audit_configs/index.md deleted file mode 100644 index 4c6b67f021..0000000000 --- a/docs/google-docs/providers/google/domains/registrations_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: registrations_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - registrations_iam_audit_configs - - domains - - 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 ---- - - - -## Overview - - - - -
Nameregistrations_iam_audit_configs
TypeResource
Idgoogle.domains.registrations_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_registrations_getIamPolicy` | `SELECT` | `locationsId, projectsId, registrationsId` | diff --git a/docs/google-docs/providers/google/domains/registrations_iam_bindings/index.md b/docs/google-docs/providers/google/domains/registrations_iam_bindings/index.md deleted file mode 100644 index 7134f86ddd..0000000000 --- a/docs/google-docs/providers/google/domains/registrations_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: registrations_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - registrations_iam_bindings - - domains - - 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 ---- - - - -## Overview - - - - -
Nameregistrations_iam_bindings
TypeResource
Idgoogle.domains.registrations_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_registrations_getIamPolicy` | `SELECT` | `locationsId, projectsId, registrationsId` | diff --git a/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md b/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md index ca97657707..7b7487fec5 100644 --- a/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md +++ b/docs/google-docs/providers/google/domains/registrations_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/essentialcontacts/contacts/index.md b/docs/google-docs/providers/google/essentialcontacts/contacts/index.md index ec8974cdb1..1845815975 100644 --- a/docs/google-docs/providers/google/essentialcontacts/contacts/index.md +++ b/docs/google-docs/providers/google/essentialcontacts/contacts/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The identifier for the contact. Format: {resource_type}/{resource_id}/contacts/{contact_id} | -| `validateTime` | `string` | The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. | | `validationState` | `string` | The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. | | `email` | `string` | Required. The email address to send notifications to. The email address does not need to be a Google Account. | | `languageTag` | `string` | Required. The preferred language for notifications, as a ISO 639-1 language code. See [Supported languages](https://cloud.google.com/resource-manager/docs/managing-notification-contacts#supported-languages) for a list of supported languages. | | `notificationCategorySubscriptions` | `array` | Required. The categories of notifications that the contact will receive communications for. | +| `validateTime` | `string` | The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/channel_connections/index.md b/docs/google-docs/providers/google/eventarc/channel_connections/index.md index 3a109764f6..c9fb58f888 100644 --- a/docs/google-docs/providers/google/eventarc/channel_connections/index.md +++ b/docs/google-docs/providers/google/eventarc/channel_connections/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The name of the connection. | -| `uid` | `string` | Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted. | -| `updateTime` | `string` | Output only. The last-modified time. | | `activationToken` | `string` | Input only. Activation token for the channel. The token will be used during the creation of ChannelConnection to bind the channel with the provider project. This field will not be stored in the provider resource. | | `channel` | `string` | Required. The name of the connected subscriber Channel. This is a weak reference to avoid cross project and cross accounts references. This must be in `projects/{project}/location/{location}/channels/{channel_id}` format. | | `createTime` | `string` | Output only. The creation time. | +| `uid` | `string` | Output only. Server assigned ID of the resource. The server guarantees uniqueness and immutability until deleted. | +| `updateTime` | `string` | Output only. The last-modified time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/channel_connections_iam_audit_configs/index.md b/docs/google-docs/providers/google/eventarc/channel_connections_iam_audit_configs/index.md deleted file mode 100644 index 8333318aa7..0000000000 --- a/docs/google-docs/providers/google/eventarc/channel_connections_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: channel_connections_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - channel_connections_iam_audit_configs - - eventarc - - 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 ---- - - - -## Overview - - - - -
Namechannel_connections_iam_audit_configs
TypeResource
Idgoogle.eventarc.channel_connections_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_channelConnections_getIamPolicy` | `SELECT` | `channelConnectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/eventarc/channel_connections_iam_bindings/index.md b/docs/google-docs/providers/google/eventarc/channel_connections_iam_bindings/index.md deleted file mode 100644 index c8dc682b14..0000000000 --- a/docs/google-docs/providers/google/eventarc/channel_connections_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: channel_connections_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - channel_connections_iam_bindings - - eventarc - - 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 ---- - - - -## Overview - - - - -
Namechannel_connections_iam_bindings
TypeResource
Idgoogle.eventarc.channel_connections_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_channelConnections_getIamPolicy` | `SELECT` | `channelConnectionsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md b/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md index fb6463239c..673d707733 100644 --- a/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md +++ b/docs/google-docs/providers/google/eventarc/channel_connections_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/channels/index.md b/docs/google-docs/providers/google/eventarc/channels/index.md index 7ea6473a06..c65661bc22 100644 --- a/docs/google-docs/providers/google/eventarc/channels/index.md +++ b/docs/google-docs/providers/google/eventarc/channels/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the channel. Must be unique within the location on the project and must be in `projects/{project}/locations/{location}/channels/{channel_id}` format. | -| `pubsubTopic` | `string` | Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{project}/topics/{topic_id}`. | -| `updateTime` | `string` | Output only. The last-modified time. | -| `uid` | `string` | Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | | `provider` | `string` | The name of the event provider (e.g. Eventarc SaaS partner) associated with the channel. This provider will be granted permissions to publish events to the channel. Format: `projects/{project}/locations/{location}/providers/{provider_id}`. | -| `activationToken` | `string` | Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing. | -| `state` | `string` | Output only. The state of a Channel. | -| `createTime` | `string` | Output only. The creation time. | | `cryptoKeyName` | `string` | Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | +| `createTime` | `string` | Output only. The creation time. | +| `state` | `string` | Output only. The state of a Channel. | +| `activationToken` | `string` | Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing. | +| `pubsubTopic` | `string` | Output only. The name of the Pub/Sub topic created and managed by Eventarc system as a transport for the event delivery. Format: `projects/{project}/topics/{topic_id}`. | +| `uid` | `string` | Output only. Server assigned unique identifier for the channel. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `updateTime` | `string` | Output only. The last-modified time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/channels_iam_audit_configs/index.md b/docs/google-docs/providers/google/eventarc/channels_iam_audit_configs/index.md deleted file mode 100644 index b24628c4d3..0000000000 --- a/docs/google-docs/providers/google/eventarc/channels_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: channels_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - channels_iam_audit_configs - - eventarc - - 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 ---- - - - -## Overview - - - - -
Namechannels_iam_audit_configs
TypeResource
Idgoogle.eventarc.channels_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_channels_getIamPolicy` | `SELECT` | `channelsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/eventarc/channels_iam_bindings/index.md b/docs/google-docs/providers/google/eventarc/channels_iam_bindings/index.md deleted file mode 100644 index 6ddf9cb47a..0000000000 --- a/docs/google-docs/providers/google/eventarc/channels_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: channels_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - channels_iam_bindings - - eventarc - - 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 ---- - - - -## Overview - - - - -
Namechannels_iam_bindings
TypeResource
Idgoogle.eventarc.channels_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_channels_getIamPolicy` | `SELECT` | `channelsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md b/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md index d0f055f96a..73e7309dca 100644 --- a/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md +++ b/docs/google-docs/providers/google/eventarc/channels_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/google_channel_config/index.md b/docs/google-docs/providers/google/eventarc/google_channel_config/index.md index e1d197dc00..9ea66aeee4 100644 --- a/docs/google-docs/providers/google/eventarc/google_channel_config/index.md +++ b/docs/google-docs/providers/google/eventarc/google_channel_config/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. | -| `updateTime` | `string` | Output only. The last-modified time. | | `cryptoKeyName` | `string` | Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | +| `updateTime` | `string` | Output only. The last-modified time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/locations/index.md b/docs/google-docs/providers/google/eventarc/locations/index.md index 33044e294b..e5617597d8 100644 --- a/docs/google-docs/providers/google/eventarc/locations/index.md +++ b/docs/google-docs/providers/google/eventarc/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | -| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/locations_google_channel_config/index.md b/docs/google-docs/providers/google/eventarc/locations_google_channel_config/index.md deleted file mode 100644 index e8766650cf..0000000000 --- a/docs/google-docs/providers/google/eventarc/locations_google_channel_config/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: locations_google_channel_config -hide_title: false -hide_table_of_contents: false -keywords: - - locations_google_channel_config - - eventarc - - 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 ---- - - - -## Overview - - - - -
Namelocations_google_channel_config
TypeResource
Idgoogle.eventarc.locations_google_channel_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Required. The resource name of the config. Must be in the format of, `projects/{project}/locations/{location}/googleChannelConfig`. | -| `cryptoKeyName` | `string` | Optional. Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt their event data. It must match the pattern `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | -| `updateTime` | `string` | Output only. The last-modified time. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_getGoogleChannelConfig` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/eventarc/operations/index.md b/docs/google-docs/providers/google/eventarc/operations/index.md index b31e97efcf..232096f69d 100644 --- a/docs/google-docs/providers/google/eventarc/operations/index.md +++ b/docs/google-docs/providers/google/eventarc/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/triggers/index.md b/docs/google-docs/providers/google/eventarc/triggers/index.md index 81ff217dce..5316606027 100644 --- a/docs/google-docs/providers/google/eventarc/triggers/index.md +++ b/docs/google-docs/providers/google/eventarc/triggers/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the trigger. Must be unique within the location of the project and must be in `projects/{project}/locations/{location}/triggers/{trigger}` format. | -| `destination` | `object` | Represents a target of an invocation over HTTP. | -| `eventDataContentType` | `string` | Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to `application/json` if the value is not defined. | -| `updateTime` | `string` | Output only. The last-modified time. | +| `channel` | `string` | Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. | +| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding. | | `labels` | `object` | Optional. User labels attached to the triggers that can be used to group resources. | +| `transport` | `object` | Represents the transport intermediaries created for the trigger to deliver events. | +| `updateTime` | `string` | Output only. The last-modified time. | | `eventFilters` | `array` | Required. Unordered list. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination. | -| `serviceAccount` | `string` | Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The `iam.serviceAccounts.actAs` permission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the [Roles and permissions](/eventarc/docs/all-roles-permissions) page specific to the trigger destination. | -| `channel` | `string` | Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners. | -| `conditions` | `object` | Output only. The reason(s) why a trigger is in FAILED state. | | `uid` | `string` | Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `eventDataContentType` | `string` | Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to `application/json` if the value is not defined. | +| `conditions` | `object` | Output only. The reason(s) why a trigger is in FAILED state. | +| `destination` | `object` | Represents a target of an invocation over HTTP. | +| `serviceAccount` | `string` | Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The `iam.serviceAccounts.actAs` permission must be granted on the service account to allow a principal to impersonate the service account. For more information, see the [Roles and permissions](/eventarc/docs/all-roles-permissions) page specific to the trigger destination. | | `createTime` | `string` | Output only. The creation time. | -| `transport` | `object` | Represents the transport intermediaries created for the trigger to deliver events. | -| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/triggers_iam_audit_configs/index.md b/docs/google-docs/providers/google/eventarc/triggers_iam_audit_configs/index.md deleted file mode 100644 index 2aeec083fe..0000000000 --- a/docs/google-docs/providers/google/eventarc/triggers_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: triggers_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - triggers_iam_audit_configs - - eventarc - - 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 ---- - - - -## Overview - - - - -
Nametriggers_iam_audit_configs
TypeResource
Idgoogle.eventarc.triggers_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_triggers_getIamPolicy` | `SELECT` | `locationsId, projectsId, triggersId` | diff --git a/docs/google-docs/providers/google/eventarc/triggers_iam_bindings/index.md b/docs/google-docs/providers/google/eventarc/triggers_iam_bindings/index.md deleted file mode 100644 index b2e764598a..0000000000 --- a/docs/google-docs/providers/google/eventarc/triggers_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: triggers_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - triggers_iam_bindings - - eventarc - - 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 ---- - - - -## Overview - - - - -
Nametriggers_iam_bindings
TypeResource
Idgoogle.eventarc.triggers_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_triggers_getIamPolicy` | `SELECT` | `locationsId, projectsId, triggersId` | diff --git a/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md b/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md index 6c5cb88a85..4643716cf8 100644 --- a/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md +++ b/docs/google-docs/providers/google/eventarc/triggers_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/fcm/index.md b/docs/google-docs/providers/google/fcm/index.md deleted file mode 100644 index db21d903a0..0000000000 --- a/docs/google-docs/providers/google/fcm/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: fcm -hide_title: false -hide_table_of_contents: false -keywords: - - fcm - - 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 ---- -FCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost. - -:::info Service Summary - -
-
-total resources: 1
-total selectable resources: 0
-total methods: 1
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.fcm
TypeService
TitleFirebase Cloud Messaging API
DescriptionFCM send API that provides a cross-platform messaging solution to reliably deliver messages at no cost.
Idfcm:v23.05.00145
- -## Resources -
-
-messages
-
-
-
-
diff --git a/docs/google-docs/providers/google/fcm/messages/index.md b/docs/google-docs/providers/google/fcm/messages/index.md deleted file mode 100644 index c3b48dcf7a..0000000000 --- a/docs/google-docs/providers/google/fcm/messages/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: messages -hide_title: false -hide_table_of_contents: false -keywords: - - messages - - fcm - - 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 ---- - - - -## Overview - - - - -
Namemessages
TypeResource
Idgoogle.fcm.messages
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_messages_send` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/fcmdata/delivery_data/index.md b/docs/google-docs/providers/google/fcmdata/delivery_data/index.md deleted file mode 100644 index b73ff29ff1..0000000000 --- a/docs/google-docs/providers/google/fcmdata/delivery_data/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: delivery_data -hide_title: false -hide_table_of_contents: false -keywords: - - delivery_data - - fcmdata - - 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 ---- - - - -## Overview - - - - -
Namedelivery_data
TypeResource
Idgoogle.fcmdata.delivery_data
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `androidDeliveryData` | `array` | The delivery data for the provided app. There will be one entry per combination of app, date, and analytics label. | -| `nextPageToken` | `string` | A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_androidApps_deliveryData_list` | `SELECT` | `androidAppsId, projectsId` | diff --git a/docs/google-docs/providers/google/fcmdata/index.md b/docs/google-docs/providers/google/fcmdata/index.md deleted file mode 100644 index ca45517b97..0000000000 --- a/docs/google-docs/providers/google/fcmdata/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: fcmdata -hide_title: false -hide_table_of_contents: false -keywords: - - fcmdata - - 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 ---- -Provides additional information about Firebase Cloud Messaging (FCM) message sends and deliveries. - -:::info Service Summary - -
-
-total resources: 1
-total selectable resources: 1
-total methods: 1
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.fcmdata
TypeService
TitleFirebase Cloud Messaging Data API
DescriptionProvides additional information about Firebase Cloud Messaging (FCM) message sends and deliveries.
Idfcmdata:v23.05.00145
- -## Resources -
-
-delivery_data
-
-
-
-
diff --git a/docs/google-docs/providers/google/file/backups/index.md b/docs/google-docs/providers/google/file/backups/index.md index a3abff35b0..8ca2774628 100644 --- a/docs/google-docs/providers/google/file/backups/index.md +++ b/docs/google-docs/providers/google/file/backups/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`. | | `description` | `string` | A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. | -| `labels` | `object` | Resource labels to represent user provided metadata. | -| `sourceInstanceTier` | `string` | Output only. The service tier of the source Filestore instance that this backup is created from. | | `storageBytes` | `string` | Output only. The size of the storage used by the backup. As backups share storage, this number is expected to change with backup creation/deletion. | -| `sourceInstance` | `string` | The resource name of the source Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. | -| `createTime` | `string` | Output only. The time when the backup was created. | -| `capacityGb` | `string` | Output only. Capacity of the source file share when the backup was created. | +| `state` | `string` | Output only. The backup state. | | `downloadBytes` | `string` | Output only. Amount of bytes that will be downloaded if the backup is restored. This may be different than storage bytes, since sequential backups of the same disk will share storage. | +| `sourceInstanceTier` | `string` | Output only. The service tier of the source Filestore instance that this backup is created from. | +| `capacityGb` | `string` | Output only. Capacity of the source file share when the backup was created. | +| `createTime` | `string` | Output only. The time when the backup was created. | +| `labels` | `object` | Resource labels to represent user provided metadata. | | `kmsKey` | `string` | Immutable. KMS key name used for data encryption. | -| `state` | `string` | Output only. The backup state. | | `sourceFileShare` | `string` | Name of the file share in the source Filestore instance that the backup is created from. | | `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `sourceInstance` | `string` | The resource name of the source Filestore instance, in the format `projects/{project_number}/locations/{location_id}/instances/{instance_id}`, used to create this backup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/file/instances/index.md b/docs/google-docs/providers/google/file/instances/index.md index eaea8aa4d1..88317c5ee0 100644 --- a/docs/google-docs/providers/google/file/instances/index.md +++ b/docs/google-docs/providers/google/file/instances/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the instance, in the format `projects/{project}/locations/{location}/instances/{instance}`. | | `description` | `string` | The description of the instance (2048 characters or less). | -| `suspensionReasons` | `array` | Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. | +| `createTime` | `string` | Output only. The time when the instance was created. | +| `statusMessage` | `string` | Output only. Additional information about the instance state, if available. | +| `state` | `string` | Output only. The instance state. | | `labels` | `object` | Resource labels to represent user provided metadata. | -| `networks` | `array` | VPC networks to which the instance is connected. For this version, only a single network is supported. | -| `fileShares` | `array` | File system shares on the instance. For this version, only a single file share is supported. | | `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `tier` | `string` | The service tier of the instance. | -| `state` | `string` | Output only. The instance state. | -| `statusMessage` | `string` | Output only. Additional information about the instance state, if available. | -| `kmsKeyName` | `string` | KMS key name used for data encryption. | +| `fileShares` | `array` | File system shares on the instance. For this version, only a single file share is supported. | | `etag` | `string` | Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. | -| `createTime` | `string` | Output only. The time when the instance was created. | +| `kmsKeyName` | `string` | KMS key name used for data encryption. | +| `networks` | `array` | VPC networks to which the instance is connected. For this version, only a single network is supported. | +| `suspensionReasons` | `array` | Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. | +| `tier` | `string` | The service tier of the instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/file/locations/index.md b/docs/google-docs/providers/google/file/locations/index.md index b148557288..01ae814343 100644 --- a/docs/google-docs/providers/google/file/locations/index.md +++ b/docs/google-docs/providers/google/file/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/file/operations/index.md b/docs/google-docs/providers/google/file/operations/index.md index 87a53a47ae..9e743f7113 100644 --- a/docs/google-docs/providers/google/file/operations/index.md +++ b/docs/google-docs/providers/google/file/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `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`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/firestore/backups/index.md b/docs/google-docs/providers/google/firestore/backups/index.md index 1fc05eceb0..34637ecc28 100644 --- a/docs/google-docs/providers/google/firestore/backups/index.md +++ b/docs/google-docs/providers/google/firestore/backups/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique resource name of the Backup. Format is `projects/{project}/locations/{location}/backups/{backup}`. | -| `stats` | `object` | Backup specific statistics. | -| `database` | `string` | Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`. | -| `databaseUid` | `string` | Output only. The system-generated UUID4 for the Firestore database that the backup is from. | | `expireTime` | `string` | Output only. The timestamp at which this backup expires. | | `snapshotTime` | `string` | Output only. The backup contains an externally consistent copy of the database at this time. | | `state` | `string` | Output only. The current state of the backup. | +| `stats` | `object` | Backup specific statistics. | +| `database` | `string` | Output only. Name of the Firestore database that the backup is from. Format is `projects/{project}/databases/{database}`. | +| `databaseUid` | `string` | Output only. The system-generated UUID4 for the Firestore database that the backup is from. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/firestore/documents/index.md b/docs/google-docs/providers/google/firestore/documents/index.md index dfdac28bac..f8b0854d3f 100644 --- a/docs/google-docs/providers/google/firestore/documents/index.md +++ b/docs/google-docs/providers/google/firestore/documents/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`. | +| `updateTime` | `string` | Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. | | `createTime` | `string` | Output only. The time at which the document was created. This value increases monotonically when a document is deleted then recreated. It can also be compared to values from other documents and the `read_time` of a query. | | `fields` | `object` | The document's fields. The map keys represent field names. A simple field name contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the regular expression `__.*__` are reserved. Reserved field names are forbidden except in certain documented contexts. The map keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be empty. Field paths may be used in other contexts to refer to structured fields defined here. For `map_value`, the field path is represented by the simple or quoted field names of the containing fields, delimited by `.`. For example, the structured field `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be represented by the field path `foo.x&y`. Within a field path, a quoted field name starts and ends with `` ` `` and may contain any character. Some characters, including `` ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y` and `` `bak\`tik` `` represents `` bak`tik ``. | -| `updateTime` | `string` | Output only. The time at which the document was last changed. This value is initially set to the `create_time` then increases monotonically with each change to the document. It can also be compared to values from other documents and the `read_time` of a query. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/firestore/documents_document/index.md b/docs/google-docs/providers/google/firestore/documents_document/index.md deleted file mode 100644 index 815f083b4d..0000000000 --- a/docs/google-docs/providers/google/firestore/documents_document/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: documents_document -hide_title: false -hide_table_of_contents: false -keywords: - - documents_document - - firestore - - 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 ---- - - - -## Overview - - - - -
Namedocuments_document
TypeResource
Idgoogle.firestore.documents_document
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `create_document` | `INSERT` | `collectionId, databasesId, documentsId, projectsId` | diff --git a/docs/google-docs/providers/google/firestore/documents_documents/index.md b/docs/google-docs/providers/google/firestore/documents_documents/index.md deleted file mode 100644 index f8b16a94a6..0000000000 --- a/docs/google-docs/providers/google/firestore/documents_documents/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: documents_documents -hide_title: false -hide_table_of_contents: false -keywords: - - documents_documents - - firestore - - 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 ---- - - - -## Overview - - - - -
Namedocuments_documents
TypeResource
Idgoogle.firestore.documents_documents
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `documents` | `array` | The Documents found. | -| `nextPageToken` | `string` | A token to retrieve the next page of documents. If this field is omitted, there are no subsequent pages. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `list_documents` | `SELECT` | `collectionId, databasesId, projectsId` | diff --git a/docs/google-docs/providers/google/firestore/documents_en/index.md b/docs/google-docs/providers/google/firestore/documents_en/index.md deleted file mode 100644 index 51e9449263..0000000000 --- a/docs/google-docs/providers/google/firestore/documents_en/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: documents_en -hide_title: false -hide_table_of_contents: false -keywords: - - documents_en - - firestore - - 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 ---- - - - -## Overview - - - - -
Namedocuments_en
TypeResource
Idgoogle.firestore.documents_en
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `listen` | `EXEC` | `databasesId, projectsId` | diff --git a/docs/google-docs/providers/google/firestore/indexes/index.md b/docs/google-docs/providers/google/firestore/indexes/index.md index bf67e51649..254f9fc596 100644 --- a/docs/google-docs/providers/google/firestore/indexes/index.md +++ b/docs/google-docs/providers/google/firestore/indexes/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. | -| `fields` | `array` | The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. | | `queryScope` | `string` | Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. | | `state` | `string` | Output only. The serving state of the index. | | `apiScope` | `string` | The API scope supported by this index. | +| `fields` | `array` | The fields supported by this index. For composite indexes, this requires a minimum of 2 and a maximum of 100 fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/firestore/locations/index.md b/docs/google-docs/providers/google/firestore/locations/index.md index 32c71d773c..4b36a8c377 100644 --- a/docs/google-docs/providers/google/firestore/locations/index.md +++ b/docs/google-docs/providers/google/firestore/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/firestore/operations/index.md b/docs/google-docs/providers/google/firestore/operations/index.md index b56635758b..ed9e8bcb46 100644 --- a/docs/google-docs/providers/google/firestore/operations/index.md +++ b/docs/google-docs/providers/google/firestore/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_audit_configs/index.md b/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_audit_configs/index.md deleted file mode 100644 index af6e428e0c..0000000000 --- a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: game_server_deployments_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - game_server_deployments_iam_audit_configs - - gameservices - - 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 ---- - - - -## Overview - - - - -
Namegame_server_deployments_iam_audit_configs
TypeResource
Idgoogle.gameservices.game_server_deployments_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_gameServerDeployments_getIamPolicy` | `SELECT` | `gameServerDeploymentsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_bindings/index.md b/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_bindings/index.md deleted file mode 100644 index 5e7235794d..0000000000 --- a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_bindings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: game_server_deployments_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - game_server_deployments_iam_bindings - - gameservices - - 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 ---- - - - -## Overview - - - - -
Namegame_server_deployments_iam_bindings
TypeResource
Idgoogle.gameservices.game_server_deployments_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `bindingId` | `string` | | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_gameServerDeployments_getIamPolicy` | `SELECT` | `gameServerDeploymentsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md b/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md index 733df98884..dfb175dc1d 100644 --- a/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md +++ b/docs/google-docs/providers/google/gameservices/game_server_deployments_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `rules` | `array` | If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gameservices/operations/index.md b/docs/google-docs/providers/google/gameservices/operations/index.md index 49add8347a..c6c6c1340a 100644 --- a/docs/google-docs/providers/google/gameservices/operations/index.md +++ b/docs/google-docs/providers/google/gameservices/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/genomics/index.md b/docs/google-docs/providers/google/genomics/index.md deleted file mode 100644 index e5abc9f9e3..0000000000 --- a/docs/google-docs/providers/google/genomics/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: genomics -hide_title: false -hide_table_of_contents: false -keywords: - - genomics - - 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 ---- -Uploads, processes, queries, and searches Genomics data in the cloud. - -:::info Service Summary - -
-
-total resources: 3
-total selectable resources: 1
-total methods: 6
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.genomics
TypeService
TitleGenomics API
DescriptionUploads, processes, queries, and searches Genomics data in the cloud.
Idgenomics:v23.05.00145
- -## Resources -
-
-operations
-pipelines
-
-
-workers
-
-
diff --git a/docs/google-docs/providers/google/genomics/operations/index.md b/docs/google-docs/providers/google/genomics/operations/index.md deleted file mode 100644 index d47373332b..0000000000 --- a/docs/google-docs/providers/google/genomics/operations/index.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: operations -hide_title: false -hide_table_of_contents: false -keywords: - - operations - - genomics - - 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 ---- - - - -## Overview - - - - -
Nameoperations
TypeResource
Idgoogle.genomics.operations
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` | -| `error` | `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). | -| `metadata` | `object` | An OperationMetadata or Metadata object. This will always be returned with the Operation. | -| `response` | `object` | An Empty object. | -| `done` | `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. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_operations_get` | `SELECT` | `operationsId, projectsId` | 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. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.get` | -| `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.list` | -| `projects_operations_cancel` | `EXEC` | `operationsId, projectsId` | Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation. Authorization requires the following [Google IAM](https://cloud.google.com/iam) permission: * `genomics.operations.cancel` | diff --git a/docs/google-docs/providers/google/genomics/pipelines/index.md b/docs/google-docs/providers/google/genomics/pipelines/index.md deleted file mode 100644 index 6ebd6e81cc..0000000000 --- a/docs/google-docs/providers/google/genomics/pipelines/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: pipelines -hide_title: false -hide_table_of_contents: false -keywords: - - pipelines - - genomics - - 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 ---- - - - -## Overview - - - - -
Namepipelines
TypeResource
Idgoogle.genomics.pipelines
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `run` | `EXEC` | | diff --git a/docs/google-docs/providers/google/genomics/workers/index.md b/docs/google-docs/providers/google/genomics/workers/index.md deleted file mode 100644 index eed18588d5..0000000000 --- a/docs/google-docs/providers/google/genomics/workers/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: workers -hide_title: false -hide_table_of_contents: false -keywords: - - workers - - genomics - - 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 ---- - - - -## Overview - - - - -
Nameworkers
TypeResource
Idgoogle.genomics.workers
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `checkIn` | `EXEC` | `id` | -| `projects_workers_checkIn` | `EXEC` | `projectsId, workersId` | diff --git a/docs/google-docs/providers/google/gkebackup/backup_plans/index.md b/docs/google-docs/providers/google/gkebackup/backup_plans/index.md index 4ce6176a9d..c4186ce7b3 100644 --- a/docs/google-docs/providers/google/gkebackup/backup_plans/index.md +++ b/docs/google-docs/providers/google/gkebackup/backup_plans/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*` | | `description` | `string` | Optional. User specified descriptive string for this BackupPlan. | -| `backupSchedule` | `object` | Defines scheduling parameters for automatically creating Backups via this BackupPlan. | -| `cluster` | `string` | Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | -| `createTime` | `string` | Output only. The timestamp when this BackupPlan resource was created. | | `deactivated` | `boolean` | Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False | | `labels` | `object` | Optional. A set of custom labels supplied by user. | +| `protectedPodCount` | `integer` | Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. | +| `backupConfig` | `object` | BackupConfig defines the configuration of Backups created via this BackupPlan. | +| `backupSchedule` | `object` | Defines scheduling parameters for automatically creating Backups via this BackupPlan. | +| `updateTime` | `string` | Output only. The timestamp when this BackupPlan resource was last updated. | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version of the resource. | +| `createTime` | `string` | Output only. The timestamp when this BackupPlan resource was created. | +| `cluster` | `string` | Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | | `state` | `string` | Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update | -| `stateReason` | `string` | Output only. Human-readable description of why BackupPlan is in the current `state` | | `retentionPolicy` | `object` | RetentionPolicy defines a Backup retention policy for a BackupPlan. | | `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | -| `backupConfig` | `object` | BackupConfig defines the configuration of Backups created via this BackupPlan. | -| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackupPlan`, and systems are expected to put that etag in the request to `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change will be applied to the same version of the resource. | -| `protectedPodCount` | `integer` | Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan. | -| `updateTime` | `string` | Output only. The timestamp when this BackupPlan resource was last updated. | +| `stateReason` | `string` | Output only. Human-readable description of why BackupPlan is in the current `state` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/backup_plans_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkebackup/backup_plans_iam_audit_configs/index.md deleted file mode 100644 index 2d716bd84a..0000000000 --- a/docs/google-docs/providers/google/gkebackup/backup_plans_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: backup_plans_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - backup_plans_iam_audit_configs - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namebackup_plans_iam_audit_configs
TypeResource
Idgoogle.gkebackup.backup_plans_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_backupPlans_getIamPolicy` | `SELECT` | `backupPlansId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkebackup/backup_plans_iam_bindings/index.md b/docs/google-docs/providers/google/gkebackup/backup_plans_iam_bindings/index.md deleted file mode 100644 index f24e1b99ac..0000000000 --- a/docs/google-docs/providers/google/gkebackup/backup_plans_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: backup_plans_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - backup_plans_iam_bindings - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namebackup_plans_iam_bindings
TypeResource
Idgoogle.gkebackup.backup_plans_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_backupPlans_getIamPolicy` | `SELECT` | `backupPlansId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkebackup/backups/index.md b/docs/google-docs/providers/google/gkebackup/backups/index.md index d5f9f559e9..2b8259c793 100644 --- a/docs/google-docs/providers/google/gkebackup/backups/index.md +++ b/docs/google-docs/providers/google/gkebackup/backups/index.md @@ -29,31 +29,31 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The fully qualified name of the Backup. `projects/*/locations/*/backupPlans/*/backups/*` | | `description` | `string` | Optional. User specified descriptive string for this Backup. | -| `manual` | `boolean` | Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually. | +| `resourceCount` | `integer` | Output only. The total number of Kubernetes resources included in the Backup. | +| `retainExpireTime` | `string` | Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days). | +| `state` | `string` | Output only. Current state of the Backup | +| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource. | +| `containsSecrets` | `boolean` | Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value. | +| `encryptionKey` | `object` | Defined a customer managed encryption key that will be used to encrypt Backup artifacts. | | `selectedApplications` | `object` | A list of namespaced Kubernetes resources. | +| `manual` | `boolean` | Output only. This flag indicates whether this Backup resource was created manually by a user or via a schedule in the BackupPlan. A value of True means that the Backup was created manually. | | `containsVolumeData` | `boolean` | Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value. | -| `encryptionKey` | `object` | Defined a customer managed encryption key that will be used to encrypt Backup artifacts. | -| `completeTime` | `string` | Output only. Completion time of the Backup | +| `deleteLockDays` | `integer` | Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update). | | `createTime` | `string` | Output only. The timestamp when this Backup resource was created. | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) | +| `selectedNamespaces` | `object` | A list of Kubernetes Namespaces | +| `allNamespaces` | `boolean` | Output only. If True, all namespaces were included in the Backup. | +| `volumeCount` | `integer` | Output only. The total number of volume backups contained in the Backup. | +| `clusterMetadata` | `object` | Information about the GKE cluster from which this Backup was created. | | `configBackupSizeBytes` | `string` | Output only. The size of the config backup in bytes. | | `stateReason` | `string` | Output only. Human-readable description of why the backup is in the current `state`. | -| `retainExpireTime` | `string` | Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days). | -| `deleteLockDays` | `integer` | Optional. Minimum age for this Backup (in days). If this field is set to a non-zero value, the Backup will be "locked" against deletion (either manual or automatic deletion) for the number of days provided (measured from the creation time of the Backup). MUST be an integer value between 0-90 (inclusive). Defaults to parent BackupPlan's backup_delete_lock_days setting and may only be increased (either at creation time or in a subsequent update). | -| `clusterMetadata` | `object` | Information about the GKE cluster from which this Backup was created. | -| `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform backup updates in order to avoid race conditions: An `etag` is returned in the response to `GetBackup`, and systems are expected to put that etag in the request to `UpdateBackup` or `DeleteBackup` to ensure that their change will be applied to the same version of the resource. | -| `resourceCount` | `integer` | Output only. The total number of Kubernetes resources included in the Backup. | | `deleteLockExpireTime` | `string` | Output only. The time at which an existing delete lock will expire for this backup (calculated from create_time + delete_lock_days). | | `retainDays` | `integer` | Optional. The age (in days) after which this Backup will be automatically deleted. Must be an integer value >= 0: - If 0, no automatic deletion will occur for this Backup. - If not 0, this must be >= delete_lock_days and <= 365. Once a Backup is created, this value may only be increased. Defaults to the parent BackupPlan's backup_retain_days value. | +| `completeTime` | `string` | Output only. Completion time of the Backup | | `labels` | `object` | Optional. A set of custom labels supplied by user. | -| `sizeBytes` | `string` | Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes) | -| `allNamespaces` | `boolean` | Output only. If True, all namespaces were included in the Backup. | | `podCount` | `integer` | Output only. The total number of Kubernetes Pods contained in the Backup. | -| `containsSecrets` | `boolean` | Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value. | -| `volumeCount` | `integer` | Output only. The total number of volume backups contained in the Backup. | +| `sizeBytes` | `string` | Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes) | | `updateTime` | `string` | Output only. The timestamp when this Backup resource was last updated. | -| `state` | `string` | Output only. Current state of the Backup | -| `selectedNamespaces` | `object` | A list of Kubernetes Namespaces | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/backups_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkebackup/backups_iam_audit_configs/index.md deleted file mode 100644 index 721dfb3c0f..0000000000 --- a/docs/google-docs/providers/google/gkebackup/backups_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: backups_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_audit_configs - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_audit_configs
TypeResource
Idgoogle.gkebackup.backups_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_backupPlans_backups_getIamPolicy` | `SELECT` | `backupPlansId, backupsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkebackup/backups_iam_bindings/index.md b/docs/google-docs/providers/google/gkebackup/backups_iam_bindings/index.md deleted file mode 100644 index 139de3077f..0000000000 --- a/docs/google-docs/providers/google/gkebackup/backups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: backups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_bindings - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_bindings
TypeResource
Idgoogle.gkebackup.backups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_backupPlans_backups_getIamPolicy` | `SELECT` | `backupPlansId, backupsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkebackup/locations/index.md b/docs/google-docs/providers/google/gkebackup/locations/index.md index c6e8a718a9..0cce4d7156 100644 --- a/docs/google-docs/providers/google/gkebackup/locations/index.md +++ b/docs/google-docs/providers/google/gkebackup/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/locations_operations/index.md b/docs/google-docs/providers/google/gkebackup/locations_operations/index.md deleted file mode 100644 index 935de8c1ed..0000000000 --- a/docs/google-docs/providers/google/gkebackup/locations_operations/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: locations_operations -hide_title: false -hide_table_of_contents: false -keywords: - - locations_operations - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namelocations_operations
TypeResource
Idgoogle.gkebackup.locations_operations
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_deleteOperations` | `DELETE` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkebackup/operations/index.md b/docs/google-docs/providers/google/gkebackup/operations/index.md index 504073e01e..3751d86437 100644 --- a/docs/google-docs/providers/google/gkebackup/operations/index.md +++ b/docs/google-docs/providers/google/gkebackup/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/restore_plans/index.md b/docs/google-docs/providers/google/gkebackup/restore_plans/index.md index cac63adf16..d6c277a5c2 100644 --- a/docs/google-docs/providers/google/gkebackup/restore_plans/index.md +++ b/docs/google-docs/providers/google/gkebackup/restore_plans/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`. | | `description` | `string` | Optional. User specified descriptive string for this RestorePlan. | +| `updateTime` | `string` | Output only. The timestamp when this RestorePlan resource was last updated. | | `stateReason` | `string` | Output only. Human-readable description of why RestorePlan is in the current `state` | | `backupPlan` | `string` | Required. Immutable. A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/*/locations/*/backupPlans/*`. | -| `updateTime` | `string` | Output only. The timestamp when this RestorePlan resource was last updated. | -| `cluster` | `string` | Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | | `createTime` | `string` | Output only. The timestamp when this RestorePlan resource was created. | | `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `cluster` | `string` | Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | | `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlan`, and systems are expected to put that etag in the request to `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change will be applied to the same version of the resource. | | `labels` | `object` | Optional. A set of custom labels supplied by user. | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | | `state` | `string` | Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkebackup/restore_plans_iam_audit_configs/index.md deleted file mode 100644 index 2ae979381c..0000000000 --- a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: restore_plans_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - restore_plans_iam_audit_configs - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namerestore_plans_iam_audit_configs
TypeResource
Idgoogle.gkebackup.restore_plans_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_restorePlans_getIamPolicy` | `SELECT` | `locationsId, projectsId, restorePlansId` | diff --git a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_bindings/index.md b/docs/google-docs/providers/google/gkebackup/restore_plans_iam_bindings/index.md deleted file mode 100644 index 27b13b9cac..0000000000 --- a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: restore_plans_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - restore_plans_iam_bindings - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namerestore_plans_iam_bindings
TypeResource
Idgoogle.gkebackup.restore_plans_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_restorePlans_getIamPolicy` | `SELECT` | `locationsId, projectsId, restorePlansId` | diff --git a/docs/google-docs/providers/google/gkebackup/restores/index.md b/docs/google-docs/providers/google/gkebackup/restores/index.md index 3aa9e55a33..7df17a6327 100644 --- a/docs/google-docs/providers/google/gkebackup/restores/index.md +++ b/docs/google-docs/providers/google/gkebackup/restores/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The full name of the Restore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*` | | `description` | `string` | User specified descriptive string for this Restore. | +| `cluster` | `string` | Output only. The target cluster into which this Restore will restore data. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` Inherited from parent RestorePlan's cluster value. | | `resourcesFailedCount` | `integer` | Output only. Number of resources that failed to be restored during the restore execution. | -| `completeTime` | `string` | Output only. Timestamp of when the restore operation completed. | -| `state` | `string` | Output only. The current state of the Restore. | -| `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `createTime` | `string` | Output only. The timestamp when this Restore resource was created. | | `stateReason` | `string` | Output only. Human-readable description of why the Restore is in its current state. | -| `cluster` | `string` | Output only. The target cluster into which this Restore will restore data. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` Inherited from parent RestorePlan's cluster value. | -| `backup` | `string` | Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: `projects/*/locations/*/backupPlans/*/backups/*`. | -| `updateTime` | `string` | Output only. The timestamp when this Restore resource was last updated. | | `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestore`, and systems are expected to put that etag in the request to `UpdateRestore` or `DeleteRestore` to ensure that their change will be applied to the same version of the resource. | -| `labels` | `object` | A set of custom labels supplied by user. | -| `volumesRestoredCount` | `integer` | Output only. Number of volumes restored during the restore execution. | -| `createTime` | `string` | Output only. The timestamp when this Restore resource was created. | | `resourcesExcludedCount` | `integer` | Output only. Number of resources excluded during the restore execution. | +| `volumesRestoredCount` | `integer` | Output only. Number of volumes restored during the restore execution. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `completeTime` | `string` | Output only. Timestamp of when the restore operation completed. | +| `labels` | `object` | A set of custom labels supplied by user. | +| `updateTime` | `string` | Output only. The timestamp when this Restore resource was last updated. | +| `state` | `string` | Output only. The current state of the Restore. | +| `backup` | `string` | Required. Immutable. A reference to the Backup used as the source from which this Restore will restore. Note that this Backup must be a sub-resource of the RestorePlan's backup_plan. Format: `projects/*/locations/*/backupPlans/*/backups/*`. | +| `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | | `resourcesRestoredCount` | `integer` | Output only. Number of resources restored during the restore execution. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/gkebackup/restores_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkebackup/restores_iam_audit_configs/index.md deleted file mode 100644 index 77ae8d9b09..0000000000 --- a/docs/google-docs/providers/google/gkebackup/restores_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: restores_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - restores_iam_audit_configs - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namerestores_iam_audit_configs
TypeResource
Idgoogle.gkebackup.restores_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_restorePlans_restores_getIamPolicy` | `SELECT` | `locationsId, projectsId, restorePlansId, restoresId` | diff --git a/docs/google-docs/providers/google/gkebackup/restores_iam_bindings/index.md b/docs/google-docs/providers/google/gkebackup/restores_iam_bindings/index.md deleted file mode 100644 index 6f0046d189..0000000000 --- a/docs/google-docs/providers/google/gkebackup/restores_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: restores_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - restores_iam_bindings - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namerestores_iam_bindings
TypeResource
Idgoogle.gkebackup.restores_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_restorePlans_restores_getIamPolicy` | `SELECT` | `locationsId, projectsId, restorePlansId, restoresId` | diff --git a/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md index 33306f4fac..29103d5a77 100644 --- a/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/restores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/volume_backups/index.md b/docs/google-docs/providers/google/gkebackup/volume_backups/index.md index 3830b20888..6a6b53b838 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_backups/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_backups/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The full name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`. | | `sourcePvc` | `object` | A reference to a namespaced resource in Kubernetes. | -| `format` | `string` | Output only. The format used for the volume backup. | | `volumeBackupHandle` | `string` | Output only. A storage system-specific opaque handle to the underlying volume backup. | +| `completeTime` | `string` | Output only. The timestamp when the associated underlying volume backup operation completed. | +| `state` | `string` | Output only. The current state of this VolumeBackup. | +| `storageBytes` | `string` | Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted. | +| `createTime` | `string` | Output only. The timestamp when this VolumeBackup resource was created. | | `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions. | | `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeBackup is in its current state. | -| `storageBytes` | `string` | Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted. | | `updateTime` | `string` | Output only. The timestamp when this VolumeBackup resource was last updated. | -| `completeTime` | `string` | Output only. The timestamp when the associated underlying volume backup operation completed. | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | -| `createTime` | `string` | Output only. The timestamp when this VolumeBackup resource was created. | -| `state` | `string` | Output only. The current state of this VolumeBackup. | | `diskSizeBytes` | `string` | Output only. The minimum size of the disk to which this VolumeBackup can be restored. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `format` | `string` | Output only. The format used for the volume backup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkebackup/volume_backups_iam_audit_configs/index.md deleted file mode 100644 index e116039a13..0000000000 --- a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: volume_backups_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - volume_backups_iam_audit_configs - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namevolume_backups_iam_audit_configs
TypeResource
Idgoogle.gkebackup.volume_backups_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_backupPlans_backups_volumeBackups_getIamPolicy` | `SELECT` | `backupPlansId, backupsId, locationsId, projectsId, volumeBackupsId` | diff --git a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_bindings/index.md b/docs/google-docs/providers/google/gkebackup/volume_backups_iam_bindings/index.md deleted file mode 100644 index 2c7318d65e..0000000000 --- a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: volume_backups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - volume_backups_iam_bindings - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namevolume_backups_iam_bindings
TypeResource
Idgoogle.gkebackup.volume_backups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_backupPlans_backups_volumeBackups_getIamPolicy` | `SELECT` | `backupPlansId, backupsId, locationsId, projectsId, volumeBackupsId` | diff --git a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md index 9932435056..1fe6b44d60 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_backups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/volume_restores/index.md b/docs/google-docs/providers/google/gkebackup/volume_restores/index.md index dd2b5a63b3..89ed5b1df3 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_restores/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_restores/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*` | | `volumeHandle` | `string` | Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup. | -| `state` | `string` | Output only. The current state of this VolumeRestore. | -| `updateTime` | `string` | Output only. The timestamp when this VolumeRestore resource was last updated. | -| `volumeBackup` | `string` | Output only. The full name of the VolumeBackup from which the volume will be restored. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`. | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | -| `volumeType` | `string` | Output only. The type of volume provisioned | | `etag` | `string` | Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform volume restore updates in order to avoid race conditions. | -| `createTime` | `string` | Output only. The timestamp when this VolumeRestore resource was created. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | | `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeRestore is in its current state. | -| `completeTime` | `string` | Output only. The timestamp when the associated underlying volume restoration completed. | | `targetPvc` | `object` | A reference to a namespaced resource in Kubernetes. | +| `volumeBackup` | `string` | Output only. The full name of the VolumeBackup from which the volume will be restored. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`. | +| `volumeType` | `string` | Output only. The type of volume provisioned | +| `updateTime` | `string` | Output only. The timestamp when this VolumeRestore resource was last updated. | +| `completeTime` | `string` | Output only. The timestamp when the associated underlying volume restoration completed. | +| `createTime` | `string` | Output only. The timestamp when this VolumeRestore resource was created. | +| `state` | `string` | Output only. The current state of this VolumeRestore. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkebackup/volume_restores_iam_audit_configs/index.md deleted file mode 100644 index 5a30560014..0000000000 --- a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: volume_restores_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - volume_restores_iam_audit_configs - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namevolume_restores_iam_audit_configs
TypeResource
Idgoogle.gkebackup.volume_restores_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_restorePlans_restores_volumeRestores_getIamPolicy` | `SELECT` | `locationsId, projectsId, restorePlansId, restoresId, volumeRestoresId` | diff --git a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_bindings/index.md b/docs/google-docs/providers/google/gkebackup/volume_restores_iam_bindings/index.md deleted file mode 100644 index 4c0aeed6ce..0000000000 --- a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: volume_restores_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - volume_restores_iam_bindings - - gkebackup - - 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 ---- - - - -## Overview - - - - -
Namevolume_restores_iam_bindings
TypeResource
Idgoogle.gkebackup.volume_restores_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_restorePlans_restores_volumeRestores_getIamPolicy` | `SELECT` | `locationsId, projectsId, restorePlansId, restoresId, volumeRestoresId` | diff --git a/docs/google-docs/providers/google/gkehub/bindings/index.md b/docs/google-docs/providers/google/gkehub/bindings/index.md index 3be02c332e..a30a210552 100644 --- a/docs/google-docs/providers/google/gkehub/bindings/index.md +++ b/docs/google-docs/providers/google/gkehub/bindings/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the membershipbinding itself `projects/{project}/locations/{location}/memberships/{membership}/bindings/{membershipbinding}` | -| `createTime` | `string` | Output only. When the membership binding was created. | -| `scope` | `string` | A Scope resource name in the format `projects/*/locations/*/scopes/*`. | -| `state` | `object` | MembershipBindingLifecycleState describes the state of a Binding resource. | -| `labels` | `object` | Optional. Labels for this MembershipBinding. | -| `fleet` | `boolean` | Whether the membershipbinding is Fleet-wide; true means that this Membership should be bound to all Namespaces in this entire Fleet. | | `deleteTime` | `string` | Output only. When the membership binding was deleted. | +| `fleet` | `boolean` | Whether the membershipbinding is Fleet-wide; true means that this Membership should be bound to all Namespaces in this entire Fleet. | | `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all membershipbinding resources. If a membershipbinding resource is deleted and another resource with the same name is created, it gets a different uid. | +| `createTime` | `string` | Output only. When the membership binding was created. | | `updateTime` | `string` | Output only. When the membership binding was last updated. | +| `labels` | `object` | Optional. Labels for this MembershipBinding. | +| `state` | `object` | MembershipBindingLifecycleState describes the state of a Binding resource. | +| `scope` | `string` | A Scope resource name in the format `projects/*/locations/*/scopes/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/features/index.md b/docs/google-docs/providers/google/gkehub/features/index.md index 0d869c20f4..5d9a0083e1 100644 --- a/docs/google-docs/providers/google/gkehub/features/index.md +++ b/docs/google-docs/providers/google/gkehub/features/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The full, unique name of this Feature resource in the format `projects/*/locations/*/features/*`. | +| `scopeSpecs` | `object` | Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. | +| `deleteTime` | `string` | Output only. When the Feature resource was deleted. | +| `state` | `object` | CommonFeatureState contains Hub-wide Feature status information. | +| `createTime` | `string` | Output only. When the Feature resource was created. | +| `spec` | `object` | CommonFeatureSpec contains Hub-wide configuration information | +| `scopeStates` | `object` | Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. | | `membershipStates` | `object` | Output only. Membership-specific Feature status. If this Feature does report any per-Membership status, this field may be unused. The keys indicate which Membership the state is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project number, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} MUST match the Feature's project number. | | `resourceState` | `object` | FeatureResourceState describes the state of a Feature *resource* in the GkeHub API. See `FeatureState` for the "running state" of the Feature in the Hub and across Memberships. | -| `spec` | `object` | CommonFeatureSpec contains Hub-wide configuration information | -| `membershipSpecs` | `object` | Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. | | `fleetDefaultMemberConfig` | `object` | CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet | -| `createTime` | `string` | Output only. When the Feature resource was created. | -| `deleteTime` | `string` | Output only. When the Feature resource was deleted. | -| `state` | `object` | CommonFeatureState contains Hub-wide Feature status information. | | `labels` | `object` | Labels for this Feature. | -| `scopeSpecs` | `object` | Optional. Scope-specific configuration for this Feature. If this Feature does not support any per-Scope configuration, this field may be unused. The keys indicate which Scope the configuration is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Scope is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. | +| `membershipSpecs` | `object` | Optional. Membership-specific configuration for this Feature. If this Feature does not support any per-Membership configuration, this field may be unused. The keys indicate which Membership the configuration is for, in the form: `projects/{p}/locations/{l}/memberships/{m}` Where {p} is the project, {l} is a valid location and {m} is a valid Membership in this project at that location. {p} WILL match the Feature's project. {p} will always be returned as the project number, but the project ID is also accepted during input. If the same Membership is specified in the map twice (using the project ID form, and the project number form), exactly ONE of the entries will be saved, with no guarantees as to which. For this reason, it is recommended the same format be used for all entries when mutating a Feature. | | `updateTime` | `string` | Output only. When the Feature resource was last updated. | -| `scopeStates` | `object` | Output only. Scope-specific Feature status. If this Feature does report any per-Scope status, this field may be unused. The keys indicate which Scope the state is for, in the form: `projects/{p}/locations/global/scopes/{s}` Where {p} is the project, {s} is a valid Scope in this project. {p} WILL match the Feature's project. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/features_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkehub/features_iam_audit_configs/index.md deleted file mode 100644 index 107af10ba9..0000000000 --- a/docs/google-docs/providers/google/gkehub/features_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: features_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - features_iam_audit_configs - - gkehub - - 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 ---- - - - -## Overview - - - - -
Namefeatures_iam_audit_configs
TypeResource
Idgoogle.gkehub.features_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_features_getIamPolicy` | `SELECT` | `featuresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkehub/features_iam_bindings/index.md b/docs/google-docs/providers/google/gkehub/features_iam_bindings/index.md deleted file mode 100644 index e35900ad88..0000000000 --- a/docs/google-docs/providers/google/gkehub/features_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: features_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - features_iam_bindings - - gkehub - - 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 ---- - - - -## Overview - - - - -
Namefeatures_iam_bindings
TypeResource
Idgoogle.gkehub.features_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_features_getIamPolicy` | `SELECT` | `featuresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md b/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md index 6afdc3efba..fb03f45646 100644 --- a/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkehub/features_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/fleets/index.md b/docs/google-docs/providers/google/gkehub/fleets/index.md index 8933c5fe07..22d25c0747 100644 --- a/docs/google-docs/providers/google/gkehub/fleets/index.md +++ b/docs/google-docs/providers/google/gkehub/fleets/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The full, unique resource name of this fleet in the format of `projects/{project}/locations/{location}/fleets/{fleet}`. Each Google Cloud project can have at most one fleet resource, named "default". | -| `labels` | `object` | Optional. Labels for this Fleet. | | `state` | `object` | FleetLifecycleState describes the state of a Fleet resource. | | `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all Fleet resources. If a Fleet resource is deleted and another resource with the same name is created, it gets a different uid. | | `updateTime` | `string` | Output only. When the Fleet was last updated. | | `createTime` | `string` | Output only. When the Fleet was created. | | `deleteTime` | `string` | Output only. When the Fleet was deleted. | | `displayName` | `string` | Optional. A user-assigned display name of the Fleet. When present, it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: `Production Fleet` | +| `labels` | `object` | Optional. Labels for this Fleet. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/locations/index.md b/docs/google-docs/providers/google/gkehub/locations/index.md index db4abe5b19..464f64ed93 100644 --- a/docs/google-docs/providers/google/gkehub/locations/index.md +++ b/docs/google-docs/providers/google/gkehub/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/memberships_iam_audit_configs/index.md b/docs/google-docs/providers/google/gkehub/memberships_iam_audit_configs/index.md deleted file mode 100644 index 714e8ef68c..0000000000 --- a/docs/google-docs/providers/google/gkehub/memberships_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: memberships_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - memberships_iam_audit_configs - - gkehub - - 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 ---- - - - -## Overview - - - - -
Namememberships_iam_audit_configs
TypeResource
Idgoogle.gkehub.memberships_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_memberships_getIamPolicy` | `SELECT` | `locationsId, membershipsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkehub/memberships_iam_bindings/index.md b/docs/google-docs/providers/google/gkehub/memberships_iam_bindings/index.md deleted file mode 100644 index 108d21658b..0000000000 --- a/docs/google-docs/providers/google/gkehub/memberships_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: memberships_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - memberships_iam_bindings - - gkehub - - 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 ---- - - - -## Overview - - - - -
Namememberships_iam_bindings
TypeResource
Idgoogle.gkehub.memberships_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_memberships_getIamPolicy` | `SELECT` | `locationsId, membershipsId, projectsId` | diff --git a/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md b/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md index 7ec9d8f11e..d96b3cd18a 100644 --- a/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkehub/memberships_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/namespaces/index.md b/docs/google-docs/providers/google/gkehub/namespaces/index.md index 67cffa032a..3a4c91a78a 100644 --- a/docs/google-docs/providers/google/gkehub/namespaces/index.md +++ b/docs/google-docs/providers/google/gkehub/namespaces/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the namespace `projects/{project}/locations/{location}/namespaces/{namespace}` | -| `scope` | `string` | Required. Scope associated with the namespace | -| `createTime` | `string` | Output only. When the namespace was created. | -| `deleteTime` | `string` | Output only. When the namespace was deleted. | | `state` | `object` | NamespaceLifecycleState describes the state of a Namespace resource. | -| `updateTime` | `string` | Output only. When the namespace was last updated. | -| `namespaceLabels` | `object` | Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant. | | `labels` | `object` | Optional. Labels for this Namespace. | +| `namespaceLabels` | `object` | Optional. Namespace-level cluster namespace labels. These labels are applied to the related namespace of the member clusters bound to the parent Scope. Scope-level labels (`namespace_labels` in the Fleet Scope resource) take precedence over Namespace-level labels if they share a key. Keys and values must be Kubernetes-conformant. | +| `updateTime` | `string` | Output only. When the namespace was last updated. | +| `createTime` | `string` | Output only. When the namespace was created. | | `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all namespace resources. If a namespace resource is deleted and another resource with the same name is created, it gets a different uid. | +| `deleteTime` | `string` | Output only. When the namespace was deleted. | +| `scope` | `string` | Required. Scope associated with the namespace | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/operations/index.md b/docs/google-docs/providers/google/gkehub/operations/index.md index 05e59828a3..4c27c6ec0a 100644 --- a/docs/google-docs/providers/google/gkehub/operations/index.md +++ b/docs/google-docs/providers/google/gkehub/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md b/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md index daa87a45fd..c1d33a163c 100644 --- a/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md +++ b/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the rbacrolebinding `projects/{project}/locations/{location}/namespaces/{namespace}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}` | -| `labels` | `object` | Optional. Labels for this RBACRolebinding. | -| `createTime` | `string` | Output only. When the rbacrolebinding was created. | -| `updateTime` | `string` | Output only. When the rbacrolebinding was last updated. | -| `group` | `string` | group is the group, as seen by the kubernetes cluster. | | `state` | `object` | RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. | -| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid. | -| `role` | `object` | Role is the type for Kubernetes roles | +| `updateTime` | `string` | Output only. When the rbacrolebinding was last updated. | | `user` | `string` | user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld" | +| `createTime` | `string` | Output only. When the rbacrolebinding was created. | +| `role` | `object` | Role is the type for Kubernetes roles | +| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid. | +| `labels` | `object` | Optional. Labels for this RBACRolebinding. | | `deleteTime` | `string` | Output only. When the rbacrolebinding was deleted. | +| `group` | `string` | group is the group, as seen by the kubernetes cluster. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/scopes/index.md b/docs/google-docs/providers/google/gkehub/scopes/index.md index 2bfebc0bbf..e863d31946 100644 --- a/docs/google-docs/providers/google/gkehub/scopes/index.md +++ b/docs/google-docs/providers/google/gkehub/scopes/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the scope `projects/{project}/locations/{location}/scopes/{scope}` | -| `allMemberships` | `boolean` | If true, all Memberships in the Fleet bind to this Scope. | | `createTime` | `string` | Output only. When the scope was created. | -| `state` | `object` | ScopeLifecycleState describes the state of a Scope resource. | -| `labels` | `object` | Optional. Labels for this Scope. | +| `allMemberships` | `boolean` | If true, all Memberships in the Fleet bind to this Scope. | | `deleteTime` | `string` | Output only. When the scope was deleted. | +| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid. | | `updateTime` | `string` | Output only. When the scope was last updated. | | `namespaceLabels` | `object` | Optional. Scope-level cluster namespace labels. For the member clusters bound to the Scope, these labels are applied to each namespace under the Scope. Scope-level labels take precedence over Namespace-level labels (`namespace_labels` in the Fleet Namespace resource) if they share a key. Keys and values must be Kubernetes-conformant. | -| `uid` | `string` | Output only. Google-generated UUID for this resource. This is unique across all scope resources. If a scope resource is deleted and another resource with the same name is created, it gets a different uid. | +| `state` | `object` | ScopeLifecycleState describes the state of a Scope resource. | +| `labels` | `object` | Optional. Labels for this Scope. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/scopes_iam_policies/index.md b/docs/google-docs/providers/google/gkehub/scopes_iam_policies/index.md index f6a0993081..7373a8607c 100644 --- a/docs/google-docs/providers/google/gkehub/scopes_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkehub/scopes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md index 91a34a1fc8..8e39f9155f 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters/index.md @@ -29,32 +29,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The bare metal admin cluster resource name. | | `description` | `string` | A human readable description of this bare metal admin cluster. | -| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | -| `updateTime` | `string` | Output only. The time at which this bare metal admin cluster was last updated. | -| `clusterOperations` | `object` | BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure. | -| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal admin cluster. | | `maintenanceStatus` | `object` | BareMetalAdminMaintenanceStatus represents the maintenance status for bare metal Admin cluster CR's nodes. | +| `securityConfig` | `object` | Specifies the security related settings for the bare metal admin cluster. | +| `nodeConfig` | `object` | BareMetalAdminWorkloadNodeConfig specifies the workload node configurations. | +| `loadBalancer` | `object` | BareMetalAdminLoadBalancerConfig specifies the load balancer configuration. | +| `storage` | `object` | BareMetalAdminStorageConfig specifies the cluster storage configuration. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | | `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal Admin Cluster. | -| `controlPlane` | `object` | BareMetalAdminControlPlaneConfig specifies the control plane configuration. | -| `uid` | `string` | Output only. The unique identifier of the bare metal admin cluster. | -| `bareMetalVersion` | `string` | The Anthos clusters on bare metal version for the bare metal admin cluster. | +| `deleteTime` | `string` | Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty | | `localName` | `string` | Output only. The object name of the bare metal cluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | +| `clusterOperations` | `object` | BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure. | +| `bareMetalVersion` | `string` | The Anthos clusters on bare metal version for the bare metal admin cluster. | +| `createTime` | `string` | Output only. The time at which this bare metal admin cluster was created. | | `endpoint` | `string` | Output only. The IP address name of bare metal admin cluster's API server. | -| `deleteTime` | `string` | Output only. The time at which this bare metal admin cluster was deleted. If the resource is not deleted, this must be empty | +| `annotations` | `object` | Annotations on the bare metal admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `updateTime` | `string` | Output only. The time at which this bare metal admin cluster was last updated. | +| `uid` | `string` | Output only. The unique identifier of the bare metal admin cluster. | | `networkConfig` | `object` | BareMetalAdminNetworkConfig specifies the cluster network configuration. | -| `nodeConfig` | `object` | BareMetalAdminWorkloadNodeConfig specifies the workload node configurations. | -| `proxy` | `object` | BareMetalAdminProxyConfig specifies the cluster proxy configuration. | +| `osEnvironmentConfig` | `object` | Specifies operating system operation settings for cluster provisioning. | +| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal admin cluster. | | `maintenanceConfig` | `object` | BareMetalAdminMaintenanceConfig specifies configurations to put bare metal Admin cluster CRs nodes in and out of maintenance. | | `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `controlPlane` | `object` | BareMetalAdminControlPlaneConfig specifies the control plane configuration. | | `state` | `string` | Output only. The current state of the bare metal admin cluster. | -| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | -| `createTime` | `string` | Output only. The time at which this bare metal admin cluster was created. | -| `annotations` | `object` | Annotations on the bare metal admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | -| `loadBalancer` | `object` | BareMetalAdminLoadBalancerConfig specifies the load balancer configuration. | -| `securityConfig` | `object` | Specifies the security related settings for the bare metal admin cluster. | -| `storage` | `object` | BareMetalAdminStorageConfig specifies the cluster storage configuration. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | -| `osEnvironmentConfig` | `object` | Specifies operating system operation settings for cluster provisioning. | +| `proxy` | `object` | BareMetalAdminProxyConfig specifies the cluster proxy configuration. | +| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md index 7ad1a88735..609e479e5f 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters/index.md @@ -29,34 +29,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The bare metal user cluster resource name. | | `description` | `string` | A human readable description of this bare metal user cluster. | -| `createTime` | `string` | Output only. The time when the bare metal user cluster was created. | | `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal user cluster. | -| `maintenanceStatus` | `object` | Represents the maintenance status of the bare metal user cluster. | -| `osEnvironmentConfig` | `object` | Specifies operating system settings for cluster provisioning. | -| `adminClusterName` | `string` | Output only. The resource name of the bare metal admin cluster managing this user cluster. | -| `endpoint` | `string` | Output only. The IP address of the bare metal user cluster's API server. | -| `state` | `string` | Output only. The current state of the bare metal user cluster. | -| `localName` | `string` | Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the name in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl. | -| `bareMetalVersion` | `string` | Required. The Anthos clusters on bare metal version for your user cluster. | -| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | -| `annotations` | `object` | Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `securityConfig` | `object` | Specifies the security related settings for the bare metal user cluster. | +| `adminClusterMembership` | `string` | Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. | | `deleteTime` | `string` | Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty | -| `nodeConfig` | `object` | Specifies the workload node configurations. | -| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal user cluster. | +| `uid` | `string` | Output only. The unique identifier of the bare metal user cluster. | | `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `etag` | `string` | Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `maintenanceStatus` | `object` | Represents the maintenance status of the bare metal user cluster. | | `storage` | `object` | BareMetalStorageConfig specifies the cluster storage configuration. | -| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | | `networkConfig` | `object` | Specifies the cluster network configuration. | -| `securityConfig` | `object` | Specifies the security related settings for the bare metal user cluster. | -| `proxy` | `object` | Specifies the cluster proxy configuration. | -| `clusterOperations` | `object` | Specifies the bare metal user cluster's observability infrastructure. | -| `upgradePolicy` | `object` | BareMetalClusterUpgradePolicy defines the cluster upgrade policy. | -| `controlPlane` | `object` | Specifies the control plane configuration. | -| `adminClusterMembership` | `string` | Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. | +| `annotations` | `object` | Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | +| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal user cluster. | +| `state` | `string` | Output only. The current state of the bare metal user cluster. | +| `endpoint` | `string` | Output only. The IP address of the bare metal user cluster's API server. | +| `adminClusterName` | `string` | Output only. The resource name of the bare metal admin cluster managing this user cluster. | | `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | -| `updateTime` | `string` | Output only. The time when the bare metal user cluster was last updated. | -| `uid` | `string` | Output only. The unique identifier of the bare metal user cluster. | | `loadBalancer` | `object` | Specifies the load balancer configuration. | +| `bareMetalVersion` | `string` | Required. The Anthos clusters on bare metal version for your user cluster. | +| `upgradePolicy` | `object` | BareMetalClusterUpgradePolicy defines the cluster upgrade policy. | +| `createTime` | `string` | Output only. The time when the bare metal user cluster was created. | +| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | +| `osEnvironmentConfig` | `object` | Specifies operating system settings for cluster provisioning. | +| `updateTime` | `string` | Output only. The time when the bare metal user cluster was last updated. | +| `nodeConfig` | `object` | Specifies the workload node configurations. | +| `controlPlane` | `object` | Specifies the control plane configuration. | +| `clusterOperations` | `object` | Specifies the bare metal user cluster's observability infrastructure. | +| `localName` | `string` | Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the name in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl. | +| `proxy` | `object` | Specifies the cluster proxy configuration. | | `maintenanceConfig` | `object` | Specifies configurations to put bare metal nodes in and out of maintenance. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md index db47640494..c6db5acd47 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_clusters_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md index c570cebb8e..7858188032 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The bare metal node pool resource name. | -| `nodePoolConfig` | `object` | BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. | -| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal node pool. | -| `state` | `string` | Output only. The current state of the bare metal node pool. | -| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | | `createTime` | `string` | Output only. The time at which this bare metal node pool was created. | | `displayName` | `string` | The display name for the bare metal node pool. | -| `annotations` | `object` | Annotations on the bare metal node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | -| `updateTime` | `string` | Output only. The time at which this bare metal node pool was last updated. | | `uid` | `string` | Output only. The unique identifier of the bare metal node pool. | +| `deleteTime` | `string` | Output only. The time at which this bare metal node pool was deleted. If the resource is not deleted, this must be empty | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `annotations` | `object` | Annotations on the bare metal node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | | `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `nodePoolConfig` | `object` | BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. | +| `state` | `string` | Output only. The current state of the bare metal node pool. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal node pool. | | `upgradePolicy` | `object` | BareMetalNodePoolUpgradePolicy defines the node pool upgrade policy. | -| `deleteTime` | `string` | Output only. The time at which this bare metal node pool was deleted. If the resource is not deleted, this must be empty | +| `updateTime` | `string` | Output only. The time at which this bare metal node pool was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools_iam_policies/index.md index bfc24469ee..bf43d75015 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_node_pools_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/locations/index.md b/docs/google-docs/providers/google/gkeonprem/locations/index.md index 3aa09f9f21..823dce09a3 100644 --- a/docs/google-docs/providers/google/gkeonprem/locations/index.md +++ b/docs/google-docs/providers/google/gkeonprem/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/operations/index.md b/docs/google-docs/providers/google/gkeonprem/operations/index.md index 778b8da2be..5e699de41b 100644 --- a/docs/google-docs/providers/google/gkeonprem/operations/index.md +++ b/docs/google-docs/providers/google/gkeonprem/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md index c1c26f8c6f..5881e8d375 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters/index.md @@ -29,28 +29,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The VMware admin cluster resource name. | | `description` | `string` | A human readable description of this VMware admin cluster. | -| `state` | `string` | Output only. The current state of VMware admin cluster. | -| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | | `imageType` | `string` | The OS image type for the VMware admin cluster. | -| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the VMware admin cluster. | -| `loadBalancer` | `object` | VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster. | -| `localName` | `string` | Output only. The object name of the VMware OnPremAdminCluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | +| `updateTime` | `string` | Output only. The time at which VMware admin cluster was last updated. | | `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `onPremVersion` | `string` | The Anthos clusters on the VMware version for the admin cluster. | +| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | +| `uid` | `string` | Output only. The unique identifier of the VMware admin cluster. | | `addonNode` | `object` | VmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster. | +| `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | | `antiAffinityGroups` | `object` | Specifies anti affinity group config for the VMware user cluster. | -| `vcenter` | `object` | VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. | -| `uid` | `string` | Output only. The unique identifier of the VMware admin cluster. | -| `platformConfig` | `object` | VmwarePlatformConfig represents configuration for the VMware platform. | -| `updateTime` | `string` | Output only. The time at which VMware admin cluster was last updated. | | `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | | `annotations` | `object` | Annotations on the VMware admin cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | -| `bootstrapClusterMembership` | `string` | The bootstrap cluster this VMware admin cluster belongs to. | -| `networkConfig` | `object` | VmwareAdminNetworkConfig contains network configuration for VMware admin cluster. | -| `onPremVersion` | `string` | The Anthos clusters on the VMware version for the admin cluster. | +| `controlPlaneNode` | `object` | VmwareAdminControlPlaneNodeConfig contains control plane node configuration for VMware admin cluster. | +| `localName` | `string` | Output only. The object name of the VMware OnPremAdminCluster custom resource. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | +| `platformConfig` | `object` | VmwarePlatformConfig represents configuration for the VMware platform. | +| `vcenter` | `object` | VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. | | `createTime` | `string` | Output only. The time at which VMware admin cluster was created. | -| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | +| `bootstrapClusterMembership` | `string` | The bootstrap cluster this VMware admin cluster belongs to. | +| `loadBalancer` | `object` | VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster. | | `endpoint` | `string` | Output only. The DNS name of VMware admin cluster's API server. | -| `controlPlaneNode` | `object` | VmwareAdminControlPlaneNodeConfig contains control plane node configuration for VMware admin cluster. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the VMware admin cluster. | +| `state` | `string` | Output only. The current state of VMware admin cluster. | +| `networkConfig` | `object` | VmwareAdminNetworkConfig contains network configuration for VMware admin cluster. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md index 4976e91b39..49682525d8 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md @@ -29,33 +29,33 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The VMware user cluster resource name. | | `description` | `string` | A human readable description of this VMware user cluster. | -| `deleteTime` | `string` | Output only. The time at which VMware user cluster was deleted. | -| `onPremVersion` | `string` | Required. The Anthos clusters on the VMware version for your user cluster. | -| `enableControlPlaneV2` | `boolean` | Enable control plane V2. Default to false. | +| `networkConfig` | `object` | Specifies network config for the VMware user cluster. | +| `storage` | `object` | Specifies vSphere CSI components deployment config in the VMware user cluster. | | `authorization` | `object` | Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. | -| `adminClusterMembership` | `string` | Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources. | -| `updateTime` | `string` | Output only. The time at which VMware user cluster was last updated. | -| `adminClusterName` | `string` | Output only. The resource name of the VMware admin cluster hosting this user cluster. | -| `endpoint` | `string` | Output only. The DNS name of VMware user cluster's API server. | -| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | -| `createTime` | `string` | Output only. The time at which VMware user cluster was created. | -| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `state` | `string` | Output only. The current state of VMware user cluster. | +| `onPremVersion` | `string` | Required. The Anthos clusters on the VMware version for your user cluster. | | `loadBalancer` | `object` | Specifies the locad balancer config for the VMware user cluster. | | `annotations` | `object` | Annotations on the VMware user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | -| `dataplaneV2` | `object` | Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 | +| `endpoint` | `string` | Output only. The DNS name of VMware user cluster's API server. | | `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | -| `networkConfig` | `object` | Specifies network config for the VMware user cluster. | -| `storage` | `object` | Specifies vSphere CSI components deployment config in the VMware user cluster. | -| `state` | `string` | Output only. The current state of VMware user cluster. | -| `vmTrackingEnabled` | `boolean` | Enable VM tracking. | -| `antiAffinityGroups` | `object` | Specifies anti affinity group config for the VMware user cluster. | -| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | -| `localName` | `string` | Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | +| `deleteTime` | `string` | Output only. The time at which VMware user cluster was deleted. | +| `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | | `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the VMware user cluster. | -| `vcenter` | `object` | Represents configuration for the VMware VCenter for the user cluster. | -| `uid` | `string` | Output only. The unique identifier of the VMware user cluster. | | `fleet` | `object` | Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ## | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `updateTime` | `string` | Output only. The time at which VMware user cluster was last updated. | +| `dataplaneV2` | `object` | Contains configurations for Dataplane V2, which is optimized dataplane for Kubernetes networking. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dataplane-v2 | +| `vmTrackingEnabled` | `boolean` | Enable VM tracking. | +| `createTime` | `string` | Output only. The time at which VMware user cluster was created. | +| `adminClusterName` | `string` | Output only. The resource name of the VMware admin cluster hosting this user cluster. | +| `vcenter` | `object` | Represents configuration for the VMware VCenter for the user cluster. | | `controlPlaneNode` | `object` | Specifies control plane node config for the VMware user cluster. | +| `uid` | `string` | Output only. The unique identifier of the VMware user cluster. | +| `enableControlPlaneV2` | `boolean` | Enable control plane V2. Default to false. | +| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | +| `adminClusterMembership` | `string` | Required. The admin cluster this VMware user cluster belongs to. This is the full resource name of the admin cluster's fleet membership. In the future, references to other resource types might be allowed if admin clusters are modeled as their own resources. | +| `antiAffinityGroups` | `object` | Specifies anti affinity group config for the VMware user cluster. | +| `localName` | `string` | Output only. The object name of the VMware OnPremUserCluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the ID in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. All users should use this name to access their cluster using gkectl or kubectl and should expect to see the local name when viewing admin cluster controller logs. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md index 378509cada..a162807dfd 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_clusters_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md index d39d130cce..12cf4273f9 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools/index.md @@ -28,19 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of this node pool. | -| `nodePoolAutoscaling` | `object` | NodePoolAutoscaling config for the NodePool to allow for the kubernetes to scale NodePool. | +| `config` | `object` | Parameters that describe the configuration of all nodes within a given node pool. | +| `deleteTime` | `string` | Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty | | `uid` | `string` | Output only. The unique identifier of the node pool. | -| `createTime` | `string` | Output only. The time at which this node pool was created. | | `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the node pool. | -| `state` | `string` | Output only. The current state of the node pool. | | `displayName` | `string` | The display name for the node pool. | -| `deleteTime` | `string` | Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty | -| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | -| `onPremVersion` | `string` | Anthos version for the node pool. Defaults to the user cluster version. | +| `state` | `string` | Output only. The current state of the node pool. | | `annotations` | `object` | Annotations on the node pool. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between. | -| `config` | `object` | Parameters that describe the configuration of all nodes within a given node pool. | -| `updateTime` | `string` | Output only. The time at which this node pool was last updated. | +| `createTime` | `string` | Output only. The time at which this node pool was created. | | `etag` | `string` | This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control. | +| `onPremVersion` | `string` | Anthos version for the node pool. Defaults to the user cluster version. | +| `nodePoolAutoscaling` | `object` | NodePoolAutoscaling config for the NodePool to allow for the kubernetes to scale NodePool. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `updateTime` | `string` | Output only. The time at which this node pool was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md index e2699ab58c..66af007330 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_node_pools_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md b/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md index 85ce9f66c3..dfc4a101af 100644 --- a/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md +++ b/docs/google-docs/providers/google/healthcare/attribute_definitions/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name of the Attribute definition, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/attributeDefinitions/{attribute_definition_id}`. Cannot be changed after creation. | | `description` | `string` | Optional. A description of the attribute. | -| `consentDefaultValues` | `array` | Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. | | `dataMappingDefaultValue` | `string` | Optional. Default value of the attribute in User data mappings. If no default value is specified, it defaults to an empty value. This field is only applicable to attributes of the category `RESOURCE`. | | `allowedValues` | `array` | Required. Possible values for the attribute. The number of allowed values must not exceed 500. An empty list is invalid. The list can only be expanded after creation. | | `category` | `string` | Required. The category of the attribute. The value of this field cannot be changed after creation. | +| `consentDefaultValues` | `array` | Optional. Default values of the attribute in Consents. If no default values are specified, it defaults to an empty value. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md b/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md index e1253d2ccb..559beea8e5 100644 --- a/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md +++ b/docs/google-docs/providers/google/healthcare/consent_artifacts/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the Consent artifact, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. Cannot be changed after creation. | -| `consentContentScreenshots` | `array` | Optional. Screenshots, PDFs, or other binary information documenting the user's consent. | -| `consentContentVersion` | `string` | Optional. An string indicating the version of the consent information shown to the user. | -| `guardianSignature` | `object` | User signature. | | `metadata` | `object` | Optional. Metadata associated with the Consent artifact. For example, the consent locale or user agent version. | | `userId` | `string` | Required. User's UUID provided by the client. | | `userSignature` | `object` | User signature. | | `witnessSignature` | `object` | User signature. | +| `consentContentScreenshots` | `array` | Optional. Screenshots, PDFs, or other binary information documenting the user's consent. | +| `consentContentVersion` | `string` | Optional. An string indicating the version of the consent information shown to the user. | +| `guardianSignature` | `object` | User signature. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/consent_stores/index.md b/docs/google-docs/providers/google/healthcare/consent_stores/index.md index 5599e6efdf..5ceebd50b2 100644 --- a/docs/google-docs/providers/google/healthcare/consent_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/consent_stores/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the consent store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}`. Cannot be changed after creation. | +| `enableConsentCreateOnUpdate` | `boolean` | Optional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`. | | `labels` | `object` | Optional. User-supplied key-value pairs used to organize consent stores. 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. For more information: https://cloud.google.com/healthcare/docs/how-tos/labeling-resources | | `defaultConsentTtl` | `string` | Optional. Default time to live for Consents created in this store. Must be at least 24 hours. Updating this field will not affect the expiration time of existing consents. | -| `enableConsentCreateOnUpdate` | `boolean` | Optional. If `true`, UpdateConsent creates the Consent if it does not already exist. If unspecified, defaults to `false`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/consent_stores_iam_audit_configs/index.md b/docs/google-docs/providers/google/healthcare/consent_stores_iam_audit_configs/index.md deleted file mode 100644 index 99117158da..0000000000 --- a/docs/google-docs/providers/google/healthcare/consent_stores_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: consent_stores_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - consent_stores_iam_audit_configs - - healthcare - - 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 ---- - - - -## Overview - - - - -
Nameconsent_stores_iam_audit_configs
TypeResource
Idgoogle.healthcare.consent_stores_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_consentStores_getIamPolicy` | `SELECT` | `consentStoresId, datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/consent_stores_iam_bindings/index.md b/docs/google-docs/providers/google/healthcare/consent_stores_iam_bindings/index.md deleted file mode 100644 index 831dc7334c..0000000000 --- a/docs/google-docs/providers/google/healthcare/consent_stores_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: consent_stores_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - consent_stores_iam_bindings - - healthcare - - 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 ---- - - - -## Overview - - - - -
Nameconsent_stores_iam_bindings
TypeResource
Idgoogle.healthcare.consent_stores_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_consentStores_getIamPolicy` | `SELECT` | `consentStoresId, datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/consent_stores_iam_policies/index.md b/docs/google-docs/providers/google/healthcare/consent_stores_iam_policies/index.md index 097ec592df..9b198fb322 100644 --- a/docs/google-docs/providers/google/healthcare/consent_stores_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/consent_stores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/consents/index.md b/docs/google-docs/providers/google/healthcare/consents/index.md index 34dbc617da..2b435d7142 100644 --- a/docs/google-docs/providers/google/healthcare/consents/index.md +++ b/docs/google-docs/providers/google/healthcare/consents/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. | -| `state` | `string` | Required. Indicates the current state of this Consent. | -| `revisionId` | `string` | Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. | -| `policies` | `array` | Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. | -| `userId` | `string` | Required. User's UUID provided by the client. | | `ttl` | `string` | Input only. The time to live for this Consent from when it is created. | +| `userId` | `string` | Required. User's UUID provided by the client. | | `consentArtifact` | `string` | Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. | +| `state` | `string` | Required. Indicates the current state of this Consent. | | `metadata` | `object` | Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. | | `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | +| `policies` | `array` | Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. | +| `revisionId` | `string` | Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. | | `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/healthcare/consents_revisions/index.md b/docs/google-docs/providers/google/healthcare/consents_revisions/index.md index 0f85d4fd86..487cd289dc 100644 --- a/docs/google-docs/providers/google/healthcare/consents_revisions/index.md +++ b/docs/google-docs/providers/google/healthcare/consents_revisions/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the Consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consents/{consent_id}`. Cannot be changed after creation. | -| `revisionId` | `string` | Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. | +| `consentArtifact` | `string` | Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. | +| `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | | `ttl` | `string` | Input only. The time to live for this Consent from when it is created. | | `state` | `string` | Required. Indicates the current state of this Consent. | -| `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | | `userId` | `string` | Required. User's UUID provided by the client. | | `metadata` | `object` | Optional. User-supplied key-value pairs used to organize Consent resources. Metadata keys must: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - begin with a letter - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes Metadata values must be: - be between 1 and 63 characters long - have a UTF-8 encoding of maximum 128 bytes - consist of up to 63 characters including lowercase letters, numeric characters, underscores, and dashes No more than 64 metadata entries can be associated with a given consent. | -| `consentArtifact` | `string` | Required. The resource name of the Consent artifact that contains proof of the end user's consent, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/consentArtifacts/{consent_artifact_id}`. | | `policies` | `array` | Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. | -| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `revisionId` | `string` | Output only. The revision ID of the Consent. The format is an 8-character hexadecimal string. Refer to a specific revision of a Consent by appending `@{revision_id}` to the Consent's resource name. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/healthcare/datasets_iam_audit_configs/index.md b/docs/google-docs/providers/google/healthcare/datasets_iam_audit_configs/index.md deleted file mode 100644 index 686d8b1ec3..0000000000 --- a/docs/google-docs/providers/google/healthcare/datasets_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: datasets_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - datasets_iam_audit_configs - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namedatasets_iam_audit_configs
TypeResource
Idgoogle.healthcare.datasets_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_getIamPolicy` | `SELECT` | `datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/datasets_iam_bindings/index.md b/docs/google-docs/providers/google/healthcare/datasets_iam_bindings/index.md deleted file mode 100644 index 32f5161a84..0000000000 --- a/docs/google-docs/providers/google/healthcare/datasets_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: datasets_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - datasets_iam_bindings - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namedatasets_iam_bindings
TypeResource
Idgoogle.healthcare.datasets_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_getIamPolicy` | `SELECT` | `datasetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md b/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md index f27328d5c5..52e59c1ce1 100644 --- a/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/datasets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/dicom_stores/index.md b/docs/google-docs/providers/google/healthcare/dicom_stores/index.md index d555babc3f..e189b40483 100644 --- a/docs/google-docs/providers/google/healthcare/dicom_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/dicom_stores/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. | -| `labels` | `object` | User-supplied key-value pairs used to organize DICOM stores. 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 are optional, 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. | | `notificationConfig` | `object` | Specifies where to send notifications upon changes to a data store. | | `streamConfigs` | `array` | Optional. A list of streaming configs used to configure the destination of streaming exports for every DICOM instance insertion in this DICOM store. After a new config is added to `stream_configs`, DICOM instance insertions are streamed to the new destination. When a config is removed from `stream_configs`, the server stops streaming to that destination. Each config must contain a unique destination. | +| `labels` | `object` | User-supplied key-value pairs used to organize DICOM stores. 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 are optional, 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/dicom_stores_iam_audit_configs/index.md b/docs/google-docs/providers/google/healthcare/dicom_stores_iam_audit_configs/index.md deleted file mode 100644 index bab8d413f4..0000000000 --- a/docs/google-docs/providers/google/healthcare/dicom_stores_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: dicom_stores_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - dicom_stores_iam_audit_configs - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namedicom_stores_iam_audit_configs
TypeResource
Idgoogle.healthcare.dicom_stores_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_dicomStores_getIamPolicy` | `SELECT` | `datasetsId, dicomStoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/dicom_stores_iam_bindings/index.md b/docs/google-docs/providers/google/healthcare/dicom_stores_iam_bindings/index.md deleted file mode 100644 index 501f8a7188..0000000000 --- a/docs/google-docs/providers/google/healthcare/dicom_stores_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: dicom_stores_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - dicom_stores_iam_bindings - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namedicom_stores_iam_bindings
TypeResource
Idgoogle.healthcare.dicom_stores_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_dicomStores_getIamPolicy` | `SELECT` | `datasetsId, dicomStoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/fhir_stores/index.md b/docs/google-docs/providers/google/healthcare/fhir_stores/index.md index 4bb72fa16b..e4afb6047e 100644 --- a/docs/google-docs/providers/google/healthcare/fhir_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/fhir_stores/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the FHIR store, of the form `projects/{project_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. | +| `disableReferentialIntegrity` | `boolean` | Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. | +| `notificationConfigs` | `array` | Specifies where and whether to send notifications upon changes to a FHIR store. | | `disableResourceVersioning` | `boolean` | Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. | +| `enableUpdateCreate` | `boolean` | Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. | +| `version` | `string` | Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. | +| `defaultSearchHandlingStrict` | `boolean` | If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. | +| `complexDataTypeReferenceParsing` | `string` | Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. | | `labels` | `object` | User-supplied key-value pairs used to organize FHIR stores. 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 are optional, 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. | | `notificationConfig` | `object` | Specifies where to send notifications upon changes to a data store. | | `streamConfigs` | `array` | A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. | -| `version` | `string` | Immutable. The FHIR specification version that this FHIR store supports natively. This field is immutable after store creation. Requests are rejected if they contain FHIR resources of a different version. Version is required for every FHIR store. | -| `complexDataTypeReferenceParsing` | `string` | Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. | -| `enableUpdateCreate` | `boolean` | Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. | -| `notificationConfigs` | `array` | Specifies where and whether to send notifications upon changes to a FHIR store. | -| `defaultSearchHandlingStrict` | `boolean` | If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. | -| `disableReferentialIntegrity` | `boolean` | Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. | | `validationConfig` | `object` | Contains the configuration for FHIR profiles and validation. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/healthcare/fhir_stores_iam_audit_configs/index.md b/docs/google-docs/providers/google/healthcare/fhir_stores_iam_audit_configs/index.md deleted file mode 100644 index 2c95e6b649..0000000000 --- a/docs/google-docs/providers/google/healthcare/fhir_stores_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: fhir_stores_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - fhir_stores_iam_audit_configs - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namefhir_stores_iam_audit_configs
TypeResource
Idgoogle.healthcare.fhir_stores_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_fhirStores_getIamPolicy` | `SELECT` | `datasetsId, fhirStoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/fhir_stores_iam_bindings/index.md b/docs/google-docs/providers/google/healthcare/fhir_stores_iam_bindings/index.md deleted file mode 100644 index 878b28dd6f..0000000000 --- a/docs/google-docs/providers/google/healthcare/fhir_stores_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: fhir_stores_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - fhir_stores_iam_bindings - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namefhir_stores_iam_bindings
TypeResource
Idgoogle.healthcare.fhir_stores_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_fhirStores_getIamPolicy` | `SELECT` | `datasetsId, fhirStoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md b/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md index 13262af732..b7627308c3 100644 --- a/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/hl7_v2_stores/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the HL7v2 store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`. | -| `rejectDuplicateMessage` | `boolean` | Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. | -| `labels` | `object` | User-supplied key-value pairs used to organize HL7v2 stores. 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 are optional, 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. | | `notificationConfigs` | `array` | A list of notification configs. Each configuration uses a filter to determine whether to publish a message (both Ingest & Create) on the corresponding notification destination. Only the message name is sent as part of the notification. Supplied by the client. | | `parserConfig` | `object` | The configuration for the parser. It determines how the server parses the messages. | +| `rejectDuplicateMessage` | `boolean` | Determines whether to reject duplicate messages. A duplicate message is a message with the same raw bytes as a message that has already been ingested/created in this HL7v2 store. The default value is false, meaning that the store accepts the duplicate messages and it also returns the same ACK message in the IngestMessageResponse as has been returned previously. Note that only one resource is created in the store. When this field is set to true, CreateMessage/IngestMessage requests with a duplicate message will be rejected by the store, and IngestMessageErrorDetail returns a NACK message upon rejection. | +| `labels` | `object` | User-supplied key-value pairs used to organize HL7v2 stores. 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 are optional, 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_audit_configs/index.md b/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_audit_configs/index.md deleted file mode 100644 index fd7e49dbaa..0000000000 --- a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: hl7_v2_stores_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - hl7_v2_stores_iam_audit_configs - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namehl7_v2_stores_iam_audit_configs
TypeResource
Idgoogle.healthcare.hl7_v2_stores_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_hl7V2Stores_getIamPolicy` | `SELECT` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_bindings/index.md b/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_bindings/index.md deleted file mode 100644 index 4fea1bc97c..0000000000 --- a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: hl7_v2_stores_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - hl7_v2_stores_iam_bindings - - healthcare - - 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 ---- - - - -## Overview - - - - -
Namehl7_v2_stores_iam_bindings
TypeResource
Idgoogle.healthcare.hl7_v2_stores_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_datasets_hl7V2Stores_getIamPolicy` | `SELECT` | `datasetsId, hl7V2StoresId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md b/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md index e68383078e..7d918e8420 100644 --- a/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/hl7_v2_stores_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/locations/index.md b/docs/google-docs/providers/google/healthcare/locations/index.md index 674ebba4e0..27156fc4a2 100644 --- a/docs/google-docs/providers/google/healthcare/locations/index.md +++ b/docs/google-docs/providers/google/healthcare/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/messages/index.md b/docs/google-docs/providers/google/healthcare/messages/index.md index 7f7a0f8d8e..10985a14fd 100644 --- a/docs/google-docs/providers/google/healthcare/messages/index.md +++ b/docs/google-docs/providers/google/healthcare/messages/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. Assigned by the server. | +| `schematizedData` | `object` | The content of an HL7v2 message in a structured format as specified by a schema. | | `sendFacility` | `string` | The hospital that this message came from. MSH-4. | | `createTime` | `string` | Output only. The datetime when the message was created. Set by the server. | -| `messageType` | `string` | The message type for this message. MSH-9.1. | | `sendTime` | `string` | The datetime the sending application sent this message. MSH-7. | | `patientIds` | `array` | All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. | -| `schematizedData` | `object` | The content of an HL7v2 message in a structured format as specified by a schema. | -| `parsedData` | `object` | The content of a HL7v2 message in a structured format. | | `labels` | `object` | User-supplied key-value pairs used to organize HL7v2 stores. 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 are optional, 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. | +| `messageType` | `string` | The message type for this message. MSH-9.1. | | `data` | `string` | Raw message bytes. | +| `parsedData` | `object` | The content of a HL7v2 message in a structured format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/operations/index.md b/docs/google-docs/providers/google/healthcare/operations/index.md index 1c46849a16..69f84e4404 100644 --- a/docs/google-docs/providers/google/healthcare/operations/index.md +++ b/docs/google-docs/providers/google/healthcare/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md b/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md index 99519bb162..bd8c1ef456 100644 --- a/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md +++ b/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the User data mapping, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/consentStores/{consent_store_id}/userDataMappings/{user_data_mapping_id}`. | -| `archived` | `boolean` | Output only. Indicates whether this mapping is archived. | | `dataId` | `string` | Required. A unique identifier for the mapped resource. | | `resourceAttributes` | `array` | Attributes of the resource. Only explicitly set attributes are displayed here. Attribute definitions with defaults set implicitly apply to these User data mappings. Attributes listed here must be single valued, that is, exactly one value is specified for the field "values" in each Attribute. | | `userId` | `string` | Required. User's UUID provided by the client. | | `archiveTime` | `string` | Output only. Indicates the time when this mapping was archived. | +| `archived` | `boolean` | Output only. Indicates whether this mapping is archived. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/iam/iam_policies/index.md b/docs/google-docs/providers/google/iam/iam_policies/index.md deleted file mode 100644 index 6c51bf5861..0000000000 --- a/docs/google-docs/providers/google/iam/iam_policies/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - iam_policies - - iam - - 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 ---- - - - -## Overview - - - - -
Nameiam_policies
TypeResource
Idgoogle.iam.iam_policies
- -## 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 -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `iamPolicies_lintPolicy` | `EXEC` | | Lints, or validates, an IAM policy. Currently checks the google.iam.v1.Binding.condition field, which contains a condition expression for a role binding. Successful calls to this method always return an HTTP `200 OK` status code, even if the linter detects an issue in the IAM policy. | -| `iamPolicies_queryAuditableServices` | `EXEC` | | Returns a list of services that allow you to opt into audit logs that are not generated by default. To learn more about audit logs, see the [Logging documentation](https://cloud.google.com/logging/docs/audit). | diff --git a/docs/google-docs/providers/google/iam/keys/index.md b/docs/google-docs/providers/google/iam/keys/index.md deleted file mode 100644 index 4dab14af03..0000000000 --- a/docs/google-docs/providers/google/iam/keys/index.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: keys -hide_title: false -hide_table_of_contents: false -keywords: - - keys - - iam - - 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 ---- - - - -## Overview - - - - -
Namekeys
TypeResource
Idgoogle.iam.keys
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. | -| `validAfterTime` | `string` | The key can be used after this timestamp. | -| `keyAlgorithm` | `string` | Specifies the algorithm (and possibly key size) for the key. | -| `privateKeyData` | `string` | The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account. | -| `privateKeyType` | `string` | The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys. | -| `publicKeyData` | `string` | The public key data. Only provided in `GetServiceAccountKey` responses. | -| `keyOrigin` | `string` | The key origin. | -| `keyType` | `string` | The key type. | -| `disabled` | `boolean` | The key status. | -| `validBeforeTime` | `string` | The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_serviceAccounts_keys_get` | `SELECT` | `keysId, projectsId, serviceAccountsId` | Gets a ServiceAccountKey. | -| `projects_serviceAccounts_keys_list` | `SELECT` | `projectsId, serviceAccountsId` | Lists every ServiceAccountKey for a service account. | -| `projects_serviceAccounts_keys_create` | `INSERT` | `projectsId, serviceAccountsId` | Creates a ServiceAccountKey. | -| `projects_serviceAccounts_keys_delete` | `DELETE` | `keysId, projectsId, serviceAccountsId` | Deletes a ServiceAccountKey. Deleting a service account key does not revoke short-lived credentials that have been issued based on the service account key. | -| `projects_serviceAccounts_keys_disable` | `EXEC` | `keysId, projectsId, serviceAccountsId` | Disable a ServiceAccountKey. A disabled service account key can be re-enabled with EnableServiceAccountKey. | -| `projects_serviceAccounts_keys_enable` | `EXEC` | `keysId, projectsId, serviceAccountsId` | Enable a ServiceAccountKey. | -| `projects_serviceAccounts_keys_upload` | `EXEC` | `projectsId, serviceAccountsId` | Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key. | diff --git a/docs/google-docs/providers/google/iam/permissions/index.md b/docs/google-docs/providers/google/iam/permissions/index.md deleted file mode 100644 index e8c27590f4..0000000000 --- a/docs/google-docs/providers/google/iam/permissions/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: permissions -hide_title: false -hide_table_of_contents: false -keywords: - - permissions - - iam - - 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 ---- - - - -## Overview - - - - -
Namepermissions
TypeResource
Idgoogle.iam.permissions
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `queryTestablePermissions` | `EXEC` | | diff --git a/docs/google-docs/providers/google/iam/policies/index.md b/docs/google-docs/providers/google/iam/policies/index.md index 15288f2eae..b2edc2bd33 100644 --- a/docs/google-docs/providers/google/iam/policies/index.md +++ b/docs/google-docs/providers/google/iam/policies/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the `Policy`, which must be unique. Format: `policies/{attachment_point}/denypolicies/{policy_id}` The attachment point is identified by its URL-encoded full resource name, which means that the forward-slash character, `/`, must be written as `%2F`. For example, `policies/cloudresourcemanager.googleapis.com%2Fprojects%2Fmy-project/denypolicies/my-deny-policy`. For organizations and folders, use the numeric ID in the full resource name. For projects, requests can use the alphanumeric or the numeric ID. Responses always contain the numeric ID. | -| `annotations` | `object` | A key-value map to store arbitrary metadata for the `Policy`. Keys can be up to 63 characters. Values can be up to 255 characters. | -| `etag` | `string` | An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored. | -| `deleteTime` | `string` | Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted. | -| `uid` | `string` | Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created. | | `rules` | `array` | A list of rules that specify the behavior of the `Policy`. All of the rules should be of the `kind` specified in the `Policy`. | -| `displayName` | `string` | A user-specified description of the `Policy`. This value can be up to 63 characters. | | `kind` | `string` | Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`. | +| `etag` | `string` | An opaque tag that identifies the current version of the `Policy`. IAM uses this value to help manage concurrent updates, so they do not cause one update to be overwritten by another. If this field is present in a CreatePolicyRequest, the value is ignored. | | `createTime` | `string` | Output only. The time when the `Policy` was created. | +| `displayName` | `string` | A user-specified description of the `Policy`. This value can be up to 63 characters. | +| `deleteTime` | `string` | Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted. | +| `uid` | `string` | Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created. | | `updateTime` | `string` | Output only. The time when the `Policy` was last updated. | +| `annotations` | `object` | A key-value map to store arbitrary metadata for the `Policy`. Keys can be up to 63 characters. Values can be up to 255 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/iam/policies_policies/index.md b/docs/google-docs/providers/google/iam/policies_policies/index.md deleted file mode 100644 index e563dcb088..0000000000 --- a/docs/google-docs/providers/google/iam/policies_policies/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: policies_policies -hide_title: false -hide_table_of_contents: false -keywords: - - policies_policies - - iam - - 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 ---- - - - -## Overview - - - - -
Namepolicies_policies
TypeResource
Idgoogle.iam.policies_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `policies` | `array` | Metadata for the policies that are attached to the resource. | -| `nextPageToken` | `string` | A page token that you can use in a ListPoliciesRequest to retrieve the next page. If this field is omitted, there are no additional pages. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `list_policies` | `SELECT` | `policiesId, policiesId1` | diff --git a/docs/google-docs/providers/google/iam/policies_policy/index.md b/docs/google-docs/providers/google/iam/policies_policy/index.md deleted file mode 100644 index b48cd7d403..0000000000 --- a/docs/google-docs/providers/google/iam/policies_policy/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: policies_policy -hide_title: false -hide_table_of_contents: false -keywords: - - policies_policy - - iam - - 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 ---- - - - -## Overview - - - - -
Namepolicies_policy
TypeResource
Idgoogle.iam.policies_policy
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `create_policy` | `INSERT` | `policiesId, policiesId1` | diff --git a/docs/google-docs/providers/google/iam/providers/index.md b/docs/google-docs/providers/google/iam/providers/index.md deleted file mode 100644 index 1e69f4ff2c..0000000000 --- a/docs/google-docs/providers/google/iam/providers/index.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -title: providers -hide_title: false -hide_table_of_contents: false -keywords: - - providers - - iam - - 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 ---- - - - -## Overview - - - - -
Nameproviders
TypeResource
Idgoogle.iam.providers
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the provider. | -| `description` | `string` | A description for the provider. Cannot exceed 256 characters. | -| `attributeCondition` | `string` | [A Common Expression Language](https://opensource.google/projects/cel) expression, in plain text, to restrict what otherwise valid authentication credentials issued by the provider should not be accepted. The expression must output a boolean representing whether to allow the federation. The following keywords may be referenced in the expressions: * `assertion`: JSON representing the authentication credential issued by the provider. * `google`: The Google attributes mapped from the assertion in the `attribute_mappings`. * `attribute`: The custom attributes mapped from the assertion in the `attribute_mappings`. The maximum length of the attribute condition expression is 4096 characters. If unspecified, all valid authentication credential are accepted. The following example shows how to only allow credentials with a mapped `google.groups` value of `admins`: ``` "'admins' in google.groups" ``` | -| `disabled` | `boolean` | Whether the provider is disabled. You cannot use a disabled provider to exchange tokens. However, existing tokens still grant access. | -| `saml` | `object` | Represents an SAML 2.0 identity provider. | -| `state` | `string` | Output only. The state of the provider. | -| `displayName` | `string` | A display name for the provider. Cannot exceed 32 characters. | -| `aws` | `object` | Represents an Amazon Web Services identity provider. | -| `attributeMapping` | `object` | Maps attributes from authentication credentials issued by an external identity provider to Google Cloud attributes, such as `subject` and `segment`. Each key must be a string specifying the Google Cloud IAM attribute to map to. The following keys are supported: * `google.subject`: The principal IAM is authenticating. You can reference this value in IAM bindings. This is also the subject that appears in Cloud Logging logs. Cannot exceed 127 bytes. * `google.groups`: Groups the external identity belongs to. You can grant groups access to resources using an IAM `principalSet` binding; access applies to all members of the group. You can also provide custom attributes by specifying `attribute.{custom_attribute}`, where `{custom_attribute}` is the name of the custom attribute to be mapped. You can define a maximum of 50 custom attributes. The maximum length of a mapped attribute key is 100 characters, and the key may only contain the characters [a-z0-9_]. You can reference these attributes in IAM policies to define fine-grained access for a workload to Google Cloud resources. For example: * `google.subject`: `principal://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/subject/{value}` * `google.groups`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/group/{value}` * `attribute.{custom_attribute}`: `principalSet://iam.googleapis.com/projects/{project}/locations/{location}/workloadIdentityPools/{pool}/attribute.{custom_attribute}/{value}` Each value must be a [Common Expression Language] (https://opensource.google/projects/cel) function that maps an identity provider credential to the normalized attribute specified by the corresponding map key. You can use the `assertion` keyword in the expression to access a JSON representation of the authentication credential issued by the provider. The maximum length of an attribute mapping expression is 2048 characters. When evaluated, the total size of all mapped attributes must not exceed 8KB. For AWS providers, if no attribute mapping is defined, the following default mapping applies: ``` { "google.subject":"assertion.arn", "attribute.aws_role": "assertion.arn.contains('assumed-role')" " ? assertion.arn.extract('{account_arn}assumed-role/')" " + 'assumed-role/'" " + assertion.arn.extract('assumed-role/{role_name}/')" " : assertion.arn", } ``` If any custom attribute mappings are defined, they must include a mapping to the `google.subject` attribute. For OIDC providers, you must supply a custom mapping, which must include the `google.subject` attribute. For example, the following maps the `sub` claim of the incoming credential to the `subject` attribute on a Google token: ``` {"google.subject": "assertion.sub"} ``` | -| `oidc` | `object` | Represents an OpenId Connect 1.0 identity provider. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_workloadIdentityPools_providers_get` | `SELECT` | `locationsId, projectsId, providersId, workloadIdentityPoolsId` | Gets an individual WorkloadIdentityPoolProvider. | -| `projects_locations_workloadIdentityPools_providers_list` | `SELECT` | `locationsId, projectsId, workloadIdentityPoolsId` | Lists all non-deleted WorkloadIdentityPoolProviders in a WorkloadIdentityPool. If `show_deleted` is set to `true`, then deleted providers are also listed. | -| `projects_locations_workloadIdentityPools_providers_create` | `INSERT` | `locationsId, projectsId, workloadIdentityPoolsId` | Creates a new WorkloadIdentityPoolProvider in a WorkloadIdentityPool. You cannot reuse the name of a deleted provider until 30 days after deletion. | -| `projects_locations_workloadIdentityPools_providers_delete` | `DELETE` | `locationsId, projectsId, providersId, workloadIdentityPoolsId` | Deletes a WorkloadIdentityPoolProvider. Deleting a provider does not revoke credentials that have already been issued; they continue to grant access. You can undelete a provider for 30 days. After 30 days, deletion is permanent. You cannot update deleted providers. However, you can view and list them. | -| `projects_locations_workloadIdentityPools_providers_patch` | `EXEC` | `locationsId, projectsId, providersId, workloadIdentityPoolsId` | Updates an existing WorkloadIdentityPoolProvider. | -| `projects_locations_workloadIdentityPools_providers_undelete` | `EXEC` | `locationsId, projectsId, providersId, workloadIdentityPoolsId` | Undeletes a WorkloadIdentityPoolProvider, as long as it was deleted fewer than 30 days ago. | diff --git a/docs/google-docs/providers/google/iam/roles/index.md b/docs/google-docs/providers/google/iam/roles/index.md deleted file mode 100644 index a4da75703f..0000000000 --- a/docs/google-docs/providers/google/iam/roles/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: roles -hide_title: false -hide_table_of_contents: false -keywords: - - roles - - iam - - 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 ---- - - - -## Overview - - - - -
Nameroles
TypeResource
Idgoogle.iam.roles
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the role. When Role is used in CreateRole, the role name must not be set. When Role is used in output and other input such as UpdateRole, the role name is the complete path, e.g., roles/logging.viewer for predefined roles and organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles. | -| `description` | `string` | Optional. A human-readable description for the role. | -| `etag` | `string` | Used to perform a consistent read-modify-write. | -| `includedPermissions` | `array` | The names of the permissions this role grants when bound in an IAM policy. | -| `stage` | `string` | The current launch stage of the role. If the `ALPHA` launch stage has been selected for a role, the `stage` field will not be included in the returned definition for the role. | -| `title` | `string` | Optional. A human-readable title for the role. Typically this is limited to 100 UTF-8 bytes. | -| `deleted` | `boolean` | The current deleted state of the role. This field is read only. It will be ignored in calls to CreateRole and UpdateRole. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `rolesId` | Gets the definition of a Role. | -| `list` | `SELECT` | | Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. | -| `organizations_roles_get` | `SELECT` | `organizationsId, rolesId` | Gets the definition of a Role. | -| `organizations_roles_list` | `SELECT` | `organizationsId` | Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. | -| `projects_roles_get` | `SELECT` | `projectsId, rolesId` | Gets the definition of a Role. | -| `projects_roles_list` | `SELECT` | `projectsId` | Lists every predefined Role that IAM supports, or every custom role that is defined for an organization or project. | -| `organizations_roles_create` | `INSERT` | `organizationsId` | Creates a new custom Role. | -| `projects_roles_create` | `INSERT` | `projectsId` | Creates a new custom Role. | -| `organizations_roles_delete` | `DELETE` | `organizationsId, rolesId` | Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. | -| `projects_roles_delete` | `DELETE` | `projectsId, rolesId` | Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. | -| `organizations_roles_patch` | `EXEC` | `organizationsId, rolesId` | Updates the definition of a custom Role. | -| `organizations_roles_undelete` | `EXEC` | `organizationsId, rolesId` | Undeletes a custom Role. | -| `projects_roles_patch` | `EXEC` | `projectsId, rolesId` | Updates the definition of a custom Role. | -| `projects_roles_undelete` | `EXEC` | `projectsId, rolesId` | Undeletes a custom Role. | -| `queryGrantableRoles` | `EXEC` | | Lists roles that can be granted on a Google Cloud resource. A role is grantable if the IAM policy for the resource can contain bindings to the role. | diff --git a/docs/google-docs/providers/google/iam/service_accounts/index.md b/docs/google-docs/providers/google/iam/service_accounts/index.md deleted file mode 100644 index 42e042b129..0000000000 --- a/docs/google-docs/providers/google/iam/service_accounts/index.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: service_accounts -hide_title: false -hide_table_of_contents: false -keywords: - - service_accounts - - iam - - 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 ---- - - - -## Overview - - - - -
Nameservice_accounts
TypeResource
Idgoogle.iam.service_accounts
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The resource name of the service account. Use one of the following formats: * `projects/{PROJECT_ID}/serviceAccounts/{EMAIL_ADDRESS}` * `projects/{PROJECT_ID}/serviceAccounts/{UNIQUE_ID}` As an alternative, you can use the `-` wildcard character instead of the project ID: * `projects/-/serviceAccounts/{EMAIL_ADDRESS}` * `projects/-/serviceAccounts/{UNIQUE_ID}` When possible, avoid using the `-` wildcard character, because it can cause response messages to contain misleading error codes. For example, if you try to access the service account `projects/-/serviceAccounts/fake@example.com`, which does not exist, the response contains an HTTP `403 Forbidden` error instead of a `404 Not Found` error. | -| `description` | `string` | Optional. A user-specified, human-readable description of the service account. The maximum length is 256 UTF-8 bytes. | -| `uniqueId` | `string` | Output only. The unique, stable numeric ID for the service account. Each service account retains its unique ID even if you delete the service account. For example, if you delete a service account, then create a new service account with the same name, the new service account has a different unique ID than the deleted service account. | -| `displayName` | `string` | Optional. A user-specified, human-readable name for the service account. The maximum length is 100 UTF-8 bytes. | -| `email` | `string` | Output only. The email address of the service account. | -| `oauth2ClientId` | `string` | Output only. The OAuth 2.0 client ID for the service account. | -| `projectId` | `string` | Output only. The ID of the project that owns the service account. | -| `etag` | `string` | Deprecated. Do not use. | -| `disabled` | `boolean` | Output only. Whether the service account is disabled. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_serviceAccounts_get` | `SELECT` | `projectsId, serviceAccountsId` | Gets a ServiceAccount. | -| `projects_serviceAccounts_list` | `SELECT` | `projectsId` | Lists every ServiceAccount that belongs to a specific project. | -| `projects_serviceAccounts_create` | `INSERT` | `projectsId` | Creates a ServiceAccount. | -| `projects_serviceAccounts_delete` | `DELETE` | `projectsId, serviceAccountsId` | Deletes a ServiceAccount. **Warning:** After you delete a service account, you might not be able to undelete it. If you know that you need to re-enable the service account in the future, use DisableServiceAccount instead. If you delete a service account, IAM permanently removes the service account 30 days later. Google Cloud cannot recover the service account after it is permanently removed, even if you file a support request. To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use DisableServiceAccount to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account. | -| `projects_serviceAccounts_disable` | `EXEC` | `projectsId, serviceAccountsId` | Disables a ServiceAccount immediately. If an application uses the service account to authenticate, that application can no longer call Google APIs or access Google Cloud resources. Existing access tokens for the service account are rejected, and requests for new access tokens will fail. To re-enable the service account, use EnableServiceAccount. After you re-enable the service account, its existing access tokens will be accepted, and you can request new access tokens. To help avoid unplanned outages, we recommend that you disable the service account before you delete it. Use this method to disable the service account, then wait at least 24 hours and watch for unintended consequences. If there are no unintended consequences, you can delete the service account with DeleteServiceAccount. | -| `projects_serviceAccounts_enable` | `EXEC` | `projectsId, serviceAccountsId` | Enables a ServiceAccount that was disabled by DisableServiceAccount. If the service account is already enabled, then this method has no effect. If the service account was disabled by other means—for example, if Google disabled the service account because it was compromised—you cannot use this method to enable the service account. | -| `projects_serviceAccounts_patch` | `EXEC` | `projectsId, serviceAccountsId` | Patches a ServiceAccount. | -| `projects_serviceAccounts_signBlob` | `EXEC` | `projectsId, serviceAccountsId` | **Note:** This method is deprecated. Use the [`signBlob`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signBlob) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a blob using the system-managed private key for a ServiceAccount. | -| `projects_serviceAccounts_signJwt` | `EXEC` | `projectsId, serviceAccountsId` | **Note:** This method is deprecated. Use the [`signJwt`](https://cloud.google.com/iam/help/rest-credentials/v1/projects.serviceAccounts/signJwt) method in the IAM Service Account Credentials API instead. If you currently use this method, see the [migration guide](https://cloud.google.com/iam/help/credentials/migrate-api) for instructions. Signs a JSON Web Token (JWT) using the system-managed private key for a ServiceAccount. | -| `projects_serviceAccounts_undelete` | `EXEC` | `projectsId, serviceAccountsId` | Restores a deleted ServiceAccount. **Important:** It is not always possible to restore a deleted service account. Use this method only as a last resort. After you delete a service account, IAM permanently removes the service account 30 days later. There is no way to restore a deleted service account that has been permanently removed. | -| `projects_serviceAccounts_update` | `EXEC` | `projectsId, serviceAccountsId` | **Note:** We are in the process of deprecating this method. Use PatchServiceAccount instead. Updates a ServiceAccount. You can update only the `display_name` field. | diff --git a/docs/google-docs/providers/google/iam/service_accounts_iam_audit_configs/index.md b/docs/google-docs/providers/google/iam/service_accounts_iam_audit_configs/index.md deleted file mode 100644 index 7afcdc839b..0000000000 --- a/docs/google-docs/providers/google/iam/service_accounts_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: service_accounts_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - service_accounts_iam_audit_configs - - iam - - 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 ---- - - - -## Overview - - - - -
Nameservice_accounts_iam_audit_configs
TypeResource
Idgoogle.iam.service_accounts_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_serviceAccounts_getIamPolicy` | `SELECT` | `projectsId, serviceAccountsId` | diff --git a/docs/google-docs/providers/google/iam/service_accounts_iam_bindings/index.md b/docs/google-docs/providers/google/iam/service_accounts_iam_bindings/index.md deleted file mode 100644 index 3a533fb965..0000000000 --- a/docs/google-docs/providers/google/iam/service_accounts_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: service_accounts_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - service_accounts_iam_bindings - - iam - - 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 ---- - - - -## Overview - - - - -
Nameservice_accounts_iam_bindings
TypeResource
Idgoogle.iam.service_accounts_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_serviceAccounts_getIamPolicy` | `SELECT` | `projectsId, serviceAccountsId` | diff --git a/docs/google-docs/providers/google/iam/service_accounts_iam_policies/index.md b/docs/google-docs/providers/google/iam/service_accounts_iam_policies/index.md deleted file mode 100644 index 48c74172e4..0000000000 --- a/docs/google-docs/providers/google/iam/service_accounts_iam_policies/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: service_accounts_iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - service_accounts_iam_policies - - iam - - 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 ---- - - - -## Overview - - - - -
Nameservice_accounts_iam_policies
TypeResource
Idgoogle.iam.service_accounts_iam_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_serviceAccounts_getIamPolicy` | `SELECT` | `projectsId, serviceAccountsId` | Gets the IAM policy that is attached to a ServiceAccount. This IAM policy specifies which principals have access to the service account. This method does not tell you whether the service account has been granted any roles on other resources. To check whether a service account has role grants on a resource, use the `getIamPolicy` method for that resource. For example, to view the role grants for a project, call the Resource Manager API's [`projects.getIamPolicy`](https://cloud.google.com/resource-manager/reference/rest/v1/projects/getIamPolicy) method. | -| `projects_serviceAccounts_setIamPolicy` | `EXEC` | `projectsId, serviceAccountsId` | Sets the IAM policy that is attached to a ServiceAccount. Use this method to grant or revoke access to the service account. For example, you could grant a principal the ability to impersonate the service account. This method does not enable the service account to access other resources. To grant roles to a service account on a resource, follow these steps: 1. Call the resource's `getIamPolicy` method to get its current IAM policy. 2. Edit the policy so that it binds the service account to an IAM role for the resource. 3. Call the resource's `setIamPolicy` method to update its IAM policy. For detailed instructions, see [Manage access to project, folders, and organizations](https://cloud.google.com/iam/help/service-accounts/granting-access-to-service-accounts) or [Manage access to other resources](https://cloud.google.com/iam/help/access/manage-other-resources). | -| `projects_serviceAccounts_testIamPermissions` | `EXEC` | `projectsId, serviceAccountsId` | Tests whether the caller has the specified permissions on a ServiceAccount. | diff --git a/docs/google-docs/providers/google/iam/workload_identity_pools/index.md b/docs/google-docs/providers/google/iam/workload_identity_pools/index.md deleted file mode 100644 index aeead65b97..0000000000 --- a/docs/google-docs/providers/google/iam/workload_identity_pools/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: workload_identity_pools -hide_title: false -hide_table_of_contents: false -keywords: - - workload_identity_pools - - iam - - 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 ---- - - - -## Overview - - - - -
Nameworkload_identity_pools
TypeResource
Idgoogle.iam.workload_identity_pools
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the pool. | -| `description` | `string` | A description of the pool. Cannot exceed 256 characters. | -| `state` | `string` | Output only. The state of the pool. | -| `disabled` | `boolean` | Whether the pool is disabled. You cannot use a disabled pool to exchange tokens, or use existing tokens to access resources. If the pool is re-enabled, existing tokens grant access again. | -| `displayName` | `string` | A display name for the pool. Cannot exceed 32 characters. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_workloadIdentityPools_get` | `SELECT` | `locationsId, projectsId, workloadIdentityPoolsId` | Gets an individual WorkloadIdentityPool. | -| `projects_locations_workloadIdentityPools_list` | `SELECT` | `locationsId, projectsId` | Lists all non-deleted WorkloadIdentityPools in a project. If `show_deleted` is set to `true`, then deleted pools are also listed. | -| `projects_locations_workloadIdentityPools_create` | `INSERT` | `locationsId, projectsId` | Creates a new WorkloadIdentityPool. You cannot reuse the name of a deleted pool until 30 days after deletion. | -| `projects_locations_workloadIdentityPools_delete` | `DELETE` | `locationsId, projectsId, workloadIdentityPoolsId` | Deletes a WorkloadIdentityPool. You cannot use a deleted pool to exchange external credentials for Google Cloud credentials. However, deletion does not revoke credentials that have already been issued. Credentials issued for a deleted pool do not grant access to resources. If the pool is undeleted, and the credentials are not expired, they grant access again. You can undelete a pool for 30 days. After 30 days, deletion is permanent. You cannot update deleted pools. However, you can view and list them. | -| `projects_locations_workloadIdentityPools_patch` | `EXEC` | `locationsId, projectsId, workloadIdentityPoolsId` | Updates an existing WorkloadIdentityPool. | -| `projects_locations_workloadIdentityPools_undelete` | `EXEC` | `locationsId, projectsId, workloadIdentityPoolsId` | Undeletes a WorkloadIdentityPool, as long as it was deleted fewer than 30 days ago. | diff --git a/docs/google-docs/providers/google/iap/dest_groups/index.md b/docs/google-docs/providers/google/iap/dest_groups/index.md index 9d47821aef..cb4af5e614 100644 --- a/docs/google-docs/providers/google/iap/dest_groups/index.md +++ b/docs/google-docs/providers/google/iap/dest_groups/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Immutable. Identifier for the TunnelDestGroup. Must be unique within the project and contain only lower case letters (a-z) and dashes (-). | -| `fqdns` | `array` | Unordered list. List of FQDNs that this group applies to. | | `cidrs` | `array` | Unordered list. List of CIDRs that this group applies to. | +| `fqdns` | `array` | Unordered list. List of FQDNs that this group applies to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/iap/iam_policies/index.md b/docs/google-docs/providers/google/iap/iam_policies/index.md deleted file mode 100644 index a13485cc22..0000000000 --- a/docs/google-docs/providers/google/iap/iam_policies/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - iam_policies - - iap - - 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 ---- - - - -## Overview - - - - -
Nameiam_policies
TypeResource
Idgoogle.iap.iam_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `getIamPolicy` | `SELECT` | `v1Id` | Gets the access control policy for an Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api | -| `setIamPolicy` | `EXEC` | `v1Id` | Sets the access control policy for an Identity-Aware Proxy protected resource. Replaces any existing policy. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api | -| `testIamPermissions` | `EXEC` | `v1Id` | Returns permissions that a caller has on the Identity-Aware Proxy protected resource. More information about managing access via IAP can be found at: https://cloud.google.com/iap/docs/managing-access#managing_access_via_the_api | diff --git a/docs/google-docs/providers/google/iap/iap_iam_policies/index.md b/docs/google-docs/providers/google/iap/iap_iam_policies/index.md index 37b0a22c1a..f8d8ca3889 100644 --- a/docs/google-docs/providers/google/iap/iap_iam_policies/index.md +++ b/docs/google-docs/providers/google/iap/iap_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/iap/iap_settings/index.md b/docs/google-docs/providers/google/iap/iap_settings/index.md deleted file mode 100644 index e078a62da5..0000000000 --- a/docs/google-docs/providers/google/iap/iap_settings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: iap_settings -hide_title: false -hide_table_of_contents: false -keywords: - - iap_settings - - iap - - 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 ---- - - - -## Overview - - - - -
Nameiap_settings
TypeResource
Idgoogle.iap.iap_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Required. The resource name of the IAP protected resource. | -| `accessSettings` | `object` | Access related settings for IAP protected apps. | -| `applicationSettings` | `object` | Wrapper over application specific settings for IAP. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `getIapSettings` | `SELECT` | `v1Id` | diff --git a/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md b/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md index a7ed983466..651b7ce200 100644 --- a/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md +++ b/docs/google-docs/providers/google/iap/identity_aware_proxy_clients/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Unique identifier of the OAuth client. | -| `displayName` | `string` | Human-friendly name given to the OAuth client. | | `secret` | `string` | Output only. Client secret of the OAuth client. | +| `displayName` | `string` | Human-friendly name given to the OAuth client. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md b/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md index db6126a754..9b6510ebdc 100644 --- a/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md +++ b/docs/google-docs/providers/google/identitytoolkit/relyingparty_project_config/index.md @@ -27,18 +27,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `allowPasswordUser` | `boolean` | Whether to allow password user sign in or sign up. | | `changeEmailTemplate` | `object` | Template for an email template. | -| `apiKey` | `string` | Browser API key, needed when making http request to Apiary. | -| `enableAnonymousUser` | `boolean` | Whether anonymous user is enabled. | -| `idpConfig` | `array` | OAuth2 provider configuration. | -| `dynamicLinksDomain` | `string` | | -| `useEmailSending` | `boolean` | Whether to use email sending provided by Firebear. | -| `authorizedDomains` | `array` | Authorized domains. | | `projectId` | `string` | Project ID of the relying party. | -| `legacyResetPasswordTemplate` | `object` | Template for an email template. | | `resetPasswordTemplate` | `object` | Template for an email template. | | `verifyEmailTemplate` | `object` | Template for an email template. | +| `enableAnonymousUser` | `boolean` | Whether anonymous user is enabled. | +| `legacyResetPasswordTemplate` | `object` | Template for an email template. | +| `useEmailSending` | `boolean` | Whether to use email sending provided by Firebear. | +| `dynamicLinksDomain` | `string` | | +| `idpConfig` | `array` | OAuth2 provider configuration. | +| `allowPasswordUser` | `boolean` | Whether to allow password user sign in or sign up. | +| `apiKey` | `string` | Browser API key, needed when making http request to Apiary. | +| `authorizedDomains` | `array` | Authorized domains. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/ids/endpoints/index.md b/docs/google-docs/providers/google/ids/endpoints/index.md index 02f485b556..d715a72595 100644 --- a/docs/google-docs/providers/google/ids/endpoints/index.md +++ b/docs/google-docs/providers/google/ids/endpoints/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the endpoint. | | `description` | `string` | User-provided description of the endpoint | +| `severity` | `string` | Required. Lowest threat severity that this endpoint will alert on. | +| `state` | `string` | Output only. Current state of the endpoint. | +| `createTime` | `string` | Output only. The create time timestamp. | +| `updateTime` | `string` | Output only. The update time timestamp. | +| `endpointIp` | `string` | Output only. The IP address of the IDS Endpoint's ILB. | | `trafficLogs` | `boolean` | Whether the endpoint should report traffic logs in addition to threat logs. | +| `labels` | `object` | The labels of the endpoint. | | `threatExceptions` | `array` | List of threat IDs to be excepted from generating alerts. | | `endpointForwardingRule` | `string` | Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule. | -| `endpointIp` | `string` | Output only. The IP address of the IDS Endpoint's ILB. | | `network` | `string` | Required. The fully qualified URL of the network to which the IDS Endpoint is attached. | -| `state` | `string` | Output only. Current state of the endpoint. | -| `updateTime` | `string` | Output only. The update time timestamp. | -| `labels` | `object` | The labels of the endpoint. | -| `createTime` | `string` | Output only. The create time timestamp. | -| `severity` | `string` | Required. Lowest threat severity that this endpoint will alert on. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ids/endpoints_iam_audit_configs/index.md b/docs/google-docs/providers/google/ids/endpoints_iam_audit_configs/index.md deleted file mode 100644 index 75b26eae36..0000000000 --- a/docs/google-docs/providers/google/ids/endpoints_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: endpoints_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - endpoints_iam_audit_configs - - ids - - 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 ---- - - - -## Overview - - - - -
Nameendpoints_iam_audit_configs
TypeResource
Idgoogle.ids.endpoints_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_endpoints_getIamPolicy` | `SELECT` | `endpointsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/ids/endpoints_iam_bindings/index.md b/docs/google-docs/providers/google/ids/endpoints_iam_bindings/index.md deleted file mode 100644 index 9592ecde7d..0000000000 --- a/docs/google-docs/providers/google/ids/endpoints_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: endpoints_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - endpoints_iam_bindings - - ids - - 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 ---- - - - -## Overview - - - - -
Nameendpoints_iam_bindings
TypeResource
Idgoogle.ids.endpoints_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_endpoints_getIamPolicy` | `SELECT` | `endpointsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/ids/locations/index.md b/docs/google-docs/providers/google/ids/locations/index.md index 8376f6c4ff..095d426291 100644 --- a/docs/google-docs/providers/google/ids/locations/index.md +++ b/docs/google-docs/providers/google/ids/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ids/operations/index.md b/docs/google-docs/providers/google/ids/operations/index.md index 88c479dff9..ce19fb8eb6 100644 --- a/docs/google-docs/providers/google/ids/operations/index.md +++ b/docs/google-docs/providers/google/ids/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | -| `metadata` | `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. | | `response` | `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`. | | `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/integrations/auth_configs/index.md b/docs/google-docs/providers/google/integrations/auth_configs/index.md index c1a960f6af..2e60b79a8c 100644 --- a/docs/google-docs/providers/google/integrations/auth_configs/index.md +++ b/docs/google-docs/providers/google/integrations/auth_configs/index.md @@ -29,20 +29,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name of the SFDC instance projects/{project}/locations/{location}/authConfigs/{authConfig}. | | `description` | `string` | A description of the auth config. | -| `encryptedCredential` | `string` | Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. | -| `state` | `string` | The status of the auth config. | +| `expiryNotificationDuration` | `array` | User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. | +| `updateTime` | `string` | Output only. The timestamp when the auth config is modified. | +| `overrideValidTime` | `string` | User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings. | | `createTime` | `string` | Output only. The timestamp when the auth config is created. | +| `decryptedCredential` | `object` | Defines parameters for a single, canonical credential. | | `displayName` | `string` | Required. The name of the auth config. | -| `creatorEmail` | `string` | The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | -| `visibility` | `string` | The visibility of the auth config. | -| `expiryNotificationDuration` | `array` | User can define the time to receive notification after which the auth config becomes invalid. Support up to 30 days. Support granularity in hours. | +| `lastModifierEmail` | `string` | The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `validTime` | `string` | The time until the auth config is valid. Empty or max value is considered the auth config won't expire. | +| `encryptedCredential` | `string` | Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. | | `reason` | `string` | The reason / details of the current status. | -| `decryptedCredential` | `object` | Defines parameters for a single, canonical credential. | | `credentialType` | `string` | Credential type of the encrypted credential. | -| `validTime` | `string` | The time until the auth config is valid. Empty or max value is considered the auth config won't expire. | -| `updateTime` | `string` | Output only. The timestamp when the auth config is modified. | -| `lastModifierEmail` | `string` | The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | -| `overrideValidTime` | `string` | User provided expiry time to override. For the example of Salesforce, username/password credentials can be valid for 6 months depending on the instance settings. | +| `visibility` | `string` | The visibility of the auth config. | +| `creatorEmail` | `string` | The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `state` | `string` | The status of the auth config. | | `certificateId` | `string` | Certificate id for client certificate | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/integrations/certificates/index.md b/docs/google-docs/providers/google/integrations/certificates/index.md index aa944ec702..7c2f004d18 100644 --- a/docs/google-docs/providers/google/integrations/certificates/index.md +++ b/docs/google-docs/providers/google/integrations/certificates/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Auto generated primary key | | `description` | `string` | Description of the certificate | -| `validEndTime` | `string` | Output only. The timestamp after which certificate will expire | -| `displayName` | `string` | Name of the certificate | -| `validStartTime` | `string` | Output only. The timestamp after which certificate will be valid | | `requestorId` | `string` | Immutable. Requestor ID to be used to register certificate with trawler | -| `credentialId` | `string` | Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY | | `rawCertificate` | `object` | Contains client certificate information | +| `validStartTime` | `string` | Output only. The timestamp after which certificate will be valid | | `certificateStatus` | `string` | Status of the certificate | +| `validEndTime` | `string` | Output only. The timestamp after which certificate will expire | +| `credentialId` | `string` | Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY | +| `displayName` | `string` | Name of the certificate | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/integrations/connections/index.md b/docs/google-docs/providers/google/integrations/connections/index.md index 517b6e369e..db0b2e9c32 100644 --- a/docs/google-docs/providers/google/integrations/connections/index.md +++ b/docs/google-docs/providers/google/integrations/connections/index.md @@ -29,29 +29,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the Connection. Format: projects/{project}/locations/{location}/connections/{connection} | | `description` | `string` | Optional. Description of the resource. | -| `lockConfig` | `object` | Determines whether or no a connection is locked. If locked, a reason must be specified. | -| `envoyImageLocation` | `string` | Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} | -| `status` | `object` | ConnectionStatus indicates the state of the connection. | +| `imageLocation` | `string` | Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} | | `connectorVersionLaunchStage` | `string` | Output only. Flag to mark the version indicating the launch stage. | -| `destinationConfigs` | `array` | Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s). | -| `serviceDirectory` | `string` | Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" | -| `labels` | `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 | -| `configVariables` | `array` | Optional. Configuration for configuring the connection with an external system. | -| `connectorVersionInfraConfig` | `object` | This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version | +| `subscriptionType` | `string` | Output only. This subscription type enum states the subscription type of the project. | | `eventingEnablementType` | `string` | Optional. Eventing enablement type. Will be nil if eventing is not enabled. | +| `connectorVersion` | `string` | Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. | +| `envoyImageLocation` | `string` | Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} | +| `status` | `object` | ConnectionStatus indicates the state of the connection. | | `connectionRevision` | `string` | Output only. Connection revision. This field is only updated when the connection is created or updated by User. | -| `nodeConfig` | `object` | Node configuration for the connection. | -| `subscriptionType` | `string` | Output only. This subscription type enum states the subscription type of the project. | -| `logConfig` | `object` | Log configuration for the connection. | +| `configVariables` | `array` | Optional. Configuration for configuring the connection with an external system. | | `suspended` | `boolean` | Optional. Suspended indicates if a user has suspended a connection or not. | -| `serviceAccount` | `string` | Optional. Service account needed for runtime plane to access GCP resources. | | `sslConfig` | `object` | SSL Configuration of a connection | -| `connectorVersion` | `string` | Required. Connector version on which the connection is created. The format is: projects/*/locations/*/providers/*/connectors/*/versions/* Only global location is supported for ConnectorVersion resource. | -| `authConfig` | `object` | AuthConfig defines details of a authentication type. | +| `nodeConfig` | `object` | Node configuration for the connection. | +| `serviceAccount` | `string` | Optional. Service account needed for runtime plane to access GCP resources. | | `eventingConfig` | `object` | Eventing Configuration of a connection | -| `imageLocation` | `string` | Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} | +| `labels` | `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 | | `eventingRuntimeData` | `object` | Eventing runtime data has the details related to eventing managed by the system. | +| `destinationConfigs` | `array` | Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s). | | `updateTime` | `string` | Output only. Updated time. | +| `lockConfig` | `object` | Determines whether or no a connection is locked. If locked, a reason must be specified. | +| `serviceDirectory` | `string` | Output only. The name of the Service Directory service name. Used for Private Harpoon to resolve the ILB address. e.g. "projects/cloud-connectors-e2e-testing/locations/us-central1/namespaces/istio-system/services/istio-ingressgateway-connectors" | +| `authConfig` | `object` | AuthConfig defines details of a authentication type. | +| `connectorVersionInfraConfig` | `object` | This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version | +| `logConfig` | `object` | Log configuration for the connection. | | `createTime` | `string` | Output only. Created time. | ## Methods | Name | Accessible by | Required Params | diff --git a/docs/google-docs/providers/google/integrations/executions/index.md b/docs/google-docs/providers/google/integrations/executions/index.md index 2b08094b1c..a95a4f4982 100644 --- a/docs/google-docs/providers/google/integrations/executions/index.md +++ b/docs/google-docs/providers/google/integrations/executions/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Auto-generated primary key. | -| `requestParameters` | `object` | Event parameters come in as part of the request. | -| `triggerId` | `string` | The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks. | | `updateTime` | `string` | Output only. Last modified time of the execution. | -| `executionMethod` | `string` | The ways user posts this event. | -| `directSubExecutions` | `array` | Direct sub executions of the following Execution. | +| `requestParameters` | `object` | Event parameters come in as part of the request. | | `requestParams` | `array` | Event parameters come in as part of the request. | | `responseParams` | `array` | Event parameters come out as part of the response. | -| `eventExecutionDetails` | `object` | Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 | -| `responseParameters` | `object` | Event parameters returned as part of the response. | | `createTime` | `string` | Output only. Created time of the execution. | | `executionDetails` | `object` | Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. | +| `responseParameters` | `object` | Event parameters returned as part of the response. | +| `triggerId` | `string` | The trigger id of the integration trigger config. If both trigger_id and client_id is present, the integration is executed from the start tasks provided by the matching trigger config otherwise it is executed from the default start tasks. | +| `directSubExecutions` | `array` | Direct sub executions of the following Execution. | +| `eventExecutionDetails` | `object` | Contains the details of the execution info of this event: this includes the tasks execution details plus the event execution statistics. Next available id: 10 | +| `executionMethod` | `string` | The ways user posts this event. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md b/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md index 3e18470cc0..b02d380259 100644 --- a/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md +++ b/docs/google-docs/providers/google/integrations/runtime_action_schemas/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `outputSchema` | `string` | Output parameter schema for the action. | | `action` | `string` | Name of the action. | | `inputSchema` | `string` | Input parameter schema for the action. | -| `outputSchema` | `string` | Output parameter schema for the action. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md b/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md index bc258f3f45..b5fafb094f 100644 --- a/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md +++ b/docs/google-docs/providers/google/integrations/runtime_entity_schemas/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `fieldSchema` | `string` | List of fields in the entity. | | `arrayFieldSchema` | `string` | The above schema, but for an array of the associated entity. | | `entity` | `string` | Name of the entity. | +| `fieldSchema` | `string` | List of fields in the entity. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/integrations/sfdc_channels/index.md b/docs/google-docs/providers/google/integrations/sfdc_channels/index.md index 5b715e3d42..5fc68085dc 100644 --- a/docs/google-docs/providers/google/integrations/sfdc_channels/index.md +++ b/docs/google-docs/providers/google/integrations/sfdc_channels/index.md @@ -30,12 +30,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Resource name of the SFDC channel projects/{project}/locations/{location}/sfdcInstances/{sfdc_instance}/sfdcChannels/{sfdc_channel}. | | `description` | `string` | The description for this channel | | `updateTime` | `string` | Output only. Time when the channel was last updated | -| `lastReplayId` | `string` | Last sfdc messsage replay id for channel | -| `createTime` | `string` | Output only. Time when the channel is created | +| `isActive` | `boolean` | Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it. | +| `displayName` | `string` | Client level unique name/alias to easily reference a channel. | | `channelTopic` | `string` | The Channel topic defined by salesforce once an channel is opened | | `deleteTime` | `string` | Output only. Time when the channel was deleted. Empty if not deleted. | -| `displayName` | `string` | Client level unique name/alias to easily reference a channel. | -| `isActive` | `boolean` | Indicated if a channel has any active integrations referencing it. Set to false when the channel is created, and set to true if there is any integration published with the channel configured in it. | +| `lastReplayId` | `string` | Last sfdc messsage replay id for channel | +| `createTime` | `string` | Output only. Time when the channel is created | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/integrations/sfdc_instances/index.md b/docs/google-docs/providers/google/integrations/sfdc_instances/index.md index 611f7eae9e..edd028ad6d 100644 --- a/docs/google-docs/providers/google/integrations/sfdc_instances/index.md +++ b/docs/google-docs/providers/google/integrations/sfdc_instances/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name of the SFDC instance projects/{project}/locations/{location}/sfdcInstances/{sfdcInstance}. | | `description` | `string` | A description of the sfdc instance. | -| `serviceAuthority` | `string` | URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | -| `authConfigId` | `array` | A list of AuthConfigs that can be tried to open the channel to SFDC | | `displayName` | `string` | User selected unique name/alias to easily reference an instance. | +| `deleteTime` | `string` | Output only. Time when the instance was deleted. Empty if not deleted. | | `updateTime` | `string` | Output only. Time when the instance was last updated | | `createTime` | `string` | Output only. Time when the instance is created | -| `deleteTime` | `string` | Output only. Time when the instance was deleted. Empty if not deleted. | +| `authConfigId` | `array` | A list of AuthConfigs that can be tried to open the channel to SFDC | | `sfdcOrgId` | `string` | The SFDC Org Id. This is defined in salesforce. | +| `serviceAuthority` | `string` | URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/integrations/suspensions/index.md b/docs/google-docs/providers/google/integrations/suspensions/index.md index 50fa8845bd..91ddbf6c0c 100644 --- a/docs/google-docs/providers/google/integrations/suspensions/index.md +++ b/docs/google-docs/providers/google/integrations/suspensions/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for suspensions suspension/{suspension_id} | +| `suspensionConfig` | `object` | | +| `eventExecutionInfoId` | `string` | Required. ID of the associated execution. | +| `integration` | `string` | Required. The name of the originating integration. | +| `taskId` | `string` | Required. Task id of the associated SuspensionTask. | +| `approvalConfig` | `object` | Configurations for approving the Suspension. | | `audit` | `object` | Contains when and by whom the suspension was resolved. | | `state` | `string` | Required. State of this suspension, indicating what action a resolver has taken. | -| `integration` | `string` | Required. The name of the originating integration. | -| `suspensionConfig` | `object` | | | `createTime` | `string` | Output only. Auto-generated. | -| `approvalConfig` | `object` | Configurations for approving the Suspension. | -| `eventExecutionInfoId` | `string` | Required. ID of the associated execution. | | `lastModifyTime` | `string` | Output only. Auto-generated. | -| `taskId` | `string` | Required. Task id of the associated SuspensionTask. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/integrations/versions/index.md b/docs/google-docs/providers/google/integrations/versions/index.md index 8c9ff83d4f..5be24be2d7 100644 --- a/docs/google-docs/providers/google/integrations/versions/index.md +++ b/docs/google-docs/providers/google/integrations/versions/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Auto-generated primary key. Format: projects/{project}/locations/{location}/products/{product}/integrationtemplates/{integrationtemplate}/versions/{version} | | `description` | `string` | Optional. The templateversion description. Permitted format is alphanumeric with underscores and no spaces. | +| `status` | `string` | Optional. Generated by eventbus. User should not set it as an input. | +| `databasePersistencePolicy` | `string` | Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index. | | `lastModifierEmail` | `string` | Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `userLabel` | `string` | Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created. | | `createTime` | `string` | Output only. Auto-generated. | -| `databasePersistencePolicy` | `string` | Optional. Flag to disable database persistence for execution data, including event execution info, execution export info, execution metadata index and execution param index. | -| `errorCatcherConfigs` | `array` | Optional. Error Catch Task configuration for the IntegrationTemplateVersion. It's optional. | -| `parentIntegrationVersionId` | `string` | Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion | -| `triggerConfigs` | `array` | Optional. Trigger configurations. | -| `status` | `string` | Optional. Generated by eventbus. User should not set it as an input. | -| `templateParameters` | `object` | LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. | +| `teardown` | `object` | | | `snapshotNumber` | `string` | Output only. An increasing sequence that is set when a new snapshot is created. | -| `userLabel` | `string` | Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created. | | `updateTime` | `string` | Output only. Auto-generated. | +| `errorCatcherConfigs` | `array` | Optional. Error Catch Task configuration for the IntegrationTemplateVersion. It's optional. | +| `triggerConfigs` | `array` | Optional. Trigger configurations. | | `taskConfigs` | `array` | Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs. | -| `teardown` | `object` | | +| `parentIntegrationVersionId` | `string` | Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion | +| `templateParameters` | `object` | LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/jobs/companies/index.md b/docs/google-docs/providers/google/jobs/companies/index.md index af45209435..f8a4f4f0d5 100644 --- a/docs/google-docs/providers/google/jobs/companies/index.md +++ b/docs/google-docs/providers/google/jobs/companies/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required during company update. The resource name for a company. This is generated by the service when a company is created. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/foo/tenants/bar/companies/baz". | -| `externalId` | `string` | Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. | -| `eeoText` | `string` | Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. | -| `suspended` | `boolean` | Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. | -| `websiteUri` | `string` | The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. | | `careerSiteUri` | `string` | The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". | -| `derivedInfo` | `object` | Derived details about the company. | -| `imageUri` | `string` | A URI that hosts the employer's company logo. | -| `size` | `string` | The employer's company size. | | `keywordSearchableJobCustomAttributes` | `array` | This field is deprecated. Please set the searchability of the custom attribute in the Job.custom_attributes going forward. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword searches. Jobs with `string_values` under these specified field keys are returned if any of the values match the search keyword. Custom field values with parenthesis, brackets and special symbols are not searchable as-is, and those keyword queries must be surrounded by quotes. | +| `websiteUri` | `string` | The URI representing the company's primary web site or home page, for example, "https://www.google.com". The maximum number of allowed characters is 255. | +| `suspended` | `boolean` | Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy. | | `headquartersAddress` | `string` | The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in DerivedInfo.headquarters_location. | +| `size` | `string` | The employer's company size. | | `displayName` | `string` | Required. The display name of the company, for example, "Google LLC". | | `hiringAgency` | `boolean` | Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. | +| `derivedInfo` | `object` | Derived details about the company. | +| `eeoText` | `string` | Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500. | +| `imageUri` | `string` | A URI that hosts the employer's company logo. | +| `externalId` | `string` | Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/jobs/jobs/index.md b/docs/google-docs/providers/google/jobs/jobs/index.md index 4400673606..4442f19d67 100644 --- a/docs/google-docs/providers/google/jobs/jobs/index.md +++ b/docs/google-docs/providers/google/jobs/jobs/index.md @@ -29,34 +29,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required during job update. The resource name for the job. This is generated by the service when a job is created. The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique. | | `description` | `string` | Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000. | -| `jobLevel` | `string` | The experience level associated with the job, such as "Entry Level". | -| `title` | `string` | Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. | -| `jobBenefits` | `array` | The benefits included with the job. | +| `derivedInfo` | `object` | Derived details about the job posting. | | `requisitionId` | `string` | Required. The requisition ID, also referred to as the posting ID, is assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of postings. A job isn't allowed to be created if there is another job with the same company, language_code and requisition_id. The maximum number of allowed characters is 255. | -| `qualifications` | `string` | A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. | -| `jobStartTime` | `string` | The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. | -| `jobEndTime` | `string` | The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. | -| `postingExpireTime` | `string` | Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. | -| `customAttributes` | `object` | A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: `a-zA-Z*`. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. | -| `addresses` | `array` | Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. | -| `languageCode` | `string` | The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. | +| `jobBenefits` | `array` | The benefits included with the job. | | `postingPublishTime` | `string` | The timestamp this job posting was most recently published. The default value is the time the request arrives at the server. Invalid timestamps are ignored. | -| `visibility` | `string` | Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. | -| `degreeTypes` | `array` | The desired education degrees for the job, such as Bachelors, Masters. | -| `employmentTypes` | `array` | The employment type(s) of a job, for example, full time or part time. | +| `postingUpdateTime` | `string` | Output only. The timestamp when this job posting was last updated. | +| `postingExpireTime` | `string` | Strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be listed by the ListJobs API, but it can be retrieved with the GetJob API or updated with the UpdateJob API or deleted with the DeleteJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same company, language_code and requisition_id. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum number of open jobs over previous 7 days. If this threshold is exceeded, expired jobs are cleaned out in order of earliest expire time. Expired jobs are no longer accessible after they are cleaned out. Invalid timestamps are ignored, and treated as expire time not provided. If the timestamp is before the instant request is made, the job is treated as expired immediately on creation. This kind of job can not be updated. And when creating a job with past timestamp, the posting_publish_time must be set before posting_expire_time. The purpose of this feature is to allow other objects, such as Application, to refer a job that didn't exist in the system prior to becoming expired. If you want to modify a job that was expired on creation, delete it and create a new one. If this value isn't provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value isn't provided on job update, it depends on the field masks set by UpdateJobRequest.update_mask. If the field masks include job_end_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated. | | `incentives` | `string` | A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000. | -| `promotionValue` | `integer` | A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. | -| `applicationInfo` | `object` | Application related details of a job posting. | -| `postingRegion` | `string` | The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. | +| `degreeTypes` | `array` | The desired education degrees for the job, such as Bachelors, Masters. | | `postingCreateTime` | `string` | Output only. The timestamp when this job posting was created. | -| `responsibilities` | `string` | A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. | -| `postingUpdateTime` | `string` | Output only. The timestamp when this job posting was last updated. | | `department` | `string` | The department or functional area within the company with the open position. The maximum number of allowed characters is 255. | -| `companyDisplayName` | `string` | Output only. Display name of the company listing the job. | +| `jobStartTime` | `string` | The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. | +| `visibility` | `string` | Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. | +| `postingRegion` | `string` | The job PostingRegion (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job posting if an exact location match isn't specified. If this field is set to PostingRegion.NATION or PostingRegion.ADMINISTRATIVE_AREA, setting job Job.addresses to the same location level as this field is strongly recommended. | +| `employmentTypes` | `array` | The employment type(s) of a job, for example, full time or part time. | +| `customAttributes` | `object` | A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. The keys of the map are strings up to 64 bytes and must match the pattern: `a-zA-Z*`. For example, key0LikeThis or KEY_1_LIKE_THIS. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB. | +| `jobLevel` | `string` | The experience level associated with the job, such as "Entry Level". | | `processingOptions` | `object` | Options for job processing. | +| `addresses` | `array` | Strongly recommended for the best service experience. Location(s) where the employer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', and so on.) as multiple jobs with the same company, language_code and requisition_id are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. Jobs with multiple addresses must have their addresses with the same LocationType to allow location filtering to work properly. (For example, a Job with addresses "1600 Amphitheatre Parkway, Mountain View, CA, USA" and "London, UK" may not have location filters applied correctly at search time since the first is a LocationType.STREET_ADDRESS and the second is a LocationType.LOCALITY.) If a job needs to have multiple addresses, it is suggested to split it into multiple jobs with same LocationTypes. The maximum number of allowed characters is 500. | | `company` | `string` | Required. The resource name of the company listing the job. The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}". For example, "projects/foo/tenants/bar/companies/baz". | +| `jobEndTime` | `string` | The end timestamp of the job. Typically this field is used for contracting engagements. Invalid timestamps are ignored. | +| `qualifications` | `string` | A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. | +| `promotionValue` | `integer` | A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0. | +| `applicationInfo` | `object` | Application related details of a job posting. | +| `responsibilities` | `string` | A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000. | +| `title` | `string` | Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. | | `compensationInfo` | `object` | Job compensation details. | -| `derivedInfo` | `object` | Derived details about the job posting. | +| `companyDisplayName` | `string` | Output only. Display name of the company listing the job. | +| `languageCode` | `string` | The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/jobs/jobs_batch/index.md b/docs/google-docs/providers/google/jobs/jobs_batch/index.md deleted file mode 100644 index be560b126d..0000000000 --- a/docs/google-docs/providers/google/jobs/jobs_batch/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: jobs_batch -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_batch - - jobs - - 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 ---- - - - -## Overview - - - - -
Namejobs_batch
TypeResource
Idgoogle.jobs.jobs_batch
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_tenants_jobs_batchCreate` | `INSERT` | `projectsId, tenantsId` | diff --git a/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md b/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md index 5629a1c01f..352d5cfd79 100644 --- a/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md +++ b/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this CryptoKey in the format `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | | `versionTemplate` | `object` | A CryptoKeyVersionTemplate specifies the properties to use when creating a new CryptoKeyVersion, either manually with CreateCryptoKeyVersion or automatically as a result of auto-rotation. | +| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | +| `primary` | `object` | A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS. | | `destroyScheduledDuration` | `string` | Immutable. The period of time that versions of this key spend in the DESTROY_SCHEDULED state before transitioning to DESTROYED. If not specified at creation time, the default duration is 24 hours. | | `labels` | `object` | Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). | -| `nextRotationTime` | `string` | At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | -| `createTime` | `string` | Output only. The time at which this CryptoKey was created. | | `rotationPeriod` | `string` | next_rotation_time will be advanced by this period when the service automatically rotates a key. Must be at least 24 hours and at most 876,000 hours. If rotation_period is set, next_rotation_time must also be set. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | -| `cryptoKeyBackend` | `string` | Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. | -| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | -| `primary` | `object` | A CryptoKeyVersion represents an individual cryptographic key, and the associated key material. An ENABLED version can be used for cryptographic operations. For security reasons, the raw cryptographic key material represented by a CryptoKeyVersion can never be viewed or exported. It can only be used to encrypt, decrypt, or sign data when an authorized user or application invokes Cloud KMS. | | `purpose` | `string` | Immutable. The immutable purpose of this CryptoKey. | +| `cryptoKeyBackend` | `string` | Immutable. The resource name of the backend environment where the key material for all CryptoKeyVersions associated with this CryptoKey reside and where all related cryptographic operations are performed. Only applicable if CryptoKeyVersions have a ProtectionLevel of EXTERNAL_VPC, with the resource name in the format `projects/*/locations/*/ekmConnections/*`. Note, this list is non-exhaustive and may apply to additional ProtectionLevels in the future. | +| `createTime` | `string` | Output only. The time at which this CryptoKey was created. | +| `nextRotationTime` | `string` | At next_rotation_time, the Key Management Service will automatically: 1. Create a new version of this CryptoKey. 2. Mark the new version as primary. Key rotations performed manually via CreateCryptoKeyVersion and UpdateCryptoKeyPrimaryVersion do not affect next_rotation_time. Keys with purpose ENCRYPT_DECRYPT support automatic rotation. For other keys, this field must be omitted. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/libraryagent/books/index.md b/docs/google-docs/providers/google/libraryagent/books/index.md index 33da1c2a1c..c604919782 100644 --- a/docs/google-docs/providers/google/libraryagent/books/index.md +++ b/docs/google-docs/providers/google/libraryagent/books/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the book. Book names have the form `shelves/{shelf_id}/books/{book_id}`. The name is ignored when creating a book. | +| `title` | `string` | The title of the book. | | `author` | `string` | The name of the book author. | | `read` | `boolean` | Value indicating whether the book has been read. | -| `title` | `string` | The title of the book. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/lifesciences/locations/index.md b/docs/google-docs/providers/google/lifesciences/locations/index.md index cda3317b05..26c85b1376 100644 --- a/docs/google-docs/providers/google/lifesciences/locations/index.md +++ b/docs/google-docs/providers/google/lifesciences/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/lifesciences/operations/index.md b/docs/google-docs/providers/google/lifesciences/operations/index.md index 735064fc8f..98dd28165c 100644 --- a/docs/google-docs/providers/google/lifesciences/operations/index.md +++ b/docs/google-docs/providers/google/lifesciences/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name for the operation. This may be passed to the other operation methods to retrieve information about the operation's status. | -| `metadata` | `object` | An Metadata object. This will always be returned with the Operation. | | `response` | `object` | An Empty object. | | `done` | `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. | | `error` | `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). | +| `metadata` | `object` | An Metadata object. This will always be returned with the Operation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md b/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md index 940287765f..9079ad7fb8 100644 --- a/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md +++ b/docs/google-docs/providers/google/logging/billing_accounts_settings/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the settings. | -| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | | `storageLocation` | `string` | Optional. The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided. The use cases includes: The location of _Default and _Required log bucket for newly created projects and folders.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets. | | `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | | `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | +| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/logging/buckets/index.md b/docs/google-docs/providers/google/logging/buckets/index.md index 7e25183779..1299ac0ad3 100644 --- a/docs/google-docs/providers/google/logging/buckets/index.md +++ b/docs/google-docs/providers/google/logging/buckets/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed. | | `description` | `string` | Describes this bucket. | +| `indexConfigs` | `array` | A list of indexed fields and related configuration data. | +| `analyticsEnabled` | `boolean` | Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. | | `lifecycleState` | `string` | Output only. The bucket lifecycle state. | -| `cmekSettings` | `object` | Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `createTime` | `string` | Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. | -| `updateTime` | `string` | Output only. The last update timestamp of the bucket. | | `retentionDays` | `integer` | Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used. | +| `updateTime` | `string` | Output only. The last update timestamp of the bucket. | | `restrictedFields` | `array` | Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz) | -| `analyticsEnabled` | `boolean` | Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. | -| `indexConfigs` | `array` | A list of indexed fields and related configuration data. | +| `cmekSettings` | `object` | Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `locked` | `boolean` | Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty. | +| `createTime` | `string` | Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/cmek_settings/index.md b/docs/google-docs/providers/google/logging/cmek_settings/index.md index 0557fc04d9..9a5f2190cb 100644 --- a/docs/google-docs/providers/google/logging/cmek_settings/index.md +++ b/docs/google-docs/providers/google/logging/cmek_settings/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the CMEK settings. | +| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyName` | `string` | The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyVersionName` | `string` | The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion. | -| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/exclusions/index.md b/docs/google-docs/providers/google/logging/exclusions/index.md index 35467526aa..cc94d2f718 100644 --- a/docs/google-docs/providers/google/logging/exclusions/index.md +++ b/docs/google-docs/providers/google/logging/exclusions/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. | | `description` | `string` | Optional. A description of this exclusion. | -| `filter` | `string` | Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries.For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99) | | `updateTime` | `string` | Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions. | | `createTime` | `string` | Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions. | | `disabled` | `boolean` | Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field. | +| `filter` | `string` | Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries.For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99) | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/folders/index.md b/docs/google-docs/providers/google/logging/folders/index.md deleted file mode 100644 index eb10461e54..0000000000 --- a/docs/google-docs/providers/google/logging/folders/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: folders -hide_title: false -hide_table_of_contents: false -keywords: - - folders - - logging - - 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 ---- - - - -## Overview - - - - -
Namefolders
TypeResource
Idgoogle.logging.folders
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateSettings` | `EXEC` | `foldersId` | diff --git a/docs/google-docs/providers/google/logging/folders_cmek_settings/index.md b/docs/google-docs/providers/google/logging/folders_cmek_settings/index.md deleted file mode 100644 index 8f43e8c295..0000000000 --- a/docs/google-docs/providers/google/logging/folders_cmek_settings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: folders_cmek_settings -hide_title: false -hide_table_of_contents: false -keywords: - - folders_cmek_settings - - logging - - 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 ---- - - - -## Overview - - - - -
Namefolders_cmek_settings
TypeResource
Idgoogle.logging.folders_cmek_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the CMEK settings. | -| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsKeyName` | `string` | The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsKeyVersionName` | `string` | The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `folders_getCmekSettings` | `SELECT` | `foldersId` | diff --git a/docs/google-docs/providers/google/logging/folders_settings/index.md b/docs/google-docs/providers/google/logging/folders_settings/index.md deleted file mode 100644 index 0e02098416..0000000000 --- a/docs/google-docs/providers/google/logging/folders_settings/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: folders_settings -hide_title: false -hide_table_of_contents: false -keywords: - - folders_settings - - logging - - 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 ---- - - - -## Overview - - - - -
Namefolders_settings
TypeResource
Idgoogle.logging.folders_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the settings. | -| `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | -| `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `storageLocation` | `string` | Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example europe-west1. This setting does not affect the location of custom log buckets. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `folders_getSettings` | `SELECT` | `foldersId` | diff --git a/docs/google-docs/providers/google/logging/locations/index.md b/docs/google-docs/providers/google/logging/locations/index.md index 671ff27a65..ecdfc31541 100644 --- a/docs/google-docs/providers/google/logging/locations/index.md +++ b/docs/google-docs/providers/google/logging/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" | -| `locationId` | `string` | The canonical id for this location. For example: "us-east1". | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: "us-east1". | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/logging/index.md b/docs/google-docs/providers/google/logging/logging/index.md deleted file mode 100644 index 8de97a2f99..0000000000 --- a/docs/google-docs/providers/google/logging/logging/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: logging -hide_title: false -hide_table_of_contents: false -keywords: - - logging - - logging - - 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 ---- - - - -## Overview - - - - -
Namelogging
TypeResource
Idgoogle.logging.logging
- -## 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 -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `updateCmekSettings` | `EXEC` | `name` | Updates the Log Router CMEK settings for the given resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `updateSettings` | `EXEC` | `name` | Updates the Log Router settings for the given resource.Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | diff --git a/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md b/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md index 21ac04b121..4f6142d2f1 100644 --- a/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md +++ b/docs/google-docs/providers/google/logging/logging_cmek_settings/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the CMEK settings. | -| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyName` | `string` | The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the needed cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsKeyVersionName` | `string` | The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion. | +| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/logging_settings/index.md b/docs/google-docs/providers/google/logging/logging_settings/index.md index 8f40860ccf..89f129a3b6 100644 --- a/docs/google-docs/providers/google/logging/logging_settings/index.md +++ b/docs/google-docs/providers/google/logging/logging_settings/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the settings. | -| `storageLocation` | `string` | Optional. The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided. The use cases includes: The location of _Default and _Required log bucket for newly created projects and folders.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets. | -| `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | | `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | | `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | +| `storageLocation` | `string` | Optional. The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided. The use cases includes: The location of _Default and _Required log bucket for newly created projects and folders.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets. | +| `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/metrics/index.md b/docs/google-docs/providers/google/logging/metrics/index.md index 936f0f83ae..58aff8d4db 100644 --- a/docs/google-docs/providers/google/logging/metrics/index.md +++ b/docs/google-docs/providers/google/logging/metrics/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field's value is "nginx/requests". | | `description` | `string` | Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters. | +| `version` | `string` | Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. | +| `metricDescriptor` | `object` | Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. | +| `filter` | `string` | Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters. | | `bucketOptions` | `object` | BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. | +| `labelExtractors` | `object` | Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project. | | `bucketName` | `string` | Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric. | | `updateTime` | `string` | Output only. The last update timestamp of the metric.This field may not be present for older metrics. | -| `labelExtractors` | `object` | Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project. | | `valueExtractor` | `string` | Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\d+).*") | -| `disabled` | `boolean` | Optional. If set to True, then this metric is disabled and it does not generate any points. | | `createTime` | `string` | Output only. The creation timestamp of the metric.This field may not be present for older metrics. | -| `version` | `string` | Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. | -| `filter` | `string` | Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters. | -| `metricDescriptor` | `object` | Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. | +| `disabled` | `boolean` | Optional. If set to True, then this metric is disabled and it does not generate any points. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md b/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md index 741ee72caa..52909ae9db 100644 --- a/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md +++ b/docs/google-docs/providers/google/logging/monitored_resource_descriptors/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}". | | `description` | `string` | Optional. A detailed description of the monitored resource type that might be used in documentation. | -| `type` | `string` | Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). | | `displayName` | `string` | Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database". | | `labels` | `array` | Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone". | | `launchStage` | `string` | Optional. The launch stage of the monitored resource definition. | +| `type` | `string` | Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/logging/organizations/index.md b/docs/google-docs/providers/google/logging/organizations/index.md deleted file mode 100644 index 43e0cb56e9..0000000000 --- a/docs/google-docs/providers/google/logging/organizations/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: organizations -hide_title: false -hide_table_of_contents: false -keywords: - - organizations - - logging - - 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 ---- - - - -## Overview - - - - -
Nameorganizations
TypeResource
Idgoogle.logging.organizations
- -## 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 -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `updateCmekSettings` | `EXEC` | `organizationsId` | Updates the Log Router CMEK settings for the given resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateCmekSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `updateSettings` | `EXEC` | `organizationsId` | Updates the Log Router settings for the given resource.Note: Settings for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.UpdateSettings will fail if 1) kms_key_name is invalid, or 2) the associated service account does not have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key, or 3) access to the key is disabled. 4) location_id is not supported by Logging. 5) location_id violate OrgPolicy.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | diff --git a/docs/google-docs/providers/google/logging/organizations_cmek_settings/index.md b/docs/google-docs/providers/google/logging/organizations_cmek_settings/index.md deleted file mode 100644 index 205c190813..0000000000 --- a/docs/google-docs/providers/google/logging/organizations_cmek_settings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: organizations_cmek_settings -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_cmek_settings - - logging - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_cmek_settings
TypeResource
Idgoogle.logging.organizations_cmek_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the CMEK settings. | -| `kmsKeyName` | `string` | The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsKeyVersionName` | `string` | The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version. | -| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getCmekSettings` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/logging/organizations_settings/index.md b/docs/google-docs/providers/google/logging/organizations_settings/index.md deleted file mode 100644 index 44fec35edd..0000000000 --- a/docs/google-docs/providers/google/logging/organizations_settings/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: organizations_settings -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_settings - - logging - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_settings
TypeResource
Idgoogle.logging.organizations_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the settings. | -| `storageLocation` | `string` | Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example europe-west1. This setting does not affect the location of custom log buckets. | -| `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | -| `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getSettings` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/logging/projects_cmek_settings/index.md b/docs/google-docs/providers/google/logging/projects_cmek_settings/index.md deleted file mode 100644 index 96d78470eb..0000000000 --- a/docs/google-docs/providers/google/logging/projects_cmek_settings/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: projects_cmek_settings -hide_title: false -hide_table_of_contents: false -keywords: - - projects_cmek_settings - - logging - - 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 ---- - - - -## Overview - - - - -
Nameprojects_cmek_settings
TypeResource
Idgoogle.logging.projects_cmek_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the CMEK settings. | -| `kmsKeyVersionName` | `string` | The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version. | -| `serviceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsKeyName` | `string` | The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getCmekSettings` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/logging/projects_settings/index.md b/docs/google-docs/providers/google/logging/projects_settings/index.md deleted file mode 100644 index d7b8e26406..0000000000 --- a/docs/google-docs/providers/google/logging/projects_settings/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: projects_settings -hide_title: false -hide_table_of_contents: false -keywords: - - projects_settings - - logging - - 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 ---- - - - -## Overview - - - - -
Nameprojects_settings
TypeResource
Idgoogle.logging.projects_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the settings. | -| `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | -| `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `storageLocation` | `string` | Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example europe-west1. This setting does not affect the location of custom log buckets. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getSettings` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/logging/settings/index.md b/docs/google-docs/providers/google/logging/settings/index.md index db45035297..2506417701 100644 --- a/docs/google-docs/providers/google/logging/settings/index.md +++ b/docs/google-docs/providers/google/logging/settings/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the settings. | -| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | -| `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | | `storageLocation` | `string` | Optional. The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided. The use cases includes: The location of _Default and _Required log bucket for newly created projects and folders.Example value: europe-west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets. | | `disableDefaultSink` | `boolean` | Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. | | `kmsKeyName` | `string` | Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | +| `kmsServiceAccountId` | `string` | Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. | +| `loggingServiceAccountId` | `string` | Output only. The service account for the given container. Sinks use this service account as their writer_identity if no custom service account is provided. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/sinks/index.md b/docs/google-docs/providers/google/logging/sinks/index.md index f558c1fdab..b8e4ce3afc 100644 --- a/docs/google-docs/providers/google/logging/sinks/index.md +++ b/docs/google-docs/providers/google/logging/sinks/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric. | | `description` | `string` | Optional. A description of this sink.The maximum length of the description is 8000 characters. | -| `includeChildren` | `boolean` | Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent.To only export entries from certain child projects, filter on the project part of the log name:logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance | -| `outputVersionFormat` | `string` | Deprecated. This field is unused. | -| `writerIdentity` | `string` | Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. | -| `updateTime` | `string` | Output only. The last update timestamp of the sink.This field may not be present for older sinks. | +| `destination` | `string` | Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" "logging.googleapis.com/projects/[PROJECT_ID]" "logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks (https://cloud.google.com/logging/docs/api/tasks/exporting-logs). | | `disabled` | `boolean` | Optional. If set to true, then this sink is disabled and it does not export any log entries. | -| `createTime` | `string` | Output only. The creation timestamp of the sink.This field may not be present for older sinks. | | `exclusions` | `array` | Optional. Log entries that match any of these exclusion filters will not be exported.If a log entry is matched by both filter and one of exclusion_filters it will not be exported. | +| `outputVersionFormat` | `string` | Deprecated. This field is unused. | | `filter` | `string` | Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter.For example:logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR | -| `destination` | `string` | Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" "logging.googleapis.com/projects/[PROJECT_ID]" "logging.googleapis.com/projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" The sink's writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks (https://cloud.google.com/logging/docs/api/tasks/exporting-logs). | +| `includeChildren` | `boolean` | Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink's parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink's parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink's filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink's parent.To only export entries from certain child projects, filter on the project part of the log name:logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance | +| `writerIdentity` | `string` | Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required. | +| `createTime` | `string` | Output only. The creation timestamp of the sink.This field may not be present for older sinks. | | `bigqueryOptions` | `object` | Options that change functionality of a sink exporting data to BigQuery. | +| `updateTime` | `string` | Output only. The last update timestamp of the sink.This field may not be present for older sinks. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/views/index.md b/docs/google-docs/providers/google/logging/views/index.md index 4a8afa438e..9a356365a3 100644 --- a/docs/google-docs/providers/google/logging/views/index.md +++ b/docs/google-docs/providers/google/logging/views/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view | | `description` | `string` | Describes this view. | -| `updateTime` | `string` | Output only. The last update timestamp of the view. | | `createTime` | `string` | Output only. The creation timestamp of the view. | | `filter` | `string` | Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout") | +| `updateTime` | `string` | Output only. The last update timestamp of the view. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/backups/index.md b/docs/google-docs/providers/google/managedidentities/backups/index.md index 6ec8e26e98..03ebb4b608 100644 --- a/docs/google-docs/providers/google/managedidentities/backups/index.md +++ b/docs/google-docs/providers/google/managedidentities/backups/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique name of the Backup in the form of `projects/{project_id}/locations/global/domains/{domain_name}/backups/{name}` | +| `state` | `string` | Output only. The current state of the backup. | | `statusMessage` | `string` | Output only. Additional information about the current status of this backup, if available. | | `type` | `string` | Output only. Indicates whether it’s an on-demand backup or scheduled. | | `updateTime` | `string` | Output only. Last update time. | | `createTime` | `string` | Output only. The time the backups was created. | | `labels` | `object` | Optional. Resource labels to represent user provided metadata. | -| `state` | `string` | Output only. The current state of the backup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/backups_iam_bindings/index.md b/docs/google-docs/providers/google/managedidentities/backups_iam_bindings/index.md deleted file mode 100644 index 634db71770..0000000000 --- a/docs/google-docs/providers/google/managedidentities/backups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: backups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_bindings - - managedidentities - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_bindings
TypeResource
Idgoogle.managedidentities.backups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_domains_backups_getIamPolicy` | `SELECT` | `backupsId, domainsId, projectsId` | diff --git a/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md b/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md index 8674016637..0954671ad4 100644 --- a/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/managedidentities/backups_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/domains/index.md b/docs/google-docs/providers/google/managedidentities/domains/index.md index 5b1cbc8660..aef2846eda 100644 --- a/docs/google-docs/providers/google/managedidentities/domains/index.md +++ b/docs/google-docs/providers/google/managedidentities/domains/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The unique name of the domain using the form: `projects/{project_id}/locations/global/domains/{domain_name}`. | -| `createTime` | `string` | Output only. The time the instance was created. | -| `fqdn` | `string` | Output only. The fully-qualified domain name of the exposed domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory set up on an internal network. | -| `state` | `string` | Output only. The current state of this domain. | -| `admin` | `string` | Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, `setupadmin` will be used. | +| `auditLogsEnabled` | `boolean` | Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled. | +| `labels` | `object` | Optional. Resource labels that can contain user-provided metadata. | | `locations` | `array` | Required. Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block. | | `statusMessage` | `string` | Output only. Additional information about the current status of this domain, if available. | -| `reservedIpRange` | `string` | Required. The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in [Domain].[authorized_networks]. | -| `auditLogsEnabled` | `boolean` | Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled. | -| `trusts` | `array` | Output only. The current trusts associated with the domain. | +| `fqdn` | `string` | Output only. The fully-qualified domain name of the exposed domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory set up on an internal network. | | `updateTime` | `string` | Output only. The last update time. | +| `trusts` | `array` | Output only. The current trusts associated with the domain. | +| `admin` | `string` | Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, `setupadmin` will be used. | +| `state` | `string` | Output only. The current state of this domain. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `reservedIpRange` | `string` | Required. The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in [Domain].[authorized_networks]. | | `authorizedNetworks` | `array` | Optional. The full names of the Google Compute Engine [networks](/compute/docs/networks-and-firewalls#networks) the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in `authorized_networks`. If CIDR subnets overlap between networks, domain creation will fail. | -| `labels` | `object` | Optional. Resource labels that can contain user-provided metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/domains_iam_bindings/index.md b/docs/google-docs/providers/google/managedidentities/domains_iam_bindings/index.md deleted file mode 100644 index 1d109d5ad3..0000000000 --- a/docs/google-docs/providers/google/managedidentities/domains_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: domains_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - domains_iam_bindings - - managedidentities - - 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 ---- - - - -## Overview - - - - -
Namedomains_iam_bindings
TypeResource
Idgoogle.managedidentities.domains_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_domains_getIamPolicy` | `SELECT` | `domainsId, projectsId` | diff --git a/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md b/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md index bacc052c66..b18ca844e3 100644 --- a/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md +++ b/docs/google-docs/providers/google/managedidentities/domains_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/locations/index.md b/docs/google-docs/providers/google/managedidentities/locations/index.md index 60dfeff922..533f187db2 100644 --- a/docs/google-docs/providers/google/managedidentities/locations/index.md +++ b/docs/google-docs/providers/google/managedidentities/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | -| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/operations/index.md b/docs/google-docs/providers/google/managedidentities/operations/index.md index 6c556d3dc6..16fdf8f44f 100644 --- a/docs/google-docs/providers/google/managedidentities/operations/index.md +++ b/docs/google-docs/providers/google/managedidentities/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/peerings/index.md b/docs/google-docs/providers/google/managedidentities/peerings/index.md index be63ab3fba..456d517a86 100644 --- a/docs/google-docs/providers/google/managedidentities/peerings/index.md +++ b/docs/google-docs/providers/google/managedidentities/peerings/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Unique name of the peering in this scope including projects and location using the form: `projects/{project_id}/locations/global/peerings/{peering_id}`. | -| `domainResource` | `string` | Required. Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form: `projects/{project_id}/locations/global/domains/{domain_name}` | | `labels` | `object` | Optional. Resource labels to represent user-provided metadata. | | `state` | `string` | Output only. The current state of this Peering. | | `statusMessage` | `string` | Output only. Additional information about the current status of this peering, if available. | | `updateTime` | `string` | Output only. Last update time. | | `authorizedNetwork` | `string` | Required. The full names of the Google Compute Engine [networks](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. Caller needs to make sure that CIDR subnets do not overlap between networks, else peering creation will fail. | | `createTime` | `string` | Output only. The time the instance was created. | +| `domainResource` | `string` | Required. Full domain resource path for the Managed AD Domain involved in peering. The resource path should be in the form: `projects/{project_id}/locations/global/domains/{domain_name}` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/peerings_iam_bindings/index.md b/docs/google-docs/providers/google/managedidentities/peerings_iam_bindings/index.md deleted file mode 100644 index 04a32ca9f3..0000000000 --- a/docs/google-docs/providers/google/managedidentities/peerings_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: peerings_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - peerings_iam_bindings - - managedidentities - - 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 ---- - - - -## Overview - - - - -
Namepeerings_iam_bindings
TypeResource
Idgoogle.managedidentities.peerings_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_peerings_getIamPolicy` | `SELECT` | `peeringsId, projectsId` | diff --git a/docs/google-docs/providers/google/managedidentities/peerings_iam_policies/index.md b/docs/google-docs/providers/google/managedidentities/peerings_iam_policies/index.md index 8f35d0d8af..c94a27458c 100644 --- a/docs/google-docs/providers/google/managedidentities/peerings_iam_policies/index.md +++ b/docs/google-docs/providers/google/managedidentities/peerings_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/memcache/instances/index.md b/docs/google-docs/providers/google/memcache/instances/index.md index 3a2ebb54a7..3cc8df0c81 100644 --- a/docs/google-docs/providers/google/memcache/instances/index.md +++ b/docs/google-docs/providers/google/memcache/instances/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Memcached instances are managed and addressed at the regional level so `location_id` here refers to a Google Cloud region; however, users may choose which zones Memcached nodes should be provisioned in within an instance. Refer to zones field for more details. | -| `memcacheVersion` | `string` | The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version. | -| `labels` | `object` | Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources | -| `memcacheNodes` | `array` | Output only. List of Memcached nodes. Refer to Node message for more details. | -| `maintenancePolicy` | `object` | Maintenance policy per instance. | -| `memcacheFullVersion` | `string` | Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16". | -| `nodeConfig` | `object` | Configuration for a Memcached Node. | -| `updateTime` | `string` | Output only. The time the instance was updated. | -| `state` | `string` | Output only. The state of this Memcached instance. | | `displayName` | `string` | User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters. | -| `parameters` | `object` | | -| `createTime` | `string` | Output only. The time the instance was created. | +| `authorizedNetwork` | `string` | The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. | | `nodeCount` | `integer` | Required. Number of nodes in the Memcached instance. | -| `reservedIpRangeId` | `array` | Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. | +| `labels` | `object` | Resource labels to represent user-provided metadata. Refer to cloud documentation on labels for more details. https://cloud.google.com/compute/docs/labeling-resources | | `instanceMessages` | `array` | List of messages that describe the current state of the Memcached instance. | | `maintenanceSchedule` | `object` | Upcoming maintenance schedule. | -| `discoveryEndpoint` | `string` | Output only. Endpoint for the Discovery API. | | `zones` | `array` | Zones in which Memcached nodes should be provisioned. Memcached nodes will be equally distributed across these zones. If not provided, the service will by default create nodes in all zones in the region for the instance. | -| `authorizedNetwork` | `string` | The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used. | +| `parameters` | `object` | | +| `memcacheFullVersion` | `string` | Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16". | +| `state` | `string` | Output only. The state of this Memcached instance. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `maintenancePolicy` | `object` | Maintenance policy per instance. | +| `updateTime` | `string` | Output only. The time the instance was updated. | +| `discoveryEndpoint` | `string` | Output only. Endpoint for the Discovery API. | +| `nodeConfig` | `object` | Configuration for a Memcached Node. | +| `reservedIpRangeId` | `array` | Optional. Contains the id of allocated IP address ranges associated with the private service access connection for example, "test-default" associated with IP range 10.0.0.0/29. | +| `memcacheNodes` | `array` | Output only. List of Memcached nodes. Refer to Node message for more details. | +| `memcacheVersion` | `string` | The major version of Memcached software. If not provided, latest supported version will be used. Currently the latest supported major version is `MEMCACHE_1_5`. The minor version will be automatically determined by our system based on the latest supported minor version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/memcache/locations/index.md b/docs/google-docs/providers/google/memcache/locations/index.md index d77bf1bbb2..8b0d77bb88 100644 --- a/docs/google-docs/providers/google/memcache/locations/index.md +++ b/docs/google-docs/providers/google/memcache/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/memcache/operations/index.md b/docs/google-docs/providers/google/memcache/operations/index.md index ef358b8f61..2543db1e03 100644 --- a/docs/google-docs/providers/google/memcache/operations/index.md +++ b/docs/google-docs/providers/google/memcache/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/backups/index.md b/docs/google-docs/providers/google/metastore/backups/index.md index 156cfe45f6..d9879e2819 100644 --- a/docs/google-docs/providers/google/metastore/backups/index.md +++ b/docs/google-docs/providers/google/metastore/backups/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The relative resource name of the backup, in the following form:projects/{project_number}/locations/{location_id}/services/{service_id}/backups/{backup_id} | | `description` | `string` | The description of the backup. | +| `createTime` | `string` | Output only. The time when the backup was started. | | `endTime` | `string` | Output only. The time when the backup finished creating. | | `restoringServices` | `array` | Output only. Services that are restoring from the backup. | | `serviceRevision` | `object` | A managed metastore service that serves metadata queries. | | `state` | `string` | Output only. The current state of the backup. | -| `createTime` | `string` | Output only. The time when the backup was started. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/backups_iam_audit_configs/index.md b/docs/google-docs/providers/google/metastore/backups_iam_audit_configs/index.md deleted file mode 100644 index d1f4525d04..0000000000 --- a/docs/google-docs/providers/google/metastore/backups_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: backups_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_audit_configs - - metastore - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_audit_configs
TypeResource
Idgoogle.metastore.backups_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_services_backups_getIamPolicy` | `SELECT` | `backupsId, locationsId, projectsId, servicesId` | diff --git a/docs/google-docs/providers/google/metastore/backups_iam_bindings/index.md b/docs/google-docs/providers/google/metastore/backups_iam_bindings/index.md deleted file mode 100644 index 7ebd573403..0000000000 --- a/docs/google-docs/providers/google/metastore/backups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: backups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_bindings - - metastore - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_bindings
TypeResource
Idgoogle.metastore.backups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_services_backups_getIamPolicy` | `SELECT` | `backupsId, locationsId, projectsId, servicesId` | diff --git a/docs/google-docs/providers/google/metastore/federations/index.md b/docs/google-docs/providers/google/metastore/federations/index.md index fa3fe00858..e0c79dd419 100644 --- a/docs/google-docs/providers/google/metastore/federations/index.md +++ b/docs/google-docs/providers/google/metastore/federations/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The relative resource name of the federation, of the form: projects/{project_number}/locations/{location_id}/federations/{federation_id}`. | -| `endpointUri` | `string` | Output only. The federation endpoint. | -| `state` | `string` | Output only. The current state of the federation. | -| `labels` | `object` | User-defined labels for the metastore federation. | | `createTime` | `string` | Output only. The time when the metastore federation was created. | -| `version` | `string` | Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version. | -| `updateTime` | `string` | Output only. The time when the metastore federation was last updated. | +| `uid` | `string` | Output only. The globally unique resource identifier of the metastore federation. | +| `state` | `string` | Output only. The current state of the federation. | | `stateMessage` | `string` | Output only. Additional information about the current state of the metastore federation, if available. | +| `updateTime` | `string` | Output only. The time when the metastore federation was last updated. | | `backendMetastores` | `object` | A map from BackendMetastore rank to BackendMetastores from which the federation service serves metadata at query time. The map key represents the order in which BackendMetastores should be evaluated to resolve database names at query time and should be greater than or equal to zero. A BackendMetastore with a lower number will be evaluated before a BackendMetastore with a higher number. | -| `uid` | `string` | Output only. The globally unique resource identifier of the metastore federation. | +| `labels` | `object` | User-defined labels for the metastore federation. | +| `endpointUri` | `string` | Output only. The federation endpoint. | +| `version` | `string` | Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/federations_iam_audit_configs/index.md b/docs/google-docs/providers/google/metastore/federations_iam_audit_configs/index.md deleted file mode 100644 index df61b6a40b..0000000000 --- a/docs/google-docs/providers/google/metastore/federations_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: federations_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - federations_iam_audit_configs - - metastore - - 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 ---- - - - -## Overview - - - - -
Namefederations_iam_audit_configs
TypeResource
Idgoogle.metastore.federations_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_federations_getIamPolicy` | `SELECT` | `federationsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/metastore/federations_iam_bindings/index.md b/docs/google-docs/providers/google/metastore/federations_iam_bindings/index.md deleted file mode 100644 index dbb8c15e8c..0000000000 --- a/docs/google-docs/providers/google/metastore/federations_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: federations_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - federations_iam_bindings - - metastore - - 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 ---- - - - -## Overview - - - - -
Namefederations_iam_bindings
TypeResource
Idgoogle.metastore.federations_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_federations_getIamPolicy` | `SELECT` | `federationsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md b/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md index 61408e0c1b..f61e94e1dd 100644 --- a/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md +++ b/docs/google-docs/providers/google/metastore/federations_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/locations/index.md b/docs/google-docs/providers/google/metastore/locations/index.md index 082666d472..2fa31ca9bf 100644 --- a/docs/google-docs/providers/google/metastore/locations/index.md +++ b/docs/google-docs/providers/google/metastore/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1" | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: "us-east1". | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/metadata_imports/index.md b/docs/google-docs/providers/google/metastore/metadata_imports/index.md index 3edda6d023..17aa6ed10c 100644 --- a/docs/google-docs/providers/google/metastore/metadata_imports/index.md +++ b/docs/google-docs/providers/google/metastore/metadata_imports/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The relative resource name of the metadata import, of the form:projects/{project_number}/locations/{location_id}/services/{service_id}/metadataImports/{metadata_import_id}. | | `description` | `string` | The description of the metadata import. | -| `endTime` | `string` | Output only. The time when the metadata import finished. | | `state` | `string` | Output only. The current state of the metadata import. | | `updateTime` | `string` | Output only. The time when the metadata import was last updated. | | `createTime` | `string` | Output only. The time when the metadata import was started. | | `databaseDump` | `object` | A specification of the location of and metadata about a database dump from a relational database management system. | +| `endTime` | `string` | Output only. The time when the metadata import finished. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/operations/index.md b/docs/google-docs/providers/google/metastore/operations/index.md index 0a0c516ba2..e8f7eb1648 100644 --- a/docs/google-docs/providers/google/metastore/operations/index.md +++ b/docs/google-docs/providers/google/metastore/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}. | +| `done` | `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. | | `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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. | -| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/services/index.md b/docs/google-docs/providers/google/metastore/services/index.md index 224d90ad87..36476ac3cb 100644 --- a/docs/google-docs/providers/google/metastore/services/index.md +++ b/docs/google-docs/providers/google/metastore/services/index.md @@ -28,26 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. | -| `createTime` | `string` | Output only. The time when the metastore service was created. | -| `artifactGcsUri` | `string` | Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored. | -| `endpointUri` | `string` | Output only. The URI of the endpoint used to access the metastore service. | -| `telemetryConfig` | `object` | Telemetry Configuration for the Dataproc Metastore service. | | `maintenanceWindow` | `object` | Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. | +| `uid` | `string` | Output only. The globally unique resource identifier of the metastore service. | +| `telemetryConfig` | `object` | Telemetry Configuration for the Dataproc Metastore service. | +| `scalingConfig` | `object` | Represents the scaling configuration of a metastore service. | | `updateTime` | `string` | Output only. The time when the metastore service was last updated. | -| `labels` | `object` | User-defined labels for the metastore service. | +| `networkConfig` | `object` | Network configuration for the Dataproc Metastore service.Next available ID: 4 | +| `hiveMetastoreConfig` | `object` | Specifies configuration information specific to running Hive metastore software as the metastore service. | +| `endpointUri` | `string` | Output only. The URI of the endpoint used to access the metastore service. | +| `port` | `integer` | The TCP port at which the metastore service is reached. Default: 9083. | | `network` | `string` | Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. | -| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore service, if available. | -| `state` | `string` | Output only. The current state of the metastore service. | | `encryptionConfig` | `object` | Encryption settings for the service. | -| `scalingConfig` | `object` | Represents the scaling configuration of a metastore service. | +| `tier` | `string` | The tier of the service. | +| `artifactGcsUri` | `string` | Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored. | +| `state` | `string` | Output only. The current state of the metastore service. | +| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore service, if available. | | `releaseChannel` | `string` | Immutable. The release channel of the service. If unspecified, defaults to STABLE. | -| `uid` | `string` | Output only. The globally unique resource identifier of the metastore service. | -| `networkConfig` | `object` | Network configuration for the Dataproc Metastore service.Next available ID: 4 | -| `hiveMetastoreConfig` | `object` | Specifies configuration information specific to running Hive metastore software as the metastore service. | +| `labels` | `object` | User-defined labels for the metastore service. | | `metadataManagementActivity` | `object` | The metadata management activities of the metastore service. | | `databaseType` | `string` | Immutable. The database type that the Metastore service stores its data. | -| `port` | `integer` | The TCP port at which the metastore service is reached. Default: 9083. | -| `tier` | `string` | The tier of the service. | +| `createTime` | `string` | Output only. The time when the metastore service was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/services_iam_audit_configs/index.md b/docs/google-docs/providers/google/metastore/services_iam_audit_configs/index.md deleted file mode 100644 index 9f6dc1f5f4..0000000000 --- a/docs/google-docs/providers/google/metastore/services_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: services_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - services_iam_audit_configs - - metastore - - 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 ---- - - - -## Overview - - - - -
Nameservices_iam_audit_configs
TypeResource
Idgoogle.metastore.services_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_services_getIamPolicy` | `SELECT` | `locationsId, projectsId, servicesId` | diff --git a/docs/google-docs/providers/google/metastore/services_iam_bindings/index.md b/docs/google-docs/providers/google/metastore/services_iam_bindings/index.md deleted file mode 100644 index d9823e648b..0000000000 --- a/docs/google-docs/providers/google/metastore/services_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - services_iam_bindings - - metastore - - 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 ---- - - - -## Overview - - - - -
Nameservices_iam_bindings
TypeResource
Idgoogle.metastore.services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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. 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. | -| `role` | `string` | Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_services_getIamPolicy` | `SELECT` | `locationsId, projectsId, servicesId` | diff --git a/docs/google-docs/providers/google/metastore/services_iam_policies/index.md b/docs/google-docs/providers/google/metastore/services_iam_policies/index.md index 01ce170351..1bce633cf0 100644 --- a/docs/google-docs/providers/google/metastore/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/metastore/services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. | +| `version` | `integer` | Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/assets/index.md b/docs/google-docs/providers/google/migrationcenter/assets/index.md index 0a6c8eb958..07c86a3ffe 100644 --- a/docs/google-docs/providers/google/migrationcenter/assets/index.md +++ b/docs/google-docs/providers/google/migrationcenter/assets/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The full name of the asset. | +| `createTime` | `string` | Output only. The timestamp when the asset was created. | +| `assignedGroups` | `array` | Output only. The list of groups that the asset is assigned to. | | `insightList` | `object` | Message containing insights list. | -| `labels` | `object` | Labels as key value pairs. | -| `sources` | `array` | Output only. The list of sources contributing to the asset. | | `updateTime` | `string` | Output only. The timestamp when the asset was last updated. | -| `attributes` | `object` | Generic asset attributes. | -| `assignedGroups` | `array` | Output only. The list of groups that the asset is assigned to. | -| `createTime` | `string` | Output only. The timestamp when the asset was created. | +| `sources` | `array` | Output only. The list of sources contributing to the asset. | | `performanceData` | `object` | Performance data for an asset. | +| `attributes` | `object` | Generic asset attributes. | +| `labels` | `object` | Labels as key value pairs. | | `machineDetails` | `object` | Details of a machine. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/migrationcenter/error_frames/index.md b/docs/google-docs/providers/google/migrationcenter/error_frames/index.md index 968b0ee3b6..0f793e52bc 100644 --- a/docs/google-docs/providers/google/migrationcenter/error_frames/index.md +++ b/docs/google-docs/providers/google/migrationcenter/error_frames/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The identifier of the ErrorFrame. | -| `ingestionTime` | `string` | Output only. Frame ingestion time. | | `originalFrame` | `object` | Contains data reported from an inventory source on an asset. | | `violations` | `array` | Output only. All the violations that were detected for the frame. | +| `ingestionTime` | `string` | Output only. Frame ingestion time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/groups/index.md b/docs/google-docs/providers/google/migrationcenter/groups/index.md index e14af06d4a..315b77ba1c 100644 --- a/docs/google-docs/providers/google/migrationcenter/groups/index.md +++ b/docs/google-docs/providers/google/migrationcenter/groups/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the group. | | `description` | `string` | The description of the resource. | -| `updateTime` | `string` | Output only. The timestamp when the group was last updated. | -| `createTime` | `string` | Output only. The timestamp when the group was created. | | `displayName` | `string` | User-friendly display name. | | `labels` | `object` | Labels as key value pairs. | +| `updateTime` | `string` | Output only. The timestamp when the group was last updated. | +| `createTime` | `string` | Output only. The timestamp when the group was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md b/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md index a64020272d..0b0377ea1b 100644 --- a/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md +++ b/docs/google-docs/providers/google/migrationcenter/import_data_files/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the file. | +| `uploadFileInfo` | `object` | A resource that contains a URI to which a data file can be uploaded. | | `createTime` | `string` | Output only. The timestamp when the file was created. | | `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | | `format` | `string` | Required. The payload format. | | `state` | `string` | Output only. The state of the import data file. | -| `uploadFileInfo` | `object` | A resource that contains a URI to which a data file can be uploaded. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md b/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md index 8580654990..2d0bd9ed95 100644 --- a/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md +++ b/docs/google-docs/providers/google/migrationcenter/import_jobs/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The full name of the import job. | -| `updateTime` | `string` | Output only. The timestamp when the import job was last updated. | | `createTime` | `string` | Output only. The timestamp when the import job was created. | -| `labels` | `object` | Labels as key value pairs. | +| `updateTime` | `string` | Output only. The timestamp when the import job was last updated. | | `completeTime` | `string` | Output only. The timestamp when the import job was completed. | -| `assetSource` | `string` | Required. Reference to a source. | -| `executionReport` | `object` | A resource that reports result of the import job execution. | +| `state` | `string` | Output only. The state of the import job. | | `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `labels` | `object` | Labels as key value pairs. | +| `executionReport` | `object` | A resource that reports result of the import job execution. | +| `assetSource` | `string` | Required. Reference to a source. | | `validationReport` | `object` | A resource that aggregates errors across import job files. | -| `state` | `string` | Output only. The state of the import job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/locations/index.md b/docs/google-docs/providers/google/migrationcenter/locations/index.md index 93d96e9960..7fd29b6af5 100644 --- a/docs/google-docs/providers/google/migrationcenter/locations/index.md +++ b/docs/google-docs/providers/google/migrationcenter/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/operations/index.md b/docs/google-docs/providers/google/migrationcenter/operations/index.md index 5b7ce613d2..c353b0fbe8 100644 --- a/docs/google-docs/providers/google/migrationcenter/operations/index.md +++ b/docs/google-docs/providers/google/migrationcenter/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md b/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md index e70c7f5a12..f9c1adfac3 100644 --- a/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md +++ b/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the preference set. | | `description` | `string` | A description of the preference set. | -| `createTime` | `string` | Output only. The timestamp when the preference set was created. | | `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | | `updateTime` | `string` | Output only. The timestamp when the preference set was last updated. | | `virtualMachinePreferences` | `object` | VirtualMachinePreferences enables you to create sets of assumptions, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. | +| `createTime` | `string` | Output only. The timestamp when the preference set was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/reports/index.md b/docs/google-docs/providers/google/migrationcenter/reports/index.md index 06ef6ace61..ae8c35381f 100644 --- a/docs/google-docs/providers/google/migrationcenter/reports/index.md +++ b/docs/google-docs/providers/google/migrationcenter/reports/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of resource. | | `description` | `string` | Free-text description. | -| `state` | `string` | Report creation state. | -| `summary` | `object` | Describes the Summary view of a Report, which contains aggregated values for all the groups and preference sets included in this Report. | -| `type` | `string` | Report type. | | `updateTime` | `string` | Output only. Last update timestamp. | | `createTime` | `string` | Output only. Creation timestamp. | | `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `state` | `string` | Report creation state. | +| `summary` | `object` | Describes the Summary view of a Report, which contains aggregated values for all the groups and preference sets included in this Report. | +| `type` | `string` | Report type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/sources/index.md b/docs/google-docs/providers/google/migrationcenter/sources/index.md index 6f2959b1c5..916b8a774f 100644 --- a/docs/google-docs/providers/google/migrationcenter/sources/index.md +++ b/docs/google-docs/providers/google/migrationcenter/sources/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The full name of the source. | | `description` | `string` | Free-text description. | -| `displayName` | `string` | User-friendly display name. | -| `type` | `string` | Data source type. | -| `managed` | `boolean` | If `true`, the source is managed by other service(s). | +| `pendingFrameCount` | `integer` | Output only. Number of frames that are still being processed. | | `priority` | `integer` | The information confidence of the source. The higher the value, the higher the confidence. | | `errorFrameCount` | `integer` | Output only. The number of frames that were reported by the source and contained errors. | -| `pendingFrameCount` | `integer` | Output only. Number of frames that are still being processed. | -| `state` | `string` | Output only. The state of the source. | +| `displayName` | `string` | User-friendly display name. | | `updateTime` | `string` | Output only. The timestamp when the source was last updated. | +| `type` | `string` | Data source type. | +| `state` | `string` | Output only. The state of the source. | | `createTime` | `string` | Output only. The timestamp when the source was created. | +| `managed` | `boolean` | If `true`, the source is managed by other service(s). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/config/index.md b/docs/google-docs/providers/google/ml/config/index.md index b5611a0c49..6c3914a330 100644 --- a/docs/google-docs/providers/google/ml/config/index.md +++ b/docs/google-docs/providers/google/ml/config/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `config` | `object` | | | `serviceAccount` | `string` | The service account Cloud ML uses to access resources in the project. | | `serviceAccountProject` | `string` | The project number for `service_account`. | -| `config` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/ml/jobs/index.md b/docs/google-docs/providers/google/ml/jobs/index.md index 858174d5bb..2bb73995da 100644 --- a/docs/google-docs/providers/google/ml/jobs/index.md +++ b/docs/google-docs/providers/google/ml/jobs/index.md @@ -27,19 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `createTime` | `string` | Output only. When the job was created. | +| `jobPosition` | `string` | Output only. It's only effect when the job is in QUEUED state. If it's positive, it indicates the job's position in the job scheduler. It's 0 when the job is already scheduled. | | `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | | `jobId` | `string` | Required. The user-specified id of the job. | | `labels` | `object` | Optional. One or more labels that you can add, to organize your jobs. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. | -| `endTime` | `string` | Output only. When the job processing was completed. | -| `predictionInput` | `object` | Represents input parameters for a prediction job. | -| `startTime` | `string` | Output only. When the job processing was started. | | `state` | `string` | Output only. The detailed state of a job. | -| `jobPosition` | `string` | Output only. It's only effect when the job is in QUEUED state. If it's positive, it indicates the job's position in the job scheduler. It's 0 when the job is already scheduled. | +| `predictionInput` | `object` | Represents input parameters for a prediction job. | +| `trainingOutput` | `object` | Represents results of a training job. Output only. | +| `endTime` | `string` | Output only. When the job processing was completed. | | `predictionOutput` | `object` | Represents results of a prediction job. | -| `trainingInput` | `object` | Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to [submitting a training job](/ai-platform/training/docs/training-jobs). | +| `startTime` | `string` | Output only. When the job processing was started. | +| `createTime` | `string` | Output only. When the job was created. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a job from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform job updates in order to avoid race conditions: An `etag` is returned in the response to `GetJob`, and systems are expected to put that etag in the request to `UpdateJob` to ensure that their change will be applied to the same version of the job. | -| `trainingOutput` | `object` | Represents results of a training job. Output only. | +| `trainingInput` | `object` | Represents input parameters for a training job. When using the gcloud command to submit your training job, you can specify the input parameters as command-line arguments and/or in a YAML configuration file referenced from the --config command-line argument. For details, see the guide to [submitting a training job](/ai-platform/training/docs/training-jobs). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/jobs_iam_audit_configs/index.md b/docs/google-docs/providers/google/ml/jobs_iam_audit_configs/index.md deleted file mode 100644 index 6580a79978..0000000000 --- a/docs/google-docs/providers/google/ml/jobs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: jobs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_audit_configs - - ml - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_audit_configs
TypeResource
Idgoogle.ml.jobs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_jobs_getIamPolicy` | `SELECT` | `jobsId, projectsId` | diff --git a/docs/google-docs/providers/google/ml/jobs_iam_bindings/index.md b/docs/google-docs/providers/google/ml/jobs_iam_bindings/index.md deleted file mode 100644 index 5acca89e93..0000000000 --- a/docs/google-docs/providers/google/ml/jobs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: jobs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_bindings - - ml - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_bindings
TypeResource
Idgoogle.ml.jobs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_jobs_getIamPolicy` | `SELECT` | `jobsId, projectsId` | diff --git a/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md b/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md index 45207a8a87..4dd8193b18 100644 --- a/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md +++ b/docs/google-docs/providers/google/ml/jobs_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/models/index.md b/docs/google-docs/providers/google/ml/models/index.md index 14816c39b8..552c21e11f 100644 --- a/docs/google-docs/providers/google/ml/models/index.md +++ b/docs/google-docs/providers/google/ml/models/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The name specified for the model when it was created. The model name must be unique within the project it is created in. | | `description` | `string` | Optional. The description specified for the model when it was created. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetModel`, and systems are expected to put that etag in the request to `UpdateModel` to ensure that their change will be applied to the model as intended. | -| `labels` | `object` | Optional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models. | | `onlinePredictionConsoleLogging` | `boolean` | Optional. If true, online prediction nodes send `stderr` and `stdout` streams to Cloud Logging. These can be more verbose than the standard access logs (see `onlinePredictionLogging`) and can incur higher cost. However, they are helpful for debugging. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high QPS. Estimate your costs before enabling this option. Default is false. | | `onlinePredictionLogging` | `boolean` | Optional. If true, online prediction access logs are sent to Cloud Logging. These logs are like standard server access logs, containing information like timestamp and latency for each request. Note that [logs may incur a cost](/stackdriver/pricing), especially if your project receives prediction requests at a high queries per second rate (QPS). Estimate your costs before enabling this option. Default is false. | | `regions` | `array` | Optional. The list of regions where the model is going to be deployed. Only one region per model is supported. Defaults to 'us-central1' if nothing is set. See the available regions for AI Platform services. Note: * No matter where a model is deployed, it can always be accessed by users from anywhere, both for online and batch prediction. * The region for a batch prediction job is set by the region field when submitting the batch prediction job and does not take its value from this field. | | `defaultVersion` | `object` | Represents a version of the model. Each version is a trained model deployed in the cloud, ready to handle prediction requests. A model can have multiple versions. You can get information about all of the versions of a given model by calling projects.models.versions.list. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetModel`, and systems are expected to put that etag in the request to `UpdateModel` to ensure that their change will be applied to the model as intended. | +| `labels` | `object` | Optional. One or more labels that you can add, to organize your models. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/models_iam_audit_configs/index.md b/docs/google-docs/providers/google/ml/models_iam_audit_configs/index.md deleted file mode 100644 index f144000936..0000000000 --- a/docs/google-docs/providers/google/ml/models_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: models_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - models_iam_audit_configs - - ml - - 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 ---- - - - -## Overview - - - - -
Namemodels_iam_audit_configs
TypeResource
Idgoogle.ml.models_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_models_getIamPolicy` | `SELECT` | `modelsId, projectsId` | diff --git a/docs/google-docs/providers/google/ml/models_iam_bindings/index.md b/docs/google-docs/providers/google/ml/models_iam_bindings/index.md deleted file mode 100644 index fa8e574e34..0000000000 --- a/docs/google-docs/providers/google/ml/models_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: models_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - models_iam_bindings - - ml - - 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 ---- - - - -## Overview - - - - -
Namemodels_iam_bindings
TypeResource
Idgoogle.ml.models_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_models_getIamPolicy` | `SELECT` | `modelsId, projectsId` | diff --git a/docs/google-docs/providers/google/ml/models_iam_policies/index.md b/docs/google-docs/providers/google/ml/models_iam_policies/index.md index ab89aa1884..6f55be6f3e 100644 --- a/docs/google-docs/providers/google/ml/models_iam_policies/index.md +++ b/docs/google-docs/providers/google/ml/models_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/operations/index.md b/docs/google-docs/providers/google/ml/operations/index.md index 3df7a1f630..f0745c7aa7 100644 --- a/docs/google-docs/providers/google/ml/operations/index.md +++ b/docs/google-docs/providers/google/ml/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | +| `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/projects_config/index.md b/docs/google-docs/providers/google/ml/projects_config/index.md deleted file mode 100644 index d618da4128..0000000000 --- a/docs/google-docs/providers/google/ml/projects_config/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: projects_config -hide_title: false -hide_table_of_contents: false -keywords: - - projects_config - - ml - - 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 ---- - - - -## Overview - - - - -
Nameprojects_config
TypeResource
Idgoogle.ml.projects_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `config` | `object` | | -| `serviceAccount` | `string` | The service account Cloud ML uses to access resources in the project. | -| `serviceAccountProject` | `string` | The project number for `service_account`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getConfig` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/ml/versions/index.md b/docs/google-docs/providers/google/ml/versions/index.md index 072d37a9f6..30dcfbaaf7 100644 --- a/docs/google-docs/providers/google/ml/versions/index.md +++ b/docs/google-docs/providers/google/ml/versions/index.md @@ -29,29 +29,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The name specified for the version when it was created. The version name must be unique within the model it is created in. | | `description` | `string` | Optional. The description specified for the version when it was created. | -| `explanationConfig` | `object` | Message holding configuration options for explaining model predictions. There are three feature attribution methods supported for TensorFlow models: integrated gradients, sampled Shapley, and XRAI. [Learn more about feature attributions.](/ai-platform/prediction/docs/ai-explanations/overview) | -| `framework` | `string` | Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai-platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container](/ai-platform/prediction/docs/use-custom-container). | -| `runtimeVersion` | `string` | Required. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). | -| `packageUris` | `array` | Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. | -| `routes` | `object` | Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended. | -| `lastUseTime` | `string` | Output only. The time the version was last used for prediction. | -| `autoScaling` | `object` | Options for automatically scaling a model. | -| `pythonVersion` | `string` | Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). | -| `manualScaling` | `object` | Options for manually scaling a model. | -| `lastMigrationTime` | `string` | Output only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified). | | `isDefault` | `boolean` | Output only. If true, this version will be used to handle prediction requests that do not specify a version. You can change the default version by calling projects.methods.versions.setDefault. | +| `lastUseTime` | `string` | Output only. The time the version was last used for prediction. | +| `lastMigrationModelId` | `string` | Output only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform-unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified). | | `predictionClass` | `string` | Optional. The fully qualified name (module_name.class_name) of a class that implements the Predictor interface described in this reference field. The module containing this class should be included in a package provided to the [`packageUris` field](#Version.FIELDS.package_uris). Specify this field if and only if you are deploying a [custom prediction routine (beta)](/ml-engine/docs/tensorflow/custom-prediction-routines). If you specify this field, you must set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater and you must set `machineType` to a [legacy (MLS1) machine type](/ml-engine/docs/machine-types-online-prediction). The following code sample provides the Predictor interface: class Predictor(object): """Interface for constructing custom predictors.""" def predict(self, instances, **kwargs): """Performs custom prediction. Instances are the decoded values from the request. They have already been deserialized from JSON. Args: instances: A list of prediction input instances. **kwargs: A dictionary of keyword args provided as additional fields on the predict request body. Returns: A list of outputs containing the prediction results. This list must be JSON serializable. """ raise NotImplementedError() @classmethod def from_path(cls, model_dir): """Creates an instance of Predictor using the given path. Loading of the predictor should be done in this method. Args: model_dir: The local directory that contains the exported model file along with any additional files uploaded when creating the version resource. Returns: An instance implementing this Predictor class. """ raise NotImplementedError() Learn more about [the Predictor interface and custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines). | -| `deploymentUri` | `string` | The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying-models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts). | -| `serviceAccount` | `string` | Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service-account). | -| `acceleratorConfig` | `object` | Represents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). | -| `machineType` | `string` | Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs/regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`. | | `createTime` | `string` | Output only. The time the version was created. | -| `container` | `object` | Specification of a custom container for serving predictions. This message is a subset of the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). | -| `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a model from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform model updates in order to avoid race conditions: An `etag` is returned in the response to `GetVersion`, and systems are expected to put that etag in the request to `UpdateVersion` to ensure that their change will be applied to the model as intended. | +| `explanationConfig` | `object` | Message holding configuration options for explaining model predictions. There are three feature attribution methods supported for TensorFlow models: integrated gradients, sampled Shapley, and XRAI. [Learn more about feature attributions.](/ai-platform/prediction/docs/ai-explanations/overview) | +| `autoScaling` | `object` | Options for automatically scaling a model. | | `labels` | `object` | Optional. One or more labels that you can add, to organize your model versions. Each label is a key-value pair, where both the key and the value are arbitrary strings that you supply. For more information, see the documentation on using labels. Note that this field is not updatable for mls1* models. | -| `lastMigrationModelId` | `string` | Output only. The [AI Platform (Unified) `Model`](https://cloud.google.com/ai-platform-unified/docs/reference/rest/v1beta1/projects.locations.models) ID for the last [model migration](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified). | +| `routes` | `object` | Specifies HTTP paths served by a custom container. AI Platform Prediction sends requests to these paths on the container; the custom container must run an HTTP server that responds to these requests with appropriate responses. Read [Custom container requirements](/ai-platform/prediction/docs/custom-container-requirements) for details on how to create your container image to meet these requirements. | | `requestLoggingConfig` | `object` | Configuration for logging request-response pairs to a BigQuery table. Online prediction requests to a model version and the responses to these requests are converted to raw strings and saved to the specified BigQuery table. Logging is constrained by [BigQuery quotas and limits](/bigquery/quotas). If your project exceeds BigQuery quotas or limits, AI Platform Prediction does not log request-response pairs, but it continues to serve predictions. If you are using [continuous evaluation](/ml-engine/docs/continuous-evaluation/), you do not need to specify this configuration manually. Setting up continuous evaluation automatically enables logging of request-response pairs. | +| `container` | `object` | Specification of a custom container for serving predictions. This message is a subset of the [Kubernetes Container v1 core specification](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#container-v1-core). | +| `runtimeVersion` | `string` | Required. The AI Platform runtime version to use for this deployment. For more information, see the [runtime version list](/ml-engine/docs/runtime-version-list) and [how to manage runtime versions](/ml-engine/docs/versioning). | +| `machineType` | `string` | Optional. The type of machine on which to serve the model. Currently only applies to online prediction service. To learn about valid values for this field, read [Choosing a machine type for online prediction](/ai-platform/prediction/docs/machine-types-online-prediction). If this field is not specified and you are using a [regional endpoint](/ai-platform/prediction/docs/regional-endpoints), then the machine type defaults to `n1-standard-2`. If this field is not specified and you are using the global endpoint (`ml.googleapis.com`), then the machine type defaults to `mls1-c1-m2`. | +| `serviceAccount` | `string` | Optional. Specifies the service account for resource access control. If you specify this field, then you must also specify either the `containerSpec` or the `predictionClass` field. Learn more about [using a custom service account](/ai-platform/prediction/docs/custom-service-account). | +| `framework` | `string` | Optional. The machine learning framework AI Platform uses to train this version of the model. Valid values are `TENSORFLOW`, `SCIKIT_LEARN`, `XGBOOST`. If you do not specify a framework, AI Platform will analyze files in the deployment_uri to determine a framework. If you choose `SCIKIT_LEARN` or `XGBOOST`, you must also set the runtime version of the model to 1.4 or greater. Do **not** specify a framework if you're deploying a [custom prediction routine](/ai-platform/prediction/docs/custom-prediction-routines) or if you're using a [custom container](/ai-platform/prediction/docs/use-custom-container). | +| `lastMigrationTime` | `string` | Output only. The last time this version was successfully [migrated to AI Platform (Unified)](https://cloud.google.com/ai-platform-unified/docs/start/migrating-to-ai-platform-unified). | +| `acceleratorConfig` | `object` | Represents a hardware accelerator request config. Note that the AcceleratorConfig can be used in both Jobs and Versions. Learn more about [accelerators for training](/ml-engine/docs/using-gpus) and [accelerators for online prediction](/ml-engine/docs/machine-types-online-prediction#gpus). | +| `deploymentUri` | `string` | The Cloud Storage URI of a directory containing trained model artifacts to be used to create the model version. See the [guide to deploying models](/ai-platform/prediction/docs/deploying-models) for more information. The total number of files under this directory must not exceed 1000. During projects.models.versions.create, AI Platform Prediction copies all files from the specified directory to a location managed by the service. From then on, AI Platform Prediction uses these copies of the model artifacts to serve predictions, not the original files in Cloud Storage, so this location is useful only as a historical record. If you specify container, then this field is optional. Otherwise, it is required. Learn [how to use this field with a custom container](/ai-platform/prediction/docs/custom-container-requirements#artifacts). | +| `packageUris` | `array` | Optional. Cloud Storage paths (`gs://…`) of packages for [custom prediction routines](/ml-engine/docs/tensorflow/custom-prediction-routines) or [scikit-learn pipelines with custom code](/ml-engine/docs/scikit/exporting-for-prediction#custom-pipeline-code). For a custom prediction routine, one of these packages must contain your Predictor class (see [`predictionClass`](#Version.FIELDS.prediction_class)). Additionally, include any dependencies used by your Predictor or scikit-learn pipeline uses that are not already included in your selected [runtime version](/ml-engine/docs/tensorflow/runtime-version-list). If you specify this field, you must also set [`runtimeVersion`](#Version.FIELDS.runtime_version) to 1.4 or greater. | +| `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | +| `pythonVersion` | `string` | Required. The version of Python used in prediction. The following Python versions are available: * Python '3.7' is available when `runtime_version` is set to '1.15' or later. * Python '3.5' is available when `runtime_version` is set to a version from '1.4' to '1.14'. * Python '2.7' is available when `runtime_version` is set to '1.15' or earlier. Read more about the Python versions available for [each runtime version](/ml-engine/docs/runtime-version-list). | +| `manualScaling` | `object` | Options for manually scaling a model. | | `state` | `string` | Output only. The state of a version. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/monitoring/alert_policies/index.md b/docs/google-docs/providers/google/monitoring/alert_policies/index.md index 2f9b41a36c..c0f99a993f 100644 --- a/docs/google-docs/providers/google/monitoring/alert_policies/index.md +++ b/docs/google-docs/providers/google/monitoring/alert_policies/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request. | -| `displayName` | `string` | A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy. | -| `documentation` | `object` | A content string and a MIME type that describes the content string's format. | -| `mutationRecord` | `object` | Describes a change made to a configuration. | -| `alertStrategy` | `object` | Control over how the notification channels in notification_channels are notified when this alert fires. | +| `creationRecord` | `object` | Describes a change made to a configuration. | +| `combiner` | `string` | How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED. | | `conditions` | `array` | A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition. If condition_monitoring_query_language is present, it must be the only condition. | +| `displayName` | `string` | A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.The convention for the display_name of a PrometheusQueryLanguageCondition is "{rule group name}/{alert name}", where the {rule group name} and {alert name} should be taken from the corresponding Prometheus configuration file. This convention is not enforced. In any case the display_name is not a unique key of the AlertPolicy. | | `validity` | `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). | -| `creationRecord` | `object` | Describes a change made to a configuration. | -| `userLabels` | `object` | User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.Note that Prometheus {rule group name} and {alert name} are valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). This means that they cannot be stored as-is in user labels, because Prometheus labels may contain upper-case letters. | | `enabled` | `boolean` | Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out. | -| `combiner` | `string` | How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED. | +| `userLabels` | `object` | User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.Note that Prometheus {rule group name} and {alert name} are valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels). This means that they cannot be stored as-is in user labels, because Prometheus labels may contain upper-case letters. | | `notificationChannels` | `array` | Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] | +| `documentation` | `object` | A content string and a MIME type that describes the content string's format. | +| `alertStrategy` | `object` | Control over how the notification channels in notification_channels are notified when this alert fires. | +| `mutationRecord` | `object` | Describes a change made to a configuration. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/groups/index.md b/docs/google-docs/providers/google/monitoring/groups/index.md index 898ca7849f..6699e16d7a 100644 --- a/docs/google-docs/providers/google/monitoring/groups/index.md +++ b/docs/google-docs/providers/google/monitoring/groups/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically. | -| `parentName` | `string` | The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "". | -| `displayName` | `string` | A user-assigned name for this group, used only for display purposes. | | `filter` | `string` | The filter used to determine which monitored resources belong to this group. | | `isCluster` | `boolean` | If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. | +| `parentName` | `string` | The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "". | +| `displayName` | `string` | A user-assigned name for this group, used only for display purposes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/members/index.md b/docs/google-docs/providers/google/monitoring/members/index.md index 108425e82b..af713a0a00 100644 --- a/docs/google-docs/providers/google/monitoring/members/index.md +++ b/docs/google-docs/providers/google/monitoring/members/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `type` | `string` | Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). | | `labels` | `object` | Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone". | +| `type` | `string` | Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md b/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md index ac070f2da1..b4f0d8f6ac 100644 --- a/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md +++ b/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md @@ -30,14 +30,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | The resource name of the metric descriptor. | | `description` | `string` | A detailed description of the metric, which can be used in documentation. | | `launchStage` | `string` | Optional. The launch stage of the metric definition. | -| `unit` | `string` | The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT \| "%" ) [ Annotation ] \| Annotation \| "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). | -| `monitoredResourceTypes` | `array` | Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. | +| `type` | `string` | The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" | | `valueType` | `string` | Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. | -| `displayName` | `string` | A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. | +| `labels` | `array` | The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. | | `metadata` | `object` | Additional annotations that can be used to guide the usage of a metric. | | `metricKind` | `string` | Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. | -| `type` | `string` | The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" | -| `labels` | `array` | The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed. | +| `displayName` | `string` | A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota. | +| `monitoredResourceTypes` | `array` | Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here. | +| `unit` | `string` | The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT \| "%" ) [ Annotation ] \| Annotation \| "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent"). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md b/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md index 538985e448..1fd6529b35 100644 --- a/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md +++ b/docs/google-docs/providers/google/monitoring/notification_channel_descriptors/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The full REST resource name for this descriptor. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type field. | | `description` | `string` | A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation. | +| `displayName` | `string` | A human-readable name for the notification channel type. This form of the name is suitable for a user interface. | | `labels` | `array` | The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated. | | `launchStage` | `string` | The product launch stage for channels of this type. | | `supportedTiers` | `array` | The tiers that support this notification channel; the project service tier must be one of the supported_tiers. | | `type` | `string` | The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors (https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique. | -| `displayName` | `string` | A human-readable name for the notification channel type. This form of the name is suitable for a user interface. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/notification_channels/index.md b/docs/google-docs/providers/google/monitoring/notification_channels/index.md index 25ba13eec4..26f1dc873f 100644 --- a/docs/google-docs/providers/google/monitoring/notification_channels/index.md +++ b/docs/google-docs/providers/google/monitoring/notification_channels/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the server on creation. | | `description` | `string` | An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed 1024 Unicode characters. | -| `type` | `string` | The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. | -| `verificationStatus` | `string` | Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel. | +| `labels` | `object` | Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field. | | `enabled` | `boolean` | Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future. | -| `mutationRecords` | `array` | Records of the modification of this channel. | +| `verificationStatus` | `string` | Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel operation. To change the value of this field, you must call VerifyNotificationChannel. | | `userLabels` | `object` | User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. | +| `type` | `string` | The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. | +| `mutationRecords` | `array` | Records of the modification of this channel. | | `creationRecord` | `object` | Describes a change made to a configuration. | | `displayName` | `string` | An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters. | -| `labels` | `object` | Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the NotificationChannelDescriptor corresponding to the type field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md b/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md index ed4d8487a8..cc790158c9 100644 --- a/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md +++ b/docs/google-docs/providers/google/monitoring/service_level_objectives/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] | +| `rollingPeriod` | `string` | A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days. | +| `serviceLevelIndicator` | `object` | A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be good_service / total_service over any queried time interval. The value of performance always falls into the range 0 <= performance <= 1. A custom SLI describes how to compute this ratio, whether this is by dividing values from a pair of time series, cutting a Distribution into good and bad counts, or counting time windows in which the service complies with a criterion. For separation of concerns, a single Service-Level Indicator measures performance for only one aspect of service quality, such as fraction of successful queries or fast-enough queries. | | `userLabels` | `object` | Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. | | `calendarPeriod` | `string` | A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported. | | `displayName` | `string` | Name used for UI elements listing this SLO. | | `goal` | `number` | The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999. | -| `rollingPeriod` | `string` | A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days. | -| `serviceLevelIndicator` | `object` | A Service-Level Indicator (SLI) describes the "performance" of a service. For some services, the SLI is well-defined. In such cases, the SLI can be described easily by referencing the well-known SLI and providing the needed parameters. Alternatively, a "custom" SLI can be defined with a query to the underlying metric store. An SLI is defined to be good_service / total_service over any queried time interval. The value of performance always falls into the range 0 <= performance <= 1. A custom SLI describes how to compute this ratio, whether this is by dividing values from a pair of time series, cutting a Distribution into good and bad counts, or counting time windows in which the service complies with a criterion. For separation of concerns, a single Service-Level Indicator measures performance for only one aspect of service quality, such as fraction of successful queries or fast-enough queries. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/services/index.md b/docs/google-docs/providers/google/monitoring/services/index.md index dc601aab14..f9150fcab1 100644 --- a/docs/google-docs/providers/google/monitoring/services/index.md +++ b/docs/google-docs/providers/google/monitoring/services/index.md @@ -28,20 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] | -| `appEngine` | `object` | App Engine service. Learn more at https://cloud.google.com/appengine. | -| `basicService` | `object` | A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). | -| `displayName` | `string` | Name used for UI elements listing this Service. | | `gkeWorkload` | `object` | A GKE Workload (Deployment, StatefulSet, etc). The field names correspond to the metadata labels on monitored resources that fall under a workload (for example, k8s_container or k8s_pod). | +| `telemetry` | `object` | Configuration for how to query telemetry on a Service. | +| `gkeNamespace` | `object` | GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). | +| `appEngine` | `object` | App Engine service. Learn more at https://cloud.google.com/appengine. | +| `custom` | `object` | Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. | +| `cloudEndpoints` | `object` | Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. | +| `clusterIstio` | `object` | Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. | | `gkeService` | `object` | GKE Service. The "service" here represents a Kubernetes service object (https://kubernetes.io/docs/concepts/services-networking/service). The field names correspond to the resource labels on k8s_service monitored resources (https://cloud.google.com/monitoring/api/resources#tag_k8s_service). | +| `cloudRun` | `object` | Cloud Run service. Learn more at https://cloud.google.com/run. | | `userLabels` | `object` | Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic value, the empty string may be supplied for the label value. | +| `basicService` | `object` | A well-known service type, defined by its service type and service labels. Documentation and examples here (https://cloud.google.com/stackdriver/docs/solutions/slo-monitoring/api/api-structures#basic-svc-w-basic-sli). | | `istioCanonicalService` | `object` | Canonical service scoped to an Istio mesh. Anthos clusters running ASM >= 1.6.8 will have their services ingested as this type. | -| `telemetry` | `object` | Configuration for how to query telemetry on a Service. | -| `cloudEndpoints` | `object` | Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. | +| `displayName` | `string` | Name used for UI elements listing this Service. | | `meshIstio` | `object` | Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. | -| `custom` | `object` | Use a custom service to designate a service that you want to monitor when none of the other service types (like App Engine, Cloud Run, or a GKE type) matches your intended service. | -| `cloudRun` | `object` | Cloud Run service. Learn more at https://cloud.google.com/run. | -| `clusterIstio` | `object` | Istio service scoped to a single Kubernetes cluster. Learn more at https://istio.io. Clusters running OSS Istio will have their services ingested as this type. | -| `gkeNamespace` | `object` | GKE Namespace. The field names correspond to the resource metadata labels on monitored resources that fall under a namespace (for example, k8s_container or k8s_pod). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/time_series/index.md b/docs/google-docs/providers/google/monitoring/time_series/index.md index 537fcb4602..ba096dbe73 100644 --- a/docs/google-docs/providers/google/monitoring/time_series/index.md +++ b/docs/google-docs/providers/google/monitoring/time_series/index.md @@ -27,13 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `metadata` | `object` | Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. | | `metric` | `object` | A specific metric, identified by specifying values for all of the labels of a MetricDescriptor. | | `metricKind` | `string` | The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE. | | `points` | `array` | The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION. | | `resource` | `object` | An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} | | `unit` | `string` | The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. | | `valueType` | `string` | The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. | -| `metadata` | `object` | Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md b/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md index e014f78095..32b220baae 100644 --- a/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md +++ b/docs/google-docs/providers/google/monitoring/uptime_check_configs/index.md @@ -28,20 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response. | -| `isInternal` | `boolean` | If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false. | -| `syntheticMonitor` | `object` | Describes a Synthetic Monitor to be invoked by Uptime. | -| `checkerType` | `string` | The type of checkers to use to execute the Uptime check. | +| `resourceGroup` | `object` | The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. | +| `internalCheckers` | `array` | The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig. | +| `userLabels` | `object` | User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. | +| `httpCheck` | `object` | Information involved in an HTTP/HTTPS Uptime check request. | | `timeout` | `string` | The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. | | `selectedRegions` | `array` | The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions. | -| `httpCheck` | `object` | Information involved in an HTTP/HTTPS Uptime check request. | -| `resourceGroup` | `object` | The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored. | -| `period` | `string` | How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s. | +| `checkerType` | `string` | The type of checkers to use to execute the Uptime check. | | `contentMatchers` | `array` | The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check. | +| `isInternal` | `boolean` | If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false. | +| `monitoredResource` | `object` | An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} | +| `syntheticMonitor` | `object` | Describes a Synthetic Monitor to be invoked by Uptime. | | `tcpCheck` | `object` | Information required for a TCP Uptime check request. | +| `period` | `string` | How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s. | | `displayName` | `string` | A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required. | -| `userLabels` | `object` | User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter. | -| `internalCheckers` | `array` | The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig. | -| `monitoredResource` | `object` | An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md index 4ff5c1052c..4602577601 100644 --- a/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/groups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/hubs/index.md b/docs/google-docs/providers/google/networkconnectivity/hubs/index.md index 805c769871..9b4d600561 100644 --- a/docs/google-docs/providers/google/networkconnectivity/hubs/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/hubs/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of the hub. Hub names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}` | | `description` | `string` | An optional description of the hub. | -| `routingVpcs` | `array` | The VPC networks associated with this hub's spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. | -| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | -| `routeTables` | `array` | Output only. The route tables that belong to this hub. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}` This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub. | +| `createTime` | `string` | Output only. The time the hub was created. | +| `spokeSummary` | `object` | Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason. | | `state` | `string` | Output only. The current lifecycle state of this hub. | | `uniqueId` | `string` | Output only. The Google-generated UUID for the hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id. | +| `routingVpcs` | `array` | The VPC networks associated with this hub's spokes. This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub. | | `updateTime` | `string` | Output only. The time the hub was last updated. | -| `spokeSummary` | `object` | Summarizes information about the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason. | -| `createTime` | `string` | Output only. The time the hub was created. | +| `routeTables` | `array` | Output only. The route tables that belong to this hub. They use the following form: `projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}` This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub. | +| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/hubs_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkconnectivity/hubs_iam_audit_configs/index.md deleted file mode 100644 index 2fd5139dbe..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/hubs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: hubs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - hubs_iam_audit_configs - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Namehubs_iam_audit_configs
TypeResource
Idgoogle.networkconnectivity.hubs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_hubs_getIamPolicy` | `SELECT` | `hubsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/hubs_iam_bindings/index.md b/docs/google-docs/providers/google/networkconnectivity/hubs_iam_bindings/index.md deleted file mode 100644 index 4f2cce20a7..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/hubs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: hubs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - hubs_iam_bindings - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Namehubs_iam_bindings
TypeResource
Idgoogle.networkconnectivity.hubs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_hubs_getIamPolicy` | `SELECT` | `hubsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/hubs_spokes/index.md b/docs/google-docs/providers/google/networkconnectivity/hubs_spokes/index.md deleted file mode 100644 index f5e2e84254..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/hubs_spokes/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: hubs_spokes -hide_title: false -hide_table_of_contents: false -keywords: - - hubs_spokes - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Namehubs_spokes
TypeResource
Idgoogle.networkconnectivity.hubs_spokes
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | The token for the next page of the response. To see more results, use this value as the page_token for your next request. If this value is empty, there are no more results. | -| `spokes` | `array` | The requested spokes. The spoke fields can be partially populated based on the `view` field in the request message. | -| `unreachable` | `array` | Locations that could not be reached. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `list_spokes` | `SELECT` | `hubsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md b/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md index 07c856c248..60159c40ef 100644 --- a/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/internal_ranges/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of an internal range. Format: projects/{project}/locations/{location}/internalRanges/{internal_range} See: https://google.aip.dev/122#fields-representing-resource-names | | `description` | `string` | A description of this resource. | -| `peering` | `string` | The type of peering set for this internal range. | +| `network` | `string` | The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123 | | `createTime` | `string` | Time when the internal range was created. | | `ipCidrRange` | `string` | The IP range that this internal range defines. | -| `usage` | `string` | The type of usage set for this InternalRange. | | `prefixLength` | `integer` | An alternate to ip_cidr_range. Can be set when trying to create a reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. | | `users` | `array` | Output only. The list of resources that refer to this internal range. Resources that use the internal range for their range allocation are referred to as users of the range. Other resources mark themselves as users while doing so by creating a reference to this internal range. Having a user, based on this reference, prevents deletion of the internal range referred to. Can be empty. | -| `updateTime` | `string` | Time when the internal range was updated. | -| `overlaps` | `array` | Optional. Types of resources that are allowed to overlap with the current internal range. | | `labels` | `object` | User-defined labels. | -| `network` | `string` | The URL or resource ID of the network in which to reserve the internal range. The network cannot be deleted if there are any reserved internal ranges referring to it. Legacy networks are not supported. This can only be specified for a global internal address. Example: - URL: /compute/v1/projects/{project}/global/networks/{resourceId} - ID: network123 | | `targetCidrRange` | `array` | Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the "10.0.0.0/8" address space. This can be used to search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. | +| `peering` | `string` | The type of peering set for this internal range. | +| `overlaps` | `array` | Optional. Types of resources that are allowed to overlap with the current internal range. | +| `usage` | `string` | The type of usage set for this InternalRange. | +| `updateTime` | `string` | Time when the internal range was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/locations/index.md b/docs/google-docs/providers/google/networkconnectivity/locations/index.md index 03b81eddb9..5880b8139b 100644 --- a/docs/google-docs/providers/google/networkconnectivity/locations/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/operations/index.md b/docs/google-docs/providers/google/networkconnectivity/operations/index.md index d2a1603f4a..f2e498d5e8 100644 --- a/docs/google-docs/providers/google/networkconnectivity/operations/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | -| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_audit_configs/index.md deleted file mode 100644 index cfb2cf418d..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: policy_based_routes_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - policy_based_routes_iam_audit_configs - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Namepolicy_based_routes_iam_audit_configs
TypeResource
Idgoogle.networkconnectivity.policy_based_routes_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_policyBasedRoutes_getIamPolicy` | `SELECT` | `policyBasedRoutesId, projectsId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_bindings/index.md b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_bindings/index.md deleted file mode 100644 index 5118d922fe..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: policy_based_routes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - policy_based_routes_iam_bindings - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Namepolicy_based_routes_iam_bindings
TypeResource
Idgoogle.networkconnectivity.policy_based_routes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_policyBasedRoutes_getIamPolicy` | `SELECT` | `policyBasedRoutesId, projectsId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md index bf4eae2115..9b8d72e5ca 100644 --- a/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md b/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md index 33731ce6d3..757876e92d 100644 --- a/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/route_tables/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of the route table. Route table names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}` | | `description` | `string` | An optional description of the route table. | -| `updateTime` | `string` | Output only. The time the route table was last updated. | -| `createTime` | `string` | Output only. The time the route table was created. | | `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | | `state` | `string` | Output only. The current lifecycle state of this route table. | | `uid` | `string` | Output only. The Google-generated UUID for the route table. This value is unique across all route table resources. If a route table is deleted and another with the same name is created, the new route table is assigned a different `uid`. | +| `updateTime` | `string` | Output only. The time the route table was last updated. | +| `createTime` | `string` | Output only. The time the route table was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/routes/index.md b/docs/google-docs/providers/google/networkconnectivity/routes/index.md index 9893fe2f1d..95a65f629e 100644 --- a/docs/google-docs/providers/google/networkconnectivity/routes/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/routes/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of the route. Route names must be unique. Route names use the following form: `projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}` | | `description` | `string` | An optional description of the route. | -| `spoke` | `string` | Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE | -| `uid` | `string` | Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`. | -| `updateTime` | `string` | Output only. The time the route was last updated. | | `nextHopVpcNetwork` | `object` | | -| `location` | `string` | Output only. The location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1 | -| `state` | `string` | Output only. The current lifecycle state of the route. | -| `type` | `string` | Output only. The route's type. Its type is determined by the properties of its IP address range. | +| `uid` | `string` | Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different `uid`. | | `createTime` | `string` | Output only. The time the route was created. | | `ipCidrRange` | `string` | The destination IP address range. | +| `spoke` | `string` | Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE | +| `type` | `string` | Output only. The route's type. Its type is determined by the properties of its IP address range. | | `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | +| `location` | `string` | Output only. The location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1 | +| `state` | `string` | Output only. The current lifecycle state of the route. | +| `updateTime` | `string` | Output only. The time the route was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md b/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md index 6de8748854..0ac8676a82 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_classes/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of a ServiceClass resource. Format: projects/{project}/locations/{location}/serviceClasses/{service_class} See: https://google.aip.dev/122#fields-representing-resource-names | | `description` | `string` | A description of this resource. | +| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | | `labels` | `object` | User-defined labels. | | `serviceClass` | `string` | Output only. The generated service class name. Use this name to refer to the Service class in Service Connection Maps and Service Connection Policies. | | `updateTime` | `string` | Output only. Time when the ServiceClass was updated. | | `createTime` | `string` | Output only. Time when the ServiceClass was created. | -| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_audit_configs/index.md deleted file mode 100644 index 712f731a54..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: service_classes_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - service_classes_iam_audit_configs - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Nameservice_classes_iam_audit_configs
TypeResource
Idgoogle.networkconnectivity.service_classes_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceClasses_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceClassesId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_bindings/index.md b/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_bindings/index.md deleted file mode 100644 index 5c48b4c92b..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: service_classes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - service_classes_iam_bindings - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Nameservice_classes_iam_bindings
TypeResource
Idgoogle.networkconnectivity.service_classes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceClasses_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceClassesId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_policies/index.md index e61651cc16..75c2acb7d2 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_classes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md index b984ee8b25..76a5a49123 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of a ServiceConnectionMap. Format: projects/{project}/locations/{location}/serviceConnectionMaps/{service_connection_map} See: https://google.aip.dev/122#fields-representing-resource-names | | `description` | `string` | A description of this resource. | +| `createTime` | `string` | Output only. Time when the ServiceConnectionMap was created. | +| `labels` | `object` | User-defined labels. | | `consumerPscConfigs` | `array` | The PSC configurations on consumer side. | -| `infrastructure` | `string` | Output only. The infrastructure used for connections between consumers/producers. | -| `serviceClassUri` | `string` | Output only. The service class uri this ServiceConnectionMap is for. | | `producerPscConfigs` | `array` | The PSC configurations on producer side. | | `consumerPscConnections` | `array` | Output only. PSC connection details on consumer side. | +| `infrastructure` | `string` | Output only. The infrastructure used for connections between consumers/producers. | | `serviceClass` | `string` | The service class identifier this ServiceConnectionMap is for. The user of ServiceConnectionMap create API needs to have networkconnecitivty.serviceclasses.use iam permission for the service class. | -| `token` | `string` | The token provided by the consumer. This token authenticates that the consumer can create a connecton within the specified project and network. | -| `labels` | `object` | User-defined labels. | +| `serviceClassUri` | `string` | Output only. The service class uri this ServiceConnectionMap is for. | | `updateTime` | `string` | Output only. Time when the ServiceConnectionMap was updated. | -| `createTime` | `string` | Output only. Time when the ServiceConnectionMap was created. | | `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `token` | `string` | The token provided by the consumer. This token authenticates that the consumer can create a connecton within the specified project and network. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_maps_iam_audit_configs/index.md deleted file mode 100644 index a236fbdba3..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: service_connection_maps_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - service_connection_maps_iam_audit_configs - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Nameservice_connection_maps_iam_audit_configs
TypeResource
Idgoogle.networkconnectivity.service_connection_maps_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceConnectionMaps_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceConnectionMapsId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps_iam_bindings/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_maps_iam_bindings/index.md deleted file mode 100644 index bdd53364f9..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_maps_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: service_connection_maps_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - service_connection_maps_iam_bindings - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Nameservice_connection_maps_iam_bindings
TypeResource
Idgoogle.networkconnectivity.service_connection_maps_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceConnectionMaps_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceConnectionMapsId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md index 6c9274f1b7..c43911b323 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of a ServiceConnectionPolicy. Format: projects/{project}/locations/{location}/serviceConnectionPolicies/{service_connection_policy} See: https://google.aip.dev/122#fields-representing-resource-names | | `description` | `string` | A description of this resource. | -| `pscConnections` | `array` | Output only. [Output only] Information about each Private Service Connect connection. | -| `updateTime` | `string` | Output only. Time when the ServiceConnectionMap was updated. | -| `infrastructure` | `string` | Output only. The type of underlying resources used to create the connection. | -| `labels` | `object` | User-defined labels. | | `pscConfig` | `object` | Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. | +| `labels` | `object` | User-defined labels. | | `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `infrastructure` | `string` | Output only. The type of underlying resources used to create the connection. | | `createTime` | `string` | Output only. Time when the ServiceConnectionMap was created. | +| `pscConnections` | `array` | Output only. [Output only] Information about each Private Service Connect connection. | | `serviceClass` | `string` | The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. | | `network` | `string` | The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}. | +| `updateTime` | `string` | Output only. Time when the ServiceConnectionMap was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_audit_configs/index.md deleted file mode 100644 index 902496b4db..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: service_connection_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - service_connection_policies_iam_audit_configs - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Nameservice_connection_policies_iam_audit_configs
TypeResource
Idgoogle.networkconnectivity.service_connection_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceConnectionPolicies_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceConnectionPoliciesId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_bindings/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_bindings/index.md deleted file mode 100644 index 9d671f980e..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: service_connection_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - service_connection_policies_iam_bindings - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Nameservice_connection_policies_iam_bindings
TypeResource
Idgoogle.networkconnectivity.service_connection_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceConnectionPolicies_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceConnectionPoliciesId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md index 0854cd3dcc..036b73609a 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md index 767719fb18..21ac6fcdaf 100644 --- a/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/service_connection_tokens/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of a ServiceConnectionToken. Format: projects/{project}/locations/{location}/ServiceConnectionTokens/{service_connection_token} See: https://google.aip.dev/122#fields-representing-resource-names | | `description` | `string` | A description of this resource. | -| `token` | `string` | Output only. The token generated by Automation. | -| `network` | `string` | The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}. | | `updateTime` | `string` | Output only. Time when the ServiceConnectionToken was updated. | -| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | -| `expireTime` | `string` | Output only. The time to which this token is valid. | | `createTime` | `string` | Output only. Time when the ServiceConnectionToken was created. | +| `expireTime` | `string` | Output only. The time to which this token is valid. | +| `etag` | `string` | Optional. The etag is computed by the server, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. | +| `token` | `string` | Output only. The token generated by Automation. | +| `network` | `string` | The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}. | | `labels` | `object` | User-defined labels. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/networkconnectivity/spokes/index.md b/docs/google-docs/providers/google/networkconnectivity/spokes/index.md index 48aa1f8179..55d232512d 100644 --- a/docs/google-docs/providers/google/networkconnectivity/spokes/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/spokes/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of the spoke. Spoke names must be unique. They use the following form: `projects/{project_number}/locations/{region}/spokes/{spoke_id}` | | `description` | `string` | An optional description of the spoke. | -| `createTime` | `string` | Output only. The time the spoke was created. | -| `hub` | `string` | Immutable. The name of the hub that this spoke is attached to. | -| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | -| `linkedVpcNetwork` | `object` | An existing VPC network. | -| `uniqueId` | `string` | Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different `unique_id`. | | `group` | `string` | The name of the group that this spoke is associated with. | | `linkedInterconnectAttachments` | `object` | A collection of VLAN attachment resources. These resources should be redundant attachments that all advertise the same prefixes to Google Cloud. Alternatively, in active/passive configurations, all attachments should be capable of advertising the same prefixes. | -| `linkedVpnTunnels` | `object` | A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. | +| `updateTime` | `string` | Output only. The time the spoke was last updated. | | `state` | `string` | Output only. The current lifecycle state of this spoke. | +| `linkedRouterApplianceInstances` | `object` | A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. | | `reasons` | `array` | Output only. The reasons for current state of the spoke. Only present when the spoke is in the `INACTIVE` state. | +| `uniqueId` | `string` | Output only. The Google-generated UUID for the spoke. This value is unique across all spoke resources. If a spoke is deleted and another with the same name is created, the new spoke is assigned a different `unique_id`. | +| `labels` | `object` | Optional labels in key:value format. For more information about labels, see [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements). | +| `linkedVpcNetwork` | `object` | An existing VPC network. | +| `createTime` | `string` | Output only. The time the spoke was created. | +| `hub` | `string` | Immutable. The name of the hub that this spoke is attached to. | +| `linkedVpnTunnels` | `object` | A collection of Cloud VPN tunnel resources. These resources should be redundant HA VPN tunnels that all advertise the same prefixes to Google Cloud. Alternatively, in a passive/active configuration, all tunnels should be capable of advertising the same prefixes. | | `spokeType` | `string` | Output only. The type of resource associated with the spoke. | -| `updateTime` | `string` | Output only. The time the spoke was last updated. | -| `linkedRouterApplianceInstances` | `object` | A collection of router appliance instances. If you configure multiple router appliance instances to receive data from the same set of sites outside of Google Cloud, we recommend that you associate those instances with the same spoke. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/spokes_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkconnectivity/spokes_iam_audit_configs/index.md deleted file mode 100644 index 7a8edd2e98..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/spokes_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: spokes_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - spokes_iam_audit_configs - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Namespokes_iam_audit_configs
TypeResource
Idgoogle.networkconnectivity.spokes_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_spokes_getIamPolicy` | `SELECT` | `locationsId, projectsId, spokesId` | diff --git a/docs/google-docs/providers/google/networkconnectivity/spokes_iam_bindings/index.md b/docs/google-docs/providers/google/networkconnectivity/spokes_iam_bindings/index.md deleted file mode 100644 index b5091dc111..0000000000 --- a/docs/google-docs/providers/google/networkconnectivity/spokes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: spokes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - spokes_iam_bindings - - networkconnectivity - - 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 ---- - - - -## Overview - - - - -
Namespokes_iam_bindings
TypeResource
Idgoogle.networkconnectivity.spokes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_spokes_getIamPolicy` | `SELECT` | `locationsId, projectsId, spokesId` | diff --git a/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md b/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md index 2cd4b22def..5fe1de7d97 100644 --- a/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md +++ b/docs/google-docs/providers/google/networkmanagement/connectivity_tests/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Unique name of the resource using the form: `projects/{project_id}/locations/global/connectivityTests/{test_id}` | | `description` | `string` | The user-supplied description of the Connectivity Test. Maximum of 512 characters. | -| `createTime` | `string` | Output only. The time the test was created. | | `destination` | `object` | Source or destination of the Connectivity Test. | -| `labels` | `object` | Resource labels to represent user-provided metadata. | -| `source` | `object` | Source or destination of the Connectivity Test. | -| `updateTime` | `string` | Output only. The time the test's configuration was updated. | | `displayName` | `string` | Output only. The display name of a Connectivity Test. | -| `reachabilityDetails` | `object` | Results of the configuration analysis from the last run of the test. | -| `protocol` | `string` | IP Protocol of the test. When not provided, "TCP" is assumed. | +| `source` | `object` | Source or destination of the Connectivity Test. | | `relatedProjects` | `array` | Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries. | +| `createTime` | `string` | Output only. The time the test was created. | +| `protocol` | `string` | IP Protocol of the test. When not provided, "TCP" is assumed. | +| `reachabilityDetails` | `object` | Results of the configuration analysis from the last run of the test. | +| `updateTime` | `string` | Output only. The time the test's configuration was updated. | +| `labels` | `object` | Resource labels to represent user-provided metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_audit_configs/index.md deleted file mode 100644 index 05413bee5a..0000000000 --- a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: connectivity_tests_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - connectivity_tests_iam_audit_configs - - networkmanagement - - 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 ---- - - - -## Overview - - - - -
Nameconnectivity_tests_iam_audit_configs
TypeResource
Idgoogle.networkmanagement.connectivity_tests_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_connectivityTests_getIamPolicy` | `SELECT` | `connectivityTestsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_bindings/index.md b/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_bindings/index.md deleted file mode 100644 index 23276fdc55..0000000000 --- a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: connectivity_tests_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - connectivity_tests_iam_bindings - - networkmanagement - - 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 ---- - - - -## Overview - - - - -
Nameconnectivity_tests_iam_bindings
TypeResource
Idgoogle.networkmanagement.connectivity_tests_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_global_connectivityTests_getIamPolicy` | `SELECT` | `connectivityTestsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md b/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md index 96ce0e482b..d591b7ce3c 100644 --- a/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkmanagement/connectivity_tests_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkmanagement/locations/index.md b/docs/google-docs/providers/google/networkmanagement/locations/index.md index 45d3b8f13a..9f861f0f88 100644 --- a/docs/google-docs/providers/google/networkmanagement/locations/index.md +++ b/docs/google-docs/providers/google/networkmanagement/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | -| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/address_groups/index.md b/docs/google-docs/providers/google/networksecurity/address_groups/index.md index 4bdbc82c41..f2e69f66ee 100644 --- a/docs/google-docs/providers/google/networksecurity/address_groups/index.md +++ b/docs/google-docs/providers/google/networksecurity/address_groups/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`. | | `description` | `string` | Optional. Free-text description of the resource. | -| `labels` | `object` | Optional. Set of label tags associated with the AddressGroup resource. | -| `capacity` | `integer` | Required. Capacity of the Address Group | | `selfLink` | `string` | Output only. Server-defined fully-qualified URL for this resource. | -| `items` | `array` | Optional. List of items. | -| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `capacity` | `integer` | Required. Capacity of the Address Group | | `type` | `string` | Required. The type of the Address Group. Possible values are "IPv4" or "IPV6". | +| `labels` | `object` | Optional. Set of label tags associated with the AddressGroup resource. | +| `items` | `array` | Optional. List of items. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md b/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md index 8ec56b910e..8262dec1f9 100644 --- a/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/address_groups_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md b/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md index 80fb53b254..368a991e11 100644 --- a/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the AuthorizationPolicy resource. It matches pattern `projects/{project}/locations/{location}/authorizationPolicies/`. | | `description` | `string` | Optional. Free-text description of the resource. | -| `createTime` | `string` | Output only. The timestamp when the resource was created. | | `labels` | `object` | Optional. Set of label tags associated with the AuthorizationPolicy resource. | | `rules` | `array` | Optional. List of rules to match. Note that at least one of the rules must match in order for the action specified in the 'action' field to be taken. A rule is a match if there is a matching source and destination. If left blank, the action specified in the `action` field will be applied on every request. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `action` | `string` | Required. The action to take when a rule match is found. Possible values are "ALLOW" or "DENY". | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/authorization_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/networksecurity/authorization_policies_iam_audit_configs/index.md deleted file mode 100644 index f2f6d5fa31..0000000000 --- a/docs/google-docs/providers/google/networksecurity/authorization_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: authorization_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - authorization_policies_iam_audit_configs - - networksecurity - - 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 ---- - - - -## Overview - - - - -
Nameauthorization_policies_iam_audit_configs
TypeResource
Idgoogle.networksecurity.authorization_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_authorizationPolicies_getIamPolicy` | `SELECT` | `authorizationPoliciesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networksecurity/authorization_policies_iam_bindings/index.md b/docs/google-docs/providers/google/networksecurity/authorization_policies_iam_bindings/index.md deleted file mode 100644 index 3d14633d3e..0000000000 --- a/docs/google-docs/providers/google/networksecurity/authorization_policies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: authorization_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - authorization_policies_iam_bindings - - networksecurity - - 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 ---- - - - -## Overview - - - - -
Nameauthorization_policies_iam_bindings
TypeResource
Idgoogle.networksecurity.authorization_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_authorizationPolicies_getIamPolicy` | `SELECT` | `authorizationPoliciesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_audit_configs/index.md deleted file mode 100644 index 599d138e18..0000000000 --- a/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: client_tls_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - client_tls_policies_iam_audit_configs - - networksecurity - - 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 ---- - - - -## Overview - - - - -
Nameclient_tls_policies_iam_audit_configs
TypeResource
Idgoogle.networksecurity.client_tls_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_clientTlsPolicies_getIamPolicy` | `SELECT` | `clientTlsPoliciesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_bindings/index.md b/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_bindings/index.md deleted file mode 100644 index da50d9cf34..0000000000 --- a/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: client_tls_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - client_tls_policies_iam_bindings - - networksecurity - - 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 ---- - - - -## Overview - - - - -
Nameclient_tls_policies_iam_bindings
TypeResource
Idgoogle.networksecurity.client_tls_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_clientTlsPolicies_getIamPolicy` | `SELECT` | `clientTlsPoliciesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_policies/index.md b/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_policies/index.md index c4371fbc96..5efb22ccd4 100644 --- a/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/client_tls_policies_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md b/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md index a27e051d96..a912307eb4 100644 --- a/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/gateway_security_policies/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy} gateway_security_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). | | `description` | `string` | Optional. Free-text description of the resource. | +| `tlsInspectionPolicy` | `string` | Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | -| `tlsInspectionPolicy` | `string` | Optional. Name of a TLS Inspection Policy resource that defines how TLS inspection will be performed for any rule(s) which enables it. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/locations/index.md b/docs/google-docs/providers/google/networksecurity/locations/index.md index 05fc8cc4ad..a6a97b6843 100644 --- a/docs/google-docs/providers/google/networksecurity/locations/index.md +++ b/docs/google-docs/providers/google/networksecurity/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | -| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/operations/index.md b/docs/google-docs/providers/google/networksecurity/operations/index.md index d3809231c7..d29c183424 100644 --- a/docs/google-docs/providers/google/networksecurity/operations/index.md +++ b/docs/google-docs/providers/google/networksecurity/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/rules/index.md b/docs/google-docs/providers/google/networksecurity/rules/index.md index d0d56d79f5..0051ffa335 100644 --- a/docs/google-docs/providers/google/networksecurity/rules/index.md +++ b/docs/google-docs/providers/google/networksecurity/rules/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Immutable. Name of the resource. ame is the full resource name so projects/{project}/locations/{location}/gatewaySecurityPolicies/{gateway_security_policy}/rules/{rule} rule should match the pattern: (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). | | `description` | `string` | Optional. Free-text description of the resource. | +| `applicationMatcher` | `string` | Optional. CEL expression for matching on L7/application level criteria. | +| `enabled` | `boolean` | Required. Whether the rule is enforced. | +| `priority` | `integer` | Required. Priority of the rule. Lower number corresponds to higher precedence. | +| `updateTime` | `string` | Output only. Time when the rule was updated. | | `sessionMatcher` | `string` | Required. CEL expression for matching on session criteria. | -| `createTime` | `string` | Output only. Time when the rule was created. | | `tlsInspectionEnabled` | `boolean` | Optional. Flag to enable TLS inspection of traffic matching on , can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig. | +| `createTime` | `string` | Output only. Time when the rule was created. | | `basicProfile` | `string` | Required. Profile which tells what the primitive action should be. | -| `updateTime` | `string` | Output only. Time when the rule was updated. | -| `priority` | `integer` | Required. Priority of the rule. Lower number corresponds to higher precedence. | -| `applicationMatcher` | `string` | Optional. CEL expression for matching on L7/application level criteria. | -| `enabled` | `boolean` | Required. Whether the rule is enforced. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md b/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md index 7335393a11..96b49ed067 100644 --- a/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/server_tls_policies/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the ServerTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/serverTlsPolicies/{server_tls_policy}` | | `description` | `string` | Free-text description of the resource. | +| `mtlsPolicy` | `object` | Specification of the MTLSPolicy. | +| `serverCertificate` | `object` | Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `allowOpen` | `boolean` | This field applies only for Traffic Director policies. It is must be set to false for external HTTPS load balancer policies. Determines if server allows plaintext connections. If set to true, server allows plain text connections. By default, it is set to false. This setting is not exclusive of other encryption modes. For example, if `allow_open` and `mtls_policy` are set, server allows both plain text and mTLS connections. See documentation of other encryption modes to confirm compatibility. Consider using it if you wish to upgrade in place your deployment to TLS while having mixed TLS and non-TLS traffic reaching port :80. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `labels` | `object` | Set of label tags associated with the resource. | -| `mtlsPolicy` | `object` | Specification of the MTLSPolicy. | -| `serverCertificate` | `object` | Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_audit_configs/index.md deleted file mode 100644 index 1c7acf0930..0000000000 --- a/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: server_tls_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - server_tls_policies_iam_audit_configs - - networksecurity - - 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 ---- - - - -## Overview - - - - -
Nameserver_tls_policies_iam_audit_configs
TypeResource
Idgoogle.networksecurity.server_tls_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serverTlsPolicies_getIamPolicy` | `SELECT` | `locationsId, projectsId, serverTlsPoliciesId` | diff --git a/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_bindings/index.md b/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_bindings/index.md deleted file mode 100644 index 044147d95a..0000000000 --- a/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: server_tls_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - server_tls_policies_iam_bindings - - networksecurity - - 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 ---- - - - -## Overview - - - - -
Nameserver_tls_policies_iam_bindings
TypeResource
Idgoogle.networksecurity.server_tls_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serverTlsPolicies_getIamPolicy` | `SELECT` | `locationsId, projectsId, serverTlsPoliciesId` | diff --git a/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_policies/index.md b/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_policies/index.md index 69eae8453f..3b95de6136 100644 --- a/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/server_tls_policies_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md b/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md index 6e03703f0b..2dd9d9a2bb 100644 --- a/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/tls_inspection_policies/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the resource. Name is of the form projects/{project}/locations/{location}/tlsInspectionPolicies/{tls_inspection_policy} tls_inspection_policy should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). | | `description` | `string` | Optional. Free-text description of the resource. | -| `excludePublicCaSet` | `boolean` | Optional. If FALSE (the default), use our default set of public CAs in addition to any CAs specified in trust_config. These public CAs are currently based on the Mozilla Root Program and are subject to change over time. If TRUE, do not accept our default set of public CAs. Only CAs specified in trust_config will be accepted. This defaults to FALSE (use public CAs in addition to trust_config) for backwards compatibility, but trusting public root CAs is *not recommended* unless the traffic in question is outbound to public web servers. When possible, prefer setting this to "false" and explicitly specifying trusted CAs and certificates in a TrustConfig. Note that Secure Web Proxy does not yet honor this field. | -| `minTlsVersion` | `string` | Optional. Minimum TLS version that the firewall should use when negotiating connections with both clients and servers. If this is not set, then the default value is to allow the broadest set of clients and servers (TLS 1.0 or higher). Setting this to more restrictive values may improve security, but may also prevent the firewall from connecting to some clients or servers. Note that Secure Web Proxy does not yet honor this field. | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | -| `tlsFeatureProfile` | `string` | Optional. The selected Profile. If this is not set, then the default value is to allow the broadest set of clients and servers ("PROFILE_COMPATIBLE"). Setting this to more restrictive values may improve security, but may also prevent the TLS inspection proxy from connecting to some clients or servers. Note that Secure Web Proxy does not yet honor this field. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `customTlsFeatures` | `array` | Optional. List of custom TLS cipher suites selected. This field is valid only if the selected tls_feature_profile is CUSTOM. The compute.SslPoliciesService.ListAvailableFeatures method returns the set of features that can be specified in this list. Note that Secure Web Proxy does not yet honor this field. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `minTlsVersion` | `string` | Optional. Minimum TLS version that the firewall should use when negotiating connections with both clients and servers. If this is not set, then the default value is to allow the broadest set of clients and servers (TLS 1.0 or higher). Setting this to more restrictive values may improve security, but may also prevent the firewall from connecting to some clients or servers. Note that Secure Web Proxy does not yet honor this field. | +| `excludePublicCaSet` | `boolean` | Optional. If FALSE (the default), use our default set of public CAs in addition to any CAs specified in trust_config. These public CAs are currently based on the Mozilla Root Program and are subject to change over time. If TRUE, do not accept our default set of public CAs. Only CAs specified in trust_config will be accepted. This defaults to FALSE (use public CAs in addition to trust_config) for backwards compatibility, but trusting public root CAs is *not recommended* unless the traffic in question is outbound to public web servers. When possible, prefer setting this to "false" and explicitly specifying trusted CAs and certificates in a TrustConfig. Note that Secure Web Proxy does not yet honor this field. | | `trustConfig` | `string` | Optional. A TrustConfig resource used when making a connection to the TLS server. This is a relative resource path following the form "projects/{project}/locations/{location}/trustConfigs/{trust_config}". This is necessary to intercept TLS connections to servers with certificates signed by a private CA or self-signed certificates. Note that Secure Web Proxy does not yet honor this field. | | `caPool` | `string` | Required. A CA pool resource used to issue interception certificates. The CA pool string has a relative resource path following the form "projects/{project}/locations/{location}/caPools/{ca_pool}". | +| `tlsFeatureProfile` | `string` | Optional. The selected Profile. If this is not set, then the default value is to allow the broadest set of clients and servers ("PROFILE_COMPATIBLE"). Setting this to more restrictive values may improve security, but may also prevent the TLS inspection proxy from connecting to some clients or servers. Note that Secure Web Proxy does not yet honor this field. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_audit_configs/index.md deleted file mode 100644 index ffc2ce8f54..0000000000 --- a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: edge_cache_keysets_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - edge_cache_keysets_iam_audit_configs - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameedge_cache_keysets_iam_audit_configs
TypeResource
Idgoogle.networkservices.edge_cache_keysets_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_edgeCacheKeysets_getIamPolicy` | `SELECT` | `edgeCacheKeysetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_bindings/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_bindings/index.md deleted file mode 100644 index c973f9f24d..0000000000 --- a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: edge_cache_keysets_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - edge_cache_keysets_iam_bindings - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameedge_cache_keysets_iam_bindings
TypeResource
Idgoogle.networkservices.edge_cache_keysets_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_edgeCacheKeysets_getIamPolicy` | `SELECT` | `edgeCacheKeysetsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md index 9768f3fdc5..f541aefaea 100644 --- a/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/edge_cache_keysets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_audit_configs/index.md deleted file mode 100644 index 43e056dcbd..0000000000 --- a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: edge_cache_origins_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - edge_cache_origins_iam_audit_configs - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameedge_cache_origins_iam_audit_configs
TypeResource
Idgoogle.networkservices.edge_cache_origins_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_edgeCacheOrigins_getIamPolicy` | `SELECT` | `edgeCacheOriginsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_bindings/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_bindings/index.md deleted file mode 100644 index a13cf4c4d6..0000000000 --- a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: edge_cache_origins_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - edge_cache_origins_iam_bindings - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameedge_cache_origins_iam_bindings
TypeResource
Idgoogle.networkservices.edge_cache_origins_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_edgeCacheOrigins_getIamPolicy` | `SELECT` | `edgeCacheOriginsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md index 2f50471612..64162b8db2 100644 --- a/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/edge_cache_origins_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_audit_configs/index.md deleted file mode 100644 index 42fb0c0764..0000000000 --- a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: edge_cache_services_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - edge_cache_services_iam_audit_configs - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameedge_cache_services_iam_audit_configs
TypeResource
Idgoogle.networkservices.edge_cache_services_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_edgeCacheServices_getIamPolicy` | `SELECT` | `edgeCacheServicesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_bindings/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_bindings/index.md deleted file mode 100644 index eb0fcd28d4..0000000000 --- a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: edge_cache_services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - edge_cache_services_iam_bindings - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameedge_cache_services_iam_bindings
TypeResource
Idgoogle.networkservices.edge_cache_services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_edgeCacheServices_getIamPolicy` | `SELECT` | `edgeCacheServicesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md index 39bdb750f0..3c699a9e5b 100644 --- a/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/edge_cache_services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md b/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md index 01b3e68db0..e67a727f84 100644 --- a/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the EndpointPolicy resource. It matches pattern `projects/{project}/locations/global/endpointPolicies/{endpoint_policy}`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | -| `trafficPortSelector` | `object` | Specification of a port-based selector. | +| `type` | `string` | Required. The type of endpoint policy. This is primarily used to validate the configuration. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | -| `serverTlsPolicy` | `string` | Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint. | +| `endpointMatcher` | `object` | A definition of a matcher that selects endpoints to which the policies should be applied. | | `labels` | `object` | Optional. Set of label tags associated with the EndpointPolicy resource. | -| `authorizationPolicy` | `string` | Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. | +| `trafficPortSelector` | `object` | Specification of a port-based selector. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `clientTlsPolicy` | `string` | Optional. A URL referring to a ClientTlsPolicy resource. ClientTlsPolicy can be set to specify the authentication for traffic from the proxy to the actual endpoints. More specifically, it is applied to the outgoing traffic from the proxy to the endpoint. This is typically used for sidecar model where the proxy identifies itself as endpoint to the control plane, with the connection between sidecar and endpoint requiring authentication. If this field is not set, authentication is disabled(open). Applicable only when EndpointPolicyType is SIDECAR_PROXY. | -| `type` | `string` | Required. The type of endpoint policy. This is primarily used to validate the configuration. | -| `endpointMatcher` | `object` | A definition of a matcher that selects endpoints to which the policies should be applied. | +| `serverTlsPolicy` | `string` | Optional. A URL referring to ServerTlsPolicy resource. ServerTlsPolicy is used to determine the authentication policy to be applied to terminate the inbound traffic at the identified backends. If this field is not set, authentication is disabled(open) for this endpoint. | +| `authorizationPolicy` | `string` | Optional. This field specifies the URL of AuthorizationPolicy resource that applies authorization policies to the inbound traffic at the matched endpoints. Refer to Authorization. If this field is not specified, authorization is disabled(no authz checks) for this endpoint. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_audit_configs/index.md deleted file mode 100644 index b6644527a2..0000000000 --- a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: endpoint_policies_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - endpoint_policies_iam_audit_configs - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameendpoint_policies_iam_audit_configs
TypeResource
Idgoogle.networkservices.endpoint_policies_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_endpointPolicies_getIamPolicy` | `SELECT` | `endpointPoliciesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_bindings/index.md b/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_bindings/index.md deleted file mode 100644 index 84b617fef3..0000000000 --- a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: endpoint_policies_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - endpoint_policies_iam_bindings - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameendpoint_policies_iam_bindings
TypeResource
Idgoogle.networkservices.endpoint_policies_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_endpointPolicies_getIamPolicy` | `SELECT` | `endpointPoliciesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md index f7db60bb6d..bf6d21123e 100644 --- a/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/endpoint_policies_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/gateways/index.md b/docs/google-docs/providers/google/networkservices/gateways/index.md index 0be13f1296..95cf25ef2d 100644 --- a/docs/google-docs/providers/google/networkservices/gateways/index.md +++ b/docs/google-docs/providers/google/networkservices/gateways/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the Gateway resource. It matches pattern `projects/*/locations/*/gateways/`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | -| `scope` | `string` | Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. | -| `createTime` | `string` | Output only. The timestamp when the resource was created. | -| `ports` | `array` | Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. | +| `gatewaySecurityPolicy` | `string` | Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example: `projects/*/locations/*/gatewaySecurityPolicies/swg-policy`. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'. | | `addresses` | `array` | Optional. Zero or one IPv4 or IPv6 address on which the Gateway will receive the traffic. When no address is provided, an IP from the subnetwork is allocated This field only applies to gateways of type 'SECURE_WEB_GATEWAY'. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6. | -| `type` | `string` | Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned. | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | -| `certificateUrls` | `array` | Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. | | `labels` | `object` | Optional. Set of label tags associated with the Gateway resource. | | `network` | `string` | Optional. The relative resource name identifying the VPC network that is using this configuration. For example: `projects/*/global/networks/network-1`. Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY'. | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | -| `gatewaySecurityPolicy` | `string` | Optional. A fully-qualified GatewaySecurityPolicy URL reference. Defines how a server should apply security policy to inbound (VM to Proxy) initiated connections. For example: `projects/*/locations/*/gatewaySecurityPolicies/swg-policy`. This policy is specific to gateways of type 'SECURE_WEB_GATEWAY'. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | | `serverTlsPolicy` | `string` | Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. | +| `type` | `string` | Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned. | +| `certificateUrls` | `array` | Optional. A fully-qualified Certificates URL reference. The proxy presents a Certificate (selected based on SNI) when establishing a TLS connection. This feature only applies to gateways of type 'SECURE_WEB_GATEWAY'. | | `subnetwork` | `string` | Optional. The relative resource name identifying the subnetwork in which this SWG is allocated. For example: `projects/*/regions/us-central1/subnetworks/network-1` Currently, this field is specific to gateways of type 'SECURE_WEB_GATEWAY". | +| `ports` | `array` | Required. One or more port numbers (1-65535), on which the Gateway will receive traffic. The proxy binds to the specified ports. Gateways of type 'SECURE_WEB_GATEWAY' are limited to 1 port. Gateways of type 'OPEN_MESH' listen on 0.0.0.0 for IPv4 and :: for IPv6 and support multiple ports. | +| `scope` | `string` | Optional. Scope determines how configuration across multiple Gateway instances are merged. The configuration for multiple Gateway instances with the same scope will be merged as presented as a single coniguration to the proxy/load balancer. Max length 64 characters. Scope should start with a letter and can only have letters, numbers, hyphens. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/gateways_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkservices/gateways_iam_audit_configs/index.md deleted file mode 100644 index 9dddaf3067..0000000000 --- a/docs/google-docs/providers/google/networkservices/gateways_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: gateways_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - gateways_iam_audit_configs - - networkservices - - 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 ---- - - - -## Overview - - - - -
Namegateways_iam_audit_configs
TypeResource
Idgoogle.networkservices.gateways_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_gateways_getIamPolicy` | `SELECT` | `gatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/gateways_iam_bindings/index.md b/docs/google-docs/providers/google/networkservices/gateways_iam_bindings/index.md deleted file mode 100644 index 8b99805019..0000000000 --- a/docs/google-docs/providers/google/networkservices/gateways_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: gateways_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - gateways_iam_bindings - - networkservices - - 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 ---- - - - -## Overview - - - - -
Namegateways_iam_bindings
TypeResource
Idgoogle.networkservices.gateways_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_gateways_getIamPolicy` | `SELECT` | `gatewaysId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/grpc_routes/index.md b/docs/google-docs/providers/google/networkservices/grpc_routes/index.md index 399439f05b..1c4be4b78a 100644 --- a/docs/google-docs/providers/google/networkservices/grpc_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/grpc_routes/index.md @@ -30,13 +30,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Required. Name of the GrpcRoute resource. It matches pattern `projects/*/locations/global/grpcRoutes/` | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | | `rules` | `array` | Required. A list of detailed rules defining how to route traffic. Within a single GrpcRoute, the GrpcRoute.RouteAction associated with the first matching GrpcRoute.RouteRule will be executed. At least one rule must be supplied. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `gateways` | `array` | Optional. Gateways defines a list of gateways this GrpcRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | +| `hostnames` | `array` | Required. Service hostnames with an optional port for which this route describes traffic. Format: [:] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same route, it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service"). | | `meshes` | `array` | Optional. Meshes defines a list of meshes this GrpcRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` | | `labels` | `object` | Optional. Set of label tags associated with the GrpcRoute resource. | -| `hostnames` | `array` | Required. Service hostnames with an optional port for which this route describes traffic. Format: [:] Hostname is the fully qualified domain name of a network host. This matches the RFC 1123 definition of a hostname with 2 notable exceptions: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateway must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same route, it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`. If a port is specified, then gRPC clients must use the channel URI with the port to match this rule (i.e. "xds:///service:123"), otherwise they must supply the URI without a port (i.e. "xds:///service"). | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | -| `createTime` | `string` | Output only. The timestamp when the resource was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/http_routes/index.md b/docs/google-docs/providers/google/networkservices/http_routes/index.md index e1ef2bdfcd..04f66515b6 100644 --- a/docs/google-docs/providers/google/networkservices/http_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/http_routes/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the HttpRoute resource. It matches pattern `projects/*/locations/global/httpRoutes/http_route_name>`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | | `rules` | `array` | Required. Rules that define how traffic is routed and handled. Rules will be matched sequentially based on the RouteMatch specified for the rule. | | `gateways` | `array` | Optional. Gateways defines a list of gateways this HttpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | -| `hostnames` | `array` | Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`. | -| `labels` | `object` | Optional. Set of label tags associated with the HttpRoute resource. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `meshes` | `array` | Optional. Meshes defines a list of meshes this HttpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR | +| `hostnames` | `array` | Required. Hostnames define a set of hosts that should match against the HTTP host header to select a HttpRoute to process the request. Hostname is the fully qualified domain name of a network host, as defined by RFC 1123 with the exception that: - IPs are not allowed. - A hostname may be prefixed with a wildcard label (`*.`). The wildcard label must appear by itself as the first label. Hostname can be "precise" which is a domain name without the terminating dot of a network host (e.g. `foo.example.com`) or "wildcard", which is a domain name prefixed with a single wildcard label (e.g. `*.example.com`). Note that as per RFC1035 and RFC1123, a label must consist of lower case alphanumeric characters or '-', and must start and end with an alphanumeric character. No other punctuation is allowed. The routes associated with a Mesh or Gateways must have unique hostnames. If you attempt to attach multiple routes with conflicting hostnames, the configuration will be rejected. For example, while it is acceptable for routes for the hostnames `*.foo.bar.com` and `*.bar.com` to be associated with the same Mesh (or Gateways under the same scope), it is not possible to associate two routes both with `*.bar.com` or both with `bar.com`. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `labels` | `object` | Optional. Set of label tags associated with the HttpRoute resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/locations/index.md b/docs/google-docs/providers/google/networkservices/locations/index.md index ffea501771..84b96a31de 100644 --- a/docs/google-docs/providers/google/networkservices/locations/index.md +++ b/docs/google-docs/providers/google/networkservices/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/meshes/index.md b/docs/google-docs/providers/google/networkservices/meshes/index.md index df78633ff8..a328d68c65 100644 --- a/docs/google-docs/providers/google/networkservices/meshes/index.md +++ b/docs/google-docs/providers/google/networkservices/meshes/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the Mesh resource. It matches pattern `projects/*/locations/global/meshes/`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `interceptionPort` | `integer` | Optional. If set to a valid TCP port (1-65535), instructs the SIDECAR proxy to listen on the specified port of localhost (127.0.0.1) address. The SIDECAR proxy will expect all traffic to be redirected to this port regardless of its actual ip:port destination. If unset, a port '15001' is used as the interception port. This is applicable only for sidecar proxy deployments. | | `labels` | `object` | Optional. Set of label tags associated with the Mesh resource. | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/meshes_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkservices/meshes_iam_audit_configs/index.md deleted file mode 100644 index bdd3937aa9..0000000000 --- a/docs/google-docs/providers/google/networkservices/meshes_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: meshes_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - meshes_iam_audit_configs - - networkservices - - 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 ---- - - - -## Overview - - - - -
Namemeshes_iam_audit_configs
TypeResource
Idgoogle.networkservices.meshes_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_meshes_getIamPolicy` | `SELECT` | `locationsId, meshesId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/meshes_iam_bindings/index.md b/docs/google-docs/providers/google/networkservices/meshes_iam_bindings/index.md deleted file mode 100644 index a7202b25d1..0000000000 --- a/docs/google-docs/providers/google/networkservices/meshes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: meshes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - meshes_iam_bindings - - networkservices - - 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 ---- - - - -## Overview - - - - -
Namemeshes_iam_bindings
TypeResource
Idgoogle.networkservices.meshes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_meshes_getIamPolicy` | `SELECT` | `locationsId, meshesId, projectsId` | diff --git a/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md index 67dd4a4c07..ba48fd9dd0 100644 --- a/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/meshes_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/operations/index.md b/docs/google-docs/providers/google/networkservices/operations/index.md index f380faeb06..021449c123 100644 --- a/docs/google-docs/providers/google/networkservices/operations/index.md +++ b/docs/google-docs/providers/google/networkservices/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `done` | `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. | -| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/service_bindings_iam_audit_configs/index.md b/docs/google-docs/providers/google/networkservices/service_bindings_iam_audit_configs/index.md deleted file mode 100644 index ccebf0f65b..0000000000 --- a/docs/google-docs/providers/google/networkservices/service_bindings_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: service_bindings_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - service_bindings_iam_audit_configs - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameservice_bindings_iam_audit_configs
TypeResource
Idgoogle.networkservices.service_bindings_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceBindings_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceBindingsId` | diff --git a/docs/google-docs/providers/google/networkservices/service_bindings_iam_bindings/index.md b/docs/google-docs/providers/google/networkservices/service_bindings_iam_bindings/index.md deleted file mode 100644 index c4140e0878..0000000000 --- a/docs/google-docs/providers/google/networkservices/service_bindings_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: service_bindings_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - service_bindings_iam_bindings - - networkservices - - 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 ---- - - - -## Overview - - - - -
Nameservice_bindings_iam_bindings
TypeResource
Idgoogle.networkservices.service_bindings_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_serviceBindings_getIamPolicy` | `SELECT` | `locationsId, projectsId, serviceBindingsId` | diff --git a/docs/google-docs/providers/google/networkservices/service_bindings_iam_policies/index.md b/docs/google-docs/providers/google/networkservices/service_bindings_iam_policies/index.md index ee0c10db47..6ab0b6b0e4 100644 --- a/docs/google-docs/providers/google/networkservices/service_bindings_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/service_bindings_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/tcp_routes/index.md b/docs/google-docs/providers/google/networkservices/tcp_routes/index.md index 82da29bfe3..314db8edb2 100644 --- a/docs/google-docs/providers/google/networkservices/tcp_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/tcp_routes/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the TcpRoute resource. It matches pattern `projects/*/locations/global/tcpRoutes/tcp_route_name>`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | -| `rules` | `array` | Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. | -| `meshes` | `array` | Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | | `gateways` | `array` | Optional. Gateways defines a list of gateways this TcpRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | | `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `meshes` | `array` | Optional. Meshes defines a list of meshes this TcpRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR | +| `rules` | `array` | Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. | | `labels` | `object` | Optional. Set of label tags associated with the TcpRoute resource. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/networkservices/tls_routes/index.md b/docs/google-docs/providers/google/networkservices/tls_routes/index.md index 97bd8dd1ed..36ab7098f4 100644 --- a/docs/google-docs/providers/google/networkservices/tls_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/tls_routes/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the TlsRoute resource. It matches pattern `projects/*/locations/global/tlsRoutes/tls_route_name>`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `gateways` | `array` | Optional. Gateways defines a list of gateways this TlsRoute is attached to, as one of the routing rules to route the requests served by the gateway. Each gateway reference should match the pattern: `projects/*/locations/global/gateways/` | | `meshes` | `array` | Optional. Meshes defines a list of meshes this TlsRoute is attached to, as one of the routing rules to route the requests served by the mesh. Each mesh reference should match the pattern: `projects/*/locations/global/meshes/` The attached Mesh should be of a type SIDECAR | | `rules` | `array` | Required. Rules that define how traffic is routed and handled. At least one RouteRule must be supplied. If there are multiple rules then the action taken will be the first rule to match. | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/environments/index.md b/docs/google-docs/providers/google/notebooks/environments/index.md deleted file mode 100644 index 85c7ef4dc0..0000000000 --- a/docs/google-docs/providers/google/notebooks/environments/index.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: environments -hide_title: false -hide_table_of_contents: false -keywords: - - environments - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameenvironments
TypeResource
Idgoogle.notebooks.environments
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Name of this environment. Format: `projects/{project_id}/locations/{location}/environments/{environment_id}` | -| `description` | `string` | A brief description of this environment. | -| `createTime` | `string` | Output only. The time at which this environment was created. | -| `displayName` | `string` | Display name of this environment for the UI. | -| `postStartupScript` | `string` | Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path. Example: `"gs://path-to-file/file-name"` | -| `vmImage` | `object` | Definition of a custom Compute Engine virtual machine image for starting a notebook instance with the environment installed directly on the VM. | -| `containerImage` | `object` | Definition of a container image for starting a notebook instance with the environment installed in a container. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_environments_get` | `SELECT` | `environmentsId, locationsId, projectsId` | Gets details of a single Environment. | -| `projects_locations_environments_list` | `SELECT` | `locationsId, projectsId` | Lists environments in a project. | -| `projects_locations_environments_create` | `INSERT` | `locationsId, projectsId` | Creates a new Environment. | -| `projects_locations_environments_delete` | `DELETE` | `environmentsId, locationsId, projectsId` | Deletes a single Environment. | diff --git a/docs/google-docs/providers/google/notebooks/executions/index.md b/docs/google-docs/providers/google/notebooks/executions/index.md deleted file mode 100644 index 72236cf619..0000000000 --- a/docs/google-docs/providers/google/notebooks/executions/index.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: executions -hide_title: false -hide_table_of_contents: false -keywords: - - executions - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameexecutions
TypeResource
Idgoogle.notebooks.executions
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the execute. Format: `projects/{project_id}/locations/{location}/executions/{execution_id}` | -| `description` | `string` | A brief description of this execution. | -| `updateTime` | `string` | Output only. Time the Execution was last updated. | -| `createTime` | `string` | Output only. Time the Execution was instantiated. | -| `outputNotebookFile` | `string` | Output notebook file generated by this execution | -| `displayName` | `string` | Output only. Name used for UI purposes. Name can only contain alphanumeric characters and underscores '_'. | -| `executionTemplate` | `object` | The description a notebook execution workload. | -| `jobUri` | `string` | Output only. The URI of the external job used to execute the notebook. | -| `state` | `string` | Output only. State of the underlying AI Platform job. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_executions_get` | `SELECT` | `executionsId, locationsId, projectsId` | Gets details of executions | -| `projects_locations_executions_list` | `SELECT` | `locationsId, projectsId` | Lists executions in a given project and location | -| `projects_locations_executions_create` | `INSERT` | `locationsId, projectsId` | Creates a new Execution in a given project and location. | -| `projects_locations_executions_delete` | `DELETE` | `executionsId, locationsId, projectsId` | Deletes execution | diff --git a/docs/google-docs/providers/google/notebooks/instances/index.md b/docs/google-docs/providers/google/notebooks/instances/index.md index 451b2c326c..c1093ea13a 100644 --- a/docs/google-docs/providers/google/notebooks/instances/index.md +++ b/docs/google-docs/providers/google/notebooks/instances/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Output only. Unique ID of the resource. | | `name` | `string` | Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}` | +| `healthState` | `string` | Output only. Instance health_state. | | `creator` | `string` | Output only. Email address of entity that sent original CreateInstance request. | -| `labels` | `object` | Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. | | `proxyUri` | `string` | Output only. The proxy endpoint that is used to access the Jupyter notebook. | | `updateTime` | `string` | Output only. Instance update time. | +| `state` | `string` | Output only. The state of this instance. | +| `upgradeHistory` | `array` | Output only. The upgrade history of this instance. | +| `createTime` | `string` | Output only. Instance creation time. | +| `labels` | `object` | Optional. Labels to apply to this instance. These can be later modified by the UpdateInstance method. | | `healthInfo` | `object` | Output only. Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" } | +| `disableProxyAccess` | `boolean` | Optional. If true, the notebook instance will not register with the proxy. | | `gceSetup` | `object` | The definition of how to configure a VM instance outside of Resources and Identity. | -| `createTime` | `string` | Output only. Instance creation time. | -| `healthState` | `string` | Output only. Instance health_state. | | `instanceOwners` | `array` | Optional. Input only. The owner of this instance after creation. Format: `alias@example.com` Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance. | -| `disableProxyAccess` | `boolean` | Optional. If true, the notebook instance will not register with the proxy. | -| `state` | `string` | Output only. The state of this instance. | -| `upgradeHistory` | `array` | Output only. The upgrade history of this instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/instances_iam_bindings/index.md b/docs/google-docs/providers/google/notebooks/instances_iam_bindings/index.md deleted file mode 100644 index 78a5172170..0000000000 --- a/docs/google-docs/providers/google/notebooks/instances_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instances_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_bindings - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_bindings
TypeResource
Idgoogle.notebooks.instances_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_instances_getIamPolicy` | `SELECT` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md b/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md index 9eba0b7294..7ed3000663 100644 --- a/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/notebooks/instances_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/instances_instance_health/index.md b/docs/google-docs/providers/google/notebooks/instances_instance_health/index.md deleted file mode 100644 index 2dd704dae5..0000000000 --- a/docs/google-docs/providers/google/notebooks/instances_instance_health/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: instances_instance_health -hide_title: false -hide_table_of_contents: false -keywords: - - instances_instance_health - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameinstances_instance_health
TypeResource
Idgoogle.notebooks.instances_instance_health
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `healthInfo` | `object` | Output only. Additional information about instance health. Example: healthInfo": { "docker_proxy_agent_status": "1", "docker_status": "1", "jupyterlab_api_status": "-1", "jupyterlab_status": "-1", "updated": "2020-10-18 09:40:03.573409" } | -| `healthState` | `string` | Output only. Runtime health_state. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_instances_getInstanceHealth` | `SELECT` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/notebooks/locations/index.md b/docs/google-docs/providers/google/notebooks/locations/index.md index f7903c647f..7c29594804 100644 --- a/docs/google-docs/providers/google/notebooks/locations/index.md +++ b/docs/google-docs/providers/google/notebooks/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/operations/index.md b/docs/google-docs/providers/google/notebooks/operations/index.md index ab05500f74..5e31d04e79 100644 --- a/docs/google-docs/providers/google/notebooks/operations/index.md +++ b/docs/google-docs/providers/google/notebooks/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/runtimes/index.md b/docs/google-docs/providers/google/notebooks/runtimes/index.md deleted file mode 100644 index a86cb61c6e..0000000000 --- a/docs/google-docs/providers/google/notebooks/runtimes/index.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: runtimes -hide_title: false -hide_table_of_contents: false -keywords: - - runtimes - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameruntimes
TypeResource
Idgoogle.notebooks.runtimes
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The resource name of the runtime. Format: `projects/{project}/locations/{location}/runtimes/{runtimeId}` | -| `softwareConfig` | `object` | Specifies the selection and configuration of software inside the runtime. The properties to set on runtime. Properties keys are specified in `key:value` format, for example: * `idle_shutdown: true` * `idle_shutdown_timeout: 180` * `enable_health_monitoring: true` | -| `createTime` | `string` | Output only. Runtime creation time. | -| `updateTime` | `string` | Output only. Runtime update time. | -| `virtualMachine` | `object` | Runtime using Virtual Machine for computing. | -| `state` | `string` | Output only. Runtime state. | -| `healthState` | `string` | Output only. Runtime health_state. | -| `accessConfig` | `object` | Specifies the login configuration for Runtime | -| `metrics` | `object` | Contains runtime daemon metrics, such as OS and kernels and sessions stats. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_runtimes_get` | `SELECT` | `locationsId, projectsId, runtimesId` | Gets details of a single Runtime. The location must be a regional endpoint rather than zonal. | -| `projects_locations_runtimes_list` | `SELECT` | `locationsId, projectsId` | Lists Runtimes in a given project and location. | -| `projects_locations_runtimes_create` | `INSERT` | `locationsId, projectsId` | Creates a new Runtime in a given project and location. | -| `projects_locations_runtimes_delete` | `DELETE` | `locationsId, projectsId, runtimesId` | Deletes a single Runtime. | -| `projects_locations_runtimes_diagnose` | `EXEC` | `locationsId, projectsId, runtimesId` | Creates a Diagnostic File and runs Diagnostic Tool given a Runtime. | -| `projects_locations_runtimes_patch` | `EXEC` | `locationsId, projectsId, runtimesId` | Update Notebook Runtime configuration. | -| `projects_locations_runtimes_refreshRuntimeTokenInternal` | `EXEC` | `locationsId, projectsId, runtimesId` | Gets an access token for the consumer service account that the customer attached to the runtime. Only accessible from the tenant instance. | -| `projects_locations_runtimes_reportEvent` | `EXEC` | `locationsId, projectsId, runtimesId` | Report and process a runtime event. | -| `projects_locations_runtimes_reset` | `EXEC` | `locationsId, projectsId, runtimesId` | Resets a Managed Notebook Runtime. | -| `projects_locations_runtimes_start` | `EXEC` | `locationsId, projectsId, runtimesId` | Starts a Managed Notebook Runtime. Perform "Start" on GPU instances; "Resume" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance | -| `projects_locations_runtimes_stop` | `EXEC` | `locationsId, projectsId, runtimesId` | Stops a Managed Notebook Runtime. Perform "Stop" on GPU instances; "Suspend" on CPU instances See: https://cloud.google.com/compute/docs/instances/stop-start-instance https://cloud.google.com/compute/docs/instances/suspend-resume-instance | -| `projects_locations_runtimes_switch` | `EXEC` | `locationsId, projectsId, runtimesId` | Switch a Managed Notebook Runtime. | -| `projects_locations_runtimes_upgrade` | `EXEC` | `locationsId, projectsId, runtimesId` | Upgrades a Managed Notebook Runtime to the latest version. | diff --git a/docs/google-docs/providers/google/notebooks/runtimes_iam_bindings/index.md b/docs/google-docs/providers/google/notebooks/runtimes_iam_bindings/index.md deleted file mode 100644 index 2f2d40c8c9..0000000000 --- a/docs/google-docs/providers/google/notebooks/runtimes_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: runtimes_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - runtimes_iam_bindings - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameruntimes_iam_bindings
TypeResource
Idgoogle.notebooks.runtimes_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_runtimes_getIamPolicy` | `SELECT` | `locationsId, projectsId, runtimesId` | diff --git a/docs/google-docs/providers/google/notebooks/runtimes_iam_policies/index.md b/docs/google-docs/providers/google/notebooks/runtimes_iam_policies/index.md deleted file mode 100644 index 277dd84130..0000000000 --- a/docs/google-docs/providers/google/notebooks/runtimes_iam_policies/index.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: runtimes_iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - runtimes_iam_policies - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameruntimes_iam_policies
TypeResource
Idgoogle.notebooks.runtimes_iam_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_runtimes_getIamPolicy` | `SELECT` | `locationsId, projectsId, runtimesId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | -| `projects_locations_runtimes_setIamPolicy` | `EXEC` | `locationsId, projectsId, runtimesId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | -| `projects_locations_runtimes_testIamPermissions` | `EXEC` | `locationsId, projectsId, runtimesId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/notebooks/schedules/index.md b/docs/google-docs/providers/google/notebooks/schedules/index.md deleted file mode 100644 index 7ef6188576..0000000000 --- a/docs/google-docs/providers/google/notebooks/schedules/index.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: schedules -hide_title: false -hide_table_of_contents: false -keywords: - - schedules - - notebooks - - 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 ---- - - - -## Overview - - - - -
Nameschedules
TypeResource
Idgoogle.notebooks.schedules
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The name of this schedule. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}` | -| `description` | `string` | A brief description of this environment. | -| `updateTime` | `string` | Output only. Time the schedule was last updated. | -| `displayName` | `string` | Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens '-', and underscores '_'. | -| `recentExecutions` | `array` | Output only. The most recent execution names triggered from this schedule and their corresponding states. | -| `state` | `string` | | -| `executionTemplate` | `object` | The description a notebook execution workload. | -| `timeZone` | `string` | Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). | -| `createTime` | `string` | Output only. Time the schedule was created. | -| `cronSchedule` | `string` | Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_schedules_get` | `SELECT` | `locationsId, projectsId, schedulesId` | Gets details of schedule | -| `projects_locations_schedules_list` | `SELECT` | `locationsId, projectsId` | Lists schedules in a given project and location. | -| `projects_locations_schedules_create` | `INSERT` | `locationsId, projectsId` | Creates a new Scheduled Notebook in a given project and location. | -| `projects_locations_schedules_delete` | `DELETE` | `locationsId, projectsId, schedulesId` | Deletes schedule and all underlying jobs | -| `projects_locations_schedules_trigger` | `EXEC` | `locationsId, projectsId, schedulesId` | Triggers execution of an existing schedule. | diff --git a/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md b/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md index 21a8e0715a..98430e94c9 100644 --- a/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md +++ b/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]`. | -| `remediation` | `string` | A description of actions that can be taken to remedy the note. | -| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | -| `deployment` | `object` | The period during which some deployable was active in a runtime. | -| `attestation` | `object` | Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. | -| `createTime` | `string` | Output only. The time this occurrence was created. | -| `upgrade` | `object` | An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. | -| `package` | `object` | Details on how a particular software package was installed on a system. | +| `build` | `object` | Details of a build occurrence. | | `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | +| `sbomReference` | `object` | The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. | +| `package` | `object` | Details on how a particular software package was installed on a system. | | `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | -| `updateTime` | `string` | Output only. The time this occurrence was last updated. | +| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | | `resourceUri` | `string` | Required. Immutable. A URI that represents the resource for which the occurrence applies. For example, `https://gcr.io/project/image@sha256:123abc` for a Docker image. | -| `noteName` | `string` | Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. | -| `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | -| `build` | `object` | Details of a build occurrence. | +| `updateTime` | `string` | Output only. The time this occurrence was last updated. | +| `remediation` | `string` | A description of actions that can be taken to remedy the note. | +| `deployment` | `object` | The period during which some deployable was active in a runtime. | | `kind` | `string` | Output only. This explicitly denotes which of the occurrence details are specified. This field can be used as a filter in list requests. | -| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | -| `sbomReference` | `object` | The occurrence representing an SBOM reference as applied to a specific resource. The occurrence follows the DSSE specification. See https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more details. | +| `upgrade` | `object` | An Upgrade Occurrence represents that a specific resource_url could install a specific upgrade. This presence is supplied via local sources (i.e. it is present in the mirror and the running system has noticed its availability). For Windows, both distribution and windows_update contain information for the Windows update. | +| `attestation` | `object` | Occurrence that represents a single "attestation". The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign. | +| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | +| `noteName` | `string` | Required. Immutable. The analysis note associated with this occurrence, in the form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a filter in list requests. | +| `createTime` | `string` | Output only. The time this occurrence was created. | | `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | +| `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md b/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md index a836965436..85b59ff635 100644 --- a/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md +++ b/docs/google-docs/providers/google/orgpolicy/custom_constraints/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. Name of the constraint. This is unique within the organization. Format of the name should be * `organizations/{organization_id}/customConstraints/{custom_constraint_id}` Example: `organizations/123/customConstraints/custom.createOnlyE2TypeVms` The max length is 70 characters and the minimum length is 1. Note that the prefix `organizations/{organization_id}/customConstraints/` is not counted. | | `description` | `string` | Detailed information about this custom policy constraint. The max length of the description is 2000 characters. | +| `methodTypes` | `array` | All the operations being applied for this constraint. | +| `resourceTypes` | `array` | Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. | | `updateTime` | `string` | Output only. The last time this custom constraint was updated. This represents the last time that the `CreateCustomConstraint` or `UpdateCustomConstraint` RPC was called | | `actionType` | `string` | Allow or deny type. | | `condition` | `string` | Org policy condition/expression. For example: `resource.instanceName.matches("[production\|test]_.*_(\d)+")` or, `resource.management.auto_upgrade == true` The max length of the condition is 1000 characters. | | `displayName` | `string` | One line display name for the UI. The max length of the display_name is 200 characters. | -| `methodTypes` | `array` | All the operations being applied for this constraint. | -| `resourceTypes` | `array` | Immutable. The resource instance type on which this policy applies. Format will be of the form : `/` Example: * `compute.googleapis.com/Instance`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/orgpolicy/policies/index.md b/docs/google-docs/providers/google/orgpolicy/policies/index.md index 38d52084fd..3966fecaa2 100644 --- a/docs/google-docs/providers/google/orgpolicy/policies/index.md +++ b/docs/google-docs/providers/google/orgpolicy/policies/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the policy. Must be one of the following forms, where `constraint_name` is the name of the constraint which this policy configures: * `projects/{project_number}/policies/{constraint_name}` * `folders/{folder_id}/policies/{constraint_name}` * `organizations/{organization_id}/policies/{constraint_name}` For example, `projects/123/policies/compute.disableSerialPortAccess`. Note: `projects/{project_id}/policies/{constraint_name}` is also an acceptable name for API requests, but responses will return the name using the equivalent project number. | -| `alternate` | `object` | Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch. | | `dryRunSpec` | `object` | Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. | | `spec` | `object` | Defines a Google Cloud policy specification which is used to specify constraints for configurations of Google Cloud resources. | +| `alternate` | `object` | Similar to PolicySpec but with an extra 'launch' field for launch reference. The PolicySpec here is specific for dry-run/darklaunch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/osconfig/instance_inventories/index.md b/docs/google-docs/providers/google/osconfig/instance_inventories/index.md deleted file mode 100644 index e69ee2cb49..0000000000 --- a/docs/google-docs/providers/google/osconfig/instance_inventories/index.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: instance_inventories -hide_title: false -hide_table_of_contents: false -keywords: - - instance_inventories - - osconfig - - 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 ---- - - - -## Overview - - - - -
Nameinstance_inventories
TypeResource
Idgoogle.osconfig.instance_inventories
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. The `Inventory` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/inventory` | -| `osInfo` | `object` | Operating system information for the VM. | -| `updateTime` | `string` | Output only. Timestamp of the last reported inventory for the VM. | -| `items` | `object` | Inventory items related to the VM keyed by an opaque unique identifier for each inventory item. The identifier is unique to each distinct and addressable inventory item and will change, when there is a new package version. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_instances_inventories_list` | `SELECT` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md b/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md index 570882224b..5dbb0f0446 100644 --- a/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md +++ b/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. | | `description` | `string` | OS policy assignment description. Length of the description is limited to 1024 characters. | -| `rolloutState` | `string` | Output only. OS policy assignment rollout state | -| `osPolicies` | `array` | Required. List of OS policies to be applied to the VMs. | +| `instanceFilter` | `object` | Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. | +| `revisionId` | `string` | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment | | `reconciling` | `boolean` | Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING | | `etag` | `string` | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. | -| `instanceFilter` | `object` | Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. | +| `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | +| `baseline` | `boolean` | Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. | | `rollout` | `object` | Message to configure the rollout at the zonal level for the OS policy assignment. | -| `revisionId` | `string` | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment | | `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | -| `baseline` | `boolean` | Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. | -| `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | | `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `osPolicies` | `array` | Required. List of OS policies to be applied to the VMs. | +| `rolloutState` | `string` | Output only. OS policy assignment rollout state | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md b/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md index 2e48d350c6..02c5e9bb83 100644 --- a/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md +++ b/docs/google-docs/providers/google/osconfig/os_policy_assignments_revisions/index.md @@ -30,16 +30,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Resource name. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id}` This field is ignored when you create an OS policy assignment. | | `description` | `string` | OS policy assignment description. Length of the description is limited to 1024 characters. | | `baseline` | `boolean` | Output only. Indicates that this revision has been successfully rolled out in this zone and new VMs will be assigned OS policies from this revision. For a given OS policy assignment, there is only one revision with a value of `true` for this field. | -| `revisionId` | `string` | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment | | `rollout` | `object` | Message to configure the rollout at the zonal level for the OS policy assignment. | -| `osPolicies` | `array` | Required. List of OS policies to be applied to the VMs. | +| `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | +| `rolloutState` | `string` | Output only. OS policy assignment rollout state | | `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | | `instanceFilter` | `object` | Filters to select target VMs for an assignment. If more than one filter criteria is specified below, a VM will be selected if and only if it satisfies all of them. | -| `rolloutState` | `string` | Output only. OS policy assignment rollout state | -| `etag` | `string` | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. | -| `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | +| `osPolicies` | `array` | Required. List of OS policies to be applied to the VMs. | | `reconciling` | `boolean` | Output only. Indicates that reconciliation is in progress for the revision. This value is `true` when the `rollout_state` is one of: * IN_PROGRESS * CANCELLING | | `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `etag` | `string` | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. | +| `revisionId` | `string` | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a OS policy assignment | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/osconfig/patch_deployments/index.md b/docs/google-docs/providers/google/osconfig/patch_deployments/index.md index 4977d574b8..c427f76a70 100644 --- a/docs/google-docs/providers/google/osconfig/patch_deployments/index.md +++ b/docs/google-docs/providers/google/osconfig/patch_deployments/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Unique name for the patch deployment resource in a project. The patch deployment name is in the form: `projects/{project_id}/patchDeployments/{patch_deployment_id}`. This field is ignored when you create a new patch deployment. | | `description` | `string` | Optional. Description of the patch deployment. Length of the description is limited to 1024 characters. | | `duration` | `string` | Optional. Duration of the patch. After the duration ends, the patch times out. | -| `instanceFilter` | `object` | A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. | -| `state` | `string` | Output only. Current state of the patch deployment. | -| `lastExecuteTime` | `string` | Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | -| `oneTimeSchedule` | `object` | Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | -| `recurringSchedule` | `object` | Sets the time for recurring patch deployments. | | `updateTime` | `string` | Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `createTime` | `string` | Output only. Time the patch deployment was created. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `lastExecuteTime` | `string` | Output only. The last time a patch job was started by this deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `instanceFilter` | `object` | A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. | | `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | | `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | +| `oneTimeSchedule` | `object` | Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `recurringSchedule` | `object` | Sets the time for recurring patch deployments. | +| `state` | `string` | Output only. Current state of the patch deployment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/osconfig/patch_jobs/index.md b/docs/google-docs/providers/google/osconfig/patch_jobs/index.md index 1b3d46d820..916ca828a0 100644 --- a/docs/google-docs/providers/google/osconfig/patch_jobs/index.md +++ b/docs/google-docs/providers/google/osconfig/patch_jobs/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Unique identifier for this patch job in the form `projects/*/patchJobs/*` | | `description` | `string` | Description of the patch job. Length of the description is limited to 1024 characters. | -| `patchDeployment` | `string` | Output only. Name of the patch deployment that created this patch job. | -| `createTime` | `string` | Time this patch job was created. | -| `percentComplete` | `number` | Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. | +| `state` | `string` | The current state of the PatchJob. | +| `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | +| `instanceDetailsSummary` | `object` | A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. | +| `instanceFilter` | `object` | A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. | | `displayName` | `string` | Display name for this patch job. This is not a unique identifier. | | `dryRun` | `boolean` | If this patch job is a dry run, the agent reports that it has finished without running any updates on the VM instance. | | `duration` | `string` | Duration of the patch job. After the duration ends, the patch job times out. | -| `updateTime` | `string` | Last time this patch job was updated. | -| `instanceFilter` | `object` | A filter to target VM instances for patching. The targeted VMs must meet all criteria specified. So if both labels and zones are specified, the patch job targets only VMs with those labels and in those zones. | | `errorMessage` | `string` | If this patch job failed, this message provides information about the failure. | -| `instanceDetailsSummary` | `object` | A summary of the current patch state across all instances that this patch job affects. Contains counts of instances in different states. These states map to `InstancePatchState`. List patch job instance details to see the specific states of each instance. | -| `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | -| `state` | `string` | The current state of the PatchJob. | +| `percentComplete` | `number` | Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. | +| `createTime` | `string` | Time this patch job was created. | | `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | +| `updateTime` | `string` | Last time this patch job was updated. | +| `patchDeployment` | `string` | Output only. Name of the patch deployment that created this patch job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/osconfig/report/index.md b/docs/google-docs/providers/google/osconfig/report/index.md index 07f2997dbe..cb3a9d88d4 100644 --- a/docs/google-docs/providers/google/osconfig/report/index.md +++ b/docs/google-docs/providers/google/osconfig/report/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The `OSPolicyAssignmentReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report` | +| `osPolicyAssignment` | `string` | Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` | | `osPolicyCompliances` | `array` | Compliance data for each `OSPolicy` that is applied to the VM. | | `updateTime` | `string` | Timestamp for when the report was last generated. | | `instance` | `string` | The Compute Engine VM instance name. | | `lastRunId` | `string` | Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent logs. | -| `osPolicyAssignment` | `string` | Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/osconfig/vulnerability_report/index.md b/docs/google-docs/providers/google/osconfig/vulnerability_report/index.md index cb88a7ccab..689348d233 100644 --- a/docs/google-docs/providers/google/osconfig/vulnerability_report/index.md +++ b/docs/google-docs/providers/google/osconfig/vulnerability_report/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The `vulnerabilityReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/vulnerabilityReport` | -| `updateTime` | `string` | Output only. The timestamp for when the last vulnerability report was generated for the VM. | | `vulnerabilities` | `array` | Output only. List of vulnerabilities affecting the VM. | +| `updateTime` | `string` | Output only. The timestamp for when the last vulnerability report was generated for the VM. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md b/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md index dcb944f51b..6799262ba5 100644 --- a/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md +++ b/docs/google-docs/providers/google/oslogin/ssh_public_keys/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The canonical resource name. | -| `key` | `string` | Public key text in SSH format, defined by RFC4253 section 6.6. | | `expirationTimeUsec` | `string` | An expiration time in microseconds since epoch. | | `fingerprint` | `string` | Output only. The SHA-256 fingerprint of the SSH public key. | +| `key` | `string` | Public key text in SSH format, defined by RFC4253 section 6.6. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/policysimulator/operations/index.md b/docs/google-docs/providers/google/policysimulator/operations/index.md index d2b874e977..e2ca7fab14 100644 --- a/docs/google-docs/providers/google/policysimulator/operations/index.md +++ b/docs/google-docs/providers/google/policysimulator/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/policysimulator/replays/index.md b/docs/google-docs/providers/google/policysimulator/replays/index.md index 740323be76..b036fc773e 100644 --- a/docs/google-docs/providers/google/policysimulator/replays/index.md +++ b/docs/google-docs/providers/google/policysimulator/replays/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the `Replay`, which has the following format: `{projects\|folders\|organizations}/{resource-id}/locations/global/replays/{replay-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36` | -| `config` | `object` | The configuration used for a Replay. | | `resultsSummary` | `object` | Summary statistics about the replayed log entries. | | `state` | `string` | Output only. The current state of the `Replay`. | +| `config` | `object` | The configuration used for a Replay. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/policysimulator/results/index.md b/docs/google-docs/providers/google/policysimulator/results/index.md index 6ef64e461f..05038aa7d6 100644 --- a/docs/google-docs/providers/google/policysimulator/results/index.md +++ b/docs/google-docs/providers/google/policysimulator/results/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the `ReplayResult`, in the following format: `{projects\|folders\|organizations}/{resource-id}/locations/global/replays/{replay-id}/results/{replay-result-id}`, where `{resource-id}` is the ID of the project, folder, or organization that owns the Replay. Example: `projects/my-example-project/locations/global/replays/506a5f7f-38ce-4d7d-8e03-479ce1833c36/results/1234` | +| `lastSeenDate` | `object` | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp | | `parent` | `string` | The Replay that the access tuple was included in. | | `accessTuple` | `object` | Information about the principal, resource, and permission to check. | | `diff` | `object` | The difference between the results of evaluating an access tuple under the current (baseline) policies and under the proposed (simulated) policies. This difference explains how a principal's access could change if the proposed policies were applied. | | `error` | `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). | -| `lastSeenDate` | `object` | Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/privateca/ca_pools_iam_audit_configs/index.md b/docs/google-docs/providers/google/privateca/ca_pools_iam_audit_configs/index.md deleted file mode 100644 index 9ce47dc216..0000000000 --- a/docs/google-docs/providers/google/privateca/ca_pools_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: ca_pools_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - ca_pools_iam_audit_configs - - privateca - - 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 ---- - - - -## Overview - - - - -
Nameca_pools_iam_audit_configs
TypeResource
Idgoogle.privateca.ca_pools_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_caPools_getIamPolicy` | `SELECT` | `caPoolsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/privateca/ca_pools_iam_bindings/index.md b/docs/google-docs/providers/google/privateca/ca_pools_iam_bindings/index.md deleted file mode 100644 index 7099d20087..0000000000 --- a/docs/google-docs/providers/google/privateca/ca_pools_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: ca_pools_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - ca_pools_iam_bindings - - privateca - - 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 ---- - - - -## Overview - - - - -
Nameca_pools_iam_bindings
TypeResource
Idgoogle.privateca.ca_pools_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_caPools_getIamPolicy` | `SELECT` | `caPoolsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md b/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md index ba5ed4595b..b0be676ea9 100644 --- a/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md +++ b/docs/google-docs/providers/google/privateca/ca_pools_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificate_authorities/index.md b/docs/google-docs/providers/google/privateca/certificate_authorities/index.md index d01c0a7528..97ccee44de 100644 --- a/docs/google-docs/providers/google/privateca/certificate_authorities/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_authorities/index.md @@ -28,22 +28,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. | -| `keySpec` | `object` | A Cloud KMS key configuration that a CertificateAuthority will use. | -| `gcsBucket` | `string` | Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. | -| `tier` | `string` | Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. | | `state` | `string` | Output only. The State for this CertificateAuthority. | -| `caCertificateDescriptions` | `array` | Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. | +| `accessUrls` | `object` | URLs where a CertificateAuthority will publish content. | +| `tier` | `string` | Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. | | `deleteTime` | `string` | Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. | -| `type` | `string` | Required. Immutable. The Type of this CertificateAuthority. | +| `keySpec` | `object` | A Cloud KMS key configuration that a CertificateAuthority will use. | | `expireTime` | `string` | Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. | -| `accessUrls` | `object` | URLs where a CertificateAuthority will publish content. | -| `lifetime` | `string` | Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. | | `labels` | `object` | Optional. Labels with user-defined metadata. | -| `pemCaCertificates` | `array` | Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate. | -| `subordinateConfig` | `object` | Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. | | `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | -| `updateTime` | `string` | Output only. The time at which this CertificateAuthority was last updated. | +| `subordinateConfig` | `object` | Describes a subordinate CA's issuers. This is either a resource name to a known issuing CertificateAuthority, or a PEM issuer certificate chain. | +| `lifetime` | `string` | Required. Immutable. The desired lifetime of the CA certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. | +| `type` | `string` | Required. Immutable. The Type of this CertificateAuthority. | | `createTime` | `string` | Output only. The time at which this CertificateAuthority was created. | +| `updateTime` | `string` | Output only. The time at which this CertificateAuthority was last updated. | +| `caCertificateDescriptions` | `array` | Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. | +| `pemCaCertificates` | `array` | Output only. This CertificateAuthority's certificate chain, including the current CertificateAuthority's certificate. Ordered such that the root issuer is the final element (consistent with RFC 5246). For a self-signed CA, this will only list the current CertificateAuthority's certificate. | +| `gcsBucket` | `string` | Immutable. The name of a Cloud Storage bucket where this CertificateAuthority will publish content, such as the CA certificate and CRLs. This must be a bucket name, without any prefixes (such as `gs://`) or suffixes (such as `.googleapis.com`). For example, to use a bucket named `my-bucket`, you would simply specify `my-bucket`. If not specified, a managed bucket will be created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md b/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md index 5145d32206..e1d0ac28b1 100644 --- a/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_revocation_lists/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this CertificateRevocationList in the format `projects/*/locations/*/caPools/*certificateAuthorities/*/ certificateRevocationLists/*`. | -| `updateTime` | `string` | Output only. The time at which this CertificateRevocationList was updated. | -| `revisionId` | `string` | Output only. The revision ID of this CertificateRevocationList. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string. | -| `state` | `string` | Output only. The State for this CertificateRevocationList. | -| `accessUrl` | `string` | Output only. The location where 'pem_crl' can be accessed. | | `createTime` | `string` | Output only. The time at which this CertificateRevocationList was created. | +| `updateTime` | `string` | Output only. The time at which this CertificateRevocationList was updated. | | `labels` | `object` | Optional. Labels with user-defined metadata. | | `pemCrl` | `string` | Output only. The PEM-encoded X.509 CRL. | -| `revokedCertificates` | `array` | Output only. The revoked serial numbers that appear in pem_crl. | +| `state` | `string` | Output only. The State for this CertificateRevocationList. | | `sequenceNumber` | `string` | Output only. The CRL sequence number that appears in pem_crl. | +| `accessUrl` | `string` | Output only. The location where 'pem_crl' can be accessed. | +| `revisionId` | `string` | Output only. The revision ID of this CertificateRevocationList. A new revision is committed whenever a new CRL is published. The format is an 8-character hexadecimal string. | +| `revokedCertificates` | `array` | Output only. The revoked serial numbers that appear in pem_crl. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_audit_configs/index.md b/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_audit_configs/index.md deleted file mode 100644 index 5df5432978..0000000000 --- a/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: certificate_revocation_lists_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - certificate_revocation_lists_iam_audit_configs - - privateca - - 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 ---- - - - -## Overview - - - - -
Namecertificate_revocation_lists_iam_audit_configs
TypeResource
Idgoogle.privateca.certificate_revocation_lists_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_caPools_certificateAuthorities_certificateRevocationLists_getIamPolicy` | `SELECT` | `caPoolsId, certificateAuthoritiesId, certificateRevocationListsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_bindings/index.md b/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_bindings/index.md deleted file mode 100644 index 1896e56a01..0000000000 --- a/docs/google-docs/providers/google/privateca/certificate_revocation_lists_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: certificate_revocation_lists_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - certificate_revocation_lists_iam_bindings - - privateca - - 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 ---- - - - -## Overview - - - - -
Namecertificate_revocation_lists_iam_bindings
TypeResource
Idgoogle.privateca.certificate_revocation_lists_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_caPools_certificateAuthorities_certificateRevocationLists_getIamPolicy` | `SELECT` | `caPoolsId, certificateAuthoritiesId, certificateRevocationListsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/privateca/certificate_signing_request/index.md b/docs/google-docs/providers/google/privateca/certificate_signing_request/index.md deleted file mode 100644 index 1db3dbc98b..0000000000 --- a/docs/google-docs/providers/google/privateca/certificate_signing_request/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: certificate_signing_request -hide_title: false -hide_table_of_contents: false -keywords: - - certificate_signing_request - - privateca - - 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 ---- - - - -## Overview - - - - -
Namecertificate_signing_request
TypeResource
Idgoogle.privateca.certificate_signing_request
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_caPools_certificateAuthorities_fetch` | `SELECT` | `caPoolsId, certificateAuthoritiesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/privateca/certificate_templates/index.md b/docs/google-docs/providers/google/privateca/certificate_templates/index.md index 3387a70f63..4f7f340bb9 100644 --- a/docs/google-docs/providers/google/privateca/certificate_templates/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_templates/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this CertificateTemplate in the format `projects/*/locations/*/certificateTemplates/*`. | | `description` | `string` | Optional. A human-readable description of scenarios this template is intended for. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | +| `passthroughExtensions` | `object` | Describes a set of X.509 extensions that may be part of some certificate issuance controls. | | `predefinedValues` | `object` | An X509Parameters is used to describe certain fields of an X.509 certificate, such as the key usage fields, fields specific to CA certificates, certificate policy extensions and custom extensions. | | `updateTime` | `string` | Output only. The time at which this CertificateTemplate was updated. | | `createTime` | `string` | Output only. The time at which this CertificateTemplate was created. | | `identityConstraints` | `object` | Describes constraints on a Certificate's Subject and SubjectAltNames. | -| `labels` | `object` | Optional. Labels with user-defined metadata. | -| `passthroughExtensions` | `object` | Describes a set of X.509 extensions that may be part of some certificate issuance controls. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificate_templates_iam_audit_configs/index.md b/docs/google-docs/providers/google/privateca/certificate_templates_iam_audit_configs/index.md deleted file mode 100644 index 3dd853ed76..0000000000 --- a/docs/google-docs/providers/google/privateca/certificate_templates_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: certificate_templates_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - certificate_templates_iam_audit_configs - - privateca - - 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 ---- - - - -## Overview - - - - -
Namecertificate_templates_iam_audit_configs
TypeResource
Idgoogle.privateca.certificate_templates_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_certificateTemplates_getIamPolicy` | `SELECT` | `certificateTemplatesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/privateca/certificate_templates_iam_bindings/index.md b/docs/google-docs/providers/google/privateca/certificate_templates_iam_bindings/index.md deleted file mode 100644 index e45344da11..0000000000 --- a/docs/google-docs/providers/google/privateca/certificate_templates_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: certificate_templates_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - certificate_templates_iam_bindings - - privateca - - 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 ---- - - - -## Overview - - - - -
Namecertificate_templates_iam_bindings
TypeResource
Idgoogle.privateca.certificate_templates_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_certificateTemplates_getIamPolicy` | `SELECT` | `certificateTemplatesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md b/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md index 8532a13de2..437f47077a 100644 --- a/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/privateca/certificate_templates_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/certificates/index.md b/docs/google-docs/providers/google/privateca/certificates/index.md index dc7f193272..5f0f535c96 100644 --- a/docs/google-docs/providers/google/privateca/certificates/index.md +++ b/docs/google-docs/providers/google/privateca/certificates/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for this Certificate in the format `projects/*/locations/*/caPools/*/certificates/*`. | -| `pemCsr` | `string` | Immutable. A pem-encoded X.509 certificate signing request (CSR). | -| `certificateTemplate` | `string` | Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. | -| `issuerCertificateAuthority` | `string` | Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. | +| `lifetime` | `string` | Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. | | `revocationDetails` | `object` | Describes fields that are relavent to the revocation of a Certificate. | -| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `certificateTemplate` | `string` | Immutable. The resource name for a CertificateTemplate used to issue this certificate, in the format `projects/*/locations/*/certificateTemplates/*`. If this is specified, the caller must have the necessary permission to use this template. If this is omitted, no template will be used. This template must be in the same location as the Certificate. | +| `pemCertificateChain` | `array` | Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. | +| `pemCsr` | `string` | Immutable. A pem-encoded X.509 certificate signing request (CSR). | | `createTime` | `string` | Output only. The time at which this Certificate was created. | +| `issuerCertificateAuthority` | `string` | Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. | | `subjectMode` | `string` | Immutable. Specifies how the Certificate's identity fields are to be decided. If this is omitted, the `DEFAULT` subject mode will be used. | -| `pemCertificate` | `string` | Output only. The pem-encoded, signed X.509 certificate. | | `certificateDescription` | `object` | A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. | +| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `pemCertificate` | `string` | Output only. The pem-encoded, signed X.509 certificate. | | `updateTime` | `string` | Output only. The time at which this Certificate was updated. | -| `pemCertificateChain` | `array` | Output only. The chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. | -| `lifetime` | `string` | Required. Immutable. The desired lifetime of a certificate. Used to create the "not_before_time" and "not_after_time" fields inside an X.509 certificate. Note that the lifetime may be truncated if it would extend past the life of any certificate authority in the issuing chain. | | `labels` | `object` | Optional. Labels with user-defined metadata. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/privateca/locations/index.md b/docs/google-docs/providers/google/privateca/locations/index.md index b4d4d31743..e60898f171 100644 --- a/docs/google-docs/providers/google/privateca/locations/index.md +++ b/docs/google-docs/providers/google/privateca/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | -| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/operations/index.md b/docs/google-docs/providers/google/privateca/operations/index.md index 9085ab05d4..ad8ef75123 100644 --- a/docs/google-docs/providers/google/privateca/operations/index.md +++ b/docs/google-docs/providers/google/privateca/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md index 8eb955bb37..60ce889eca 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/customers/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the customer. | -| `sasUserIds` | `array` | User IDs used by the devices belonging to this customer. | | `displayName` | `string` | Required. Name of the organization that the customer entity represents. | +| `sasUserIds` | `array` | User IDs used by the devices belonging to this customer. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md index fce012b842..56122c2f3d 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/deployments/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | -| `frns` | `array` | Output only. The FCC Registration Numbers (FRNs) copied from its direct parent. | | `sasUserIds` | `array` | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. | | `displayName` | `string` | The deployment's display name. | +| `frns` | `array` | Output only. The FCC Registration Numbers (FRNs) copied from its direct parent. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md index f3bd03746f..90e1bcdca4 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/devices/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource path name. | -| `fccId` | `string` | The FCC identifier of the device. | -| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | -| `displayName` | `string` | Device display name. | | `grants` | `array` | Output only. Grants held by the device. | -| `state` | `string` | Output only. Device state. | -| `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | -| `activeConfig` | `object` | Information about the device configuration. | | `currentChannels` | `array` | Output only. Current channels with scores. | -| `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | | `preloadedConfig` | `object` | Information about the device configuration. | +| `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | +| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | +| `state` | `string` | Output only. Device state. | +| `displayName` | `string` | Device display name. | +| `activeConfig` | `object` | Information about the device configuration. | +| `fccId` | `string` | The FCC identifier of the device. | +| `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/node/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/node/index.md index eb87aefbc7..040da1850d 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/node/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/node/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | -| `displayName` | `string` | The node's display name. | | `sasUserIds` | `array` | User ids used by the devices belonging to this node. | +| `displayName` | `string` | The node's display name. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md index e267c92d95..7594a4d15b 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/nodes/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | -| `displayName` | `string` | The node's display name. | | `sasUserIds` | `array` | User ids used by the devices belonging to this node. | +| `displayName` | `string` | The node's display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/schemas/index.md b/docs/google-docs/providers/google/pubsub/schemas/index.md index 750616694b..c260022559 100644 --- a/docs/google-docs/providers/google/pubsub/schemas/index.md +++ b/docs/google-docs/providers/google/pubsub/schemas/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. | -| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | | `revisionId` | `string` | Output only. Immutable. The revision ID of the schema. | | `type` | `string` | The type of the schema definition. | | `definition` | `string` | The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/schemas_iam_bindings/index.md b/docs/google-docs/providers/google/pubsub/schemas_iam_bindings/index.md deleted file mode 100644 index a6a35cf1a4..0000000000 --- a/docs/google-docs/providers/google/pubsub/schemas_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: schemas_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - schemas_iam_bindings - - pubsub - - 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 ---- - - - -## Overview - - - - -
Nameschemas_iam_bindings
TypeResource
Idgoogle.pubsub.schemas_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_schemas_getIamPolicy` | `SELECT` | `projectsId, schemasId` | diff --git a/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md b/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md index 03c843951d..327270754c 100644 --- a/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md +++ b/docs/google-docs/providers/google/pubsub/schemas_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md b/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md index 6c2f5850fa..ec0e461793 100644 --- a/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md +++ b/docs/google-docs/providers/google/pubsub/schemas_revisions/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Name of the schema. Format is `projects/{project}/schemas/{schema}`. | -| `definition` | `string` | The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. | | `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | | `revisionId` | `string` | Output only. Immutable. The revision ID of the schema. | | `type` | `string` | The type of the schema definition. | +| `definition` | `string` | The definition of the schema. This should contain a string representing the full definition of the schema that is a valid schema definition of the type specified in `type`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/pubsub/snapshots/index.md b/docs/google-docs/providers/google/pubsub/snapshots/index.md index 3fce13e244..9b5081a74d 100644 --- a/docs/google-docs/providers/google/pubsub/snapshots/index.md +++ b/docs/google-docs/providers/google/pubsub/snapshots/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Optional. The name of the snapshot. | +| `expireTime` | `string` | Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation. | | `labels` | `object` | Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels). | | `topic` | `string` | Optional. The name of the topic from which this snapshot is retaining messages. | -| `expireTime` | `string` | Optional. The snapshot is guaranteed to exist up until this time. A newly-created snapshot expires no later than 7 days from the time of its creation. Its exact lifetime is determined at creation by the existing backlog in the source subscription. Specifically, the lifetime of the snapshot is `7 days - (age of oldest unacked message in the subscription)`. For example, consider a subscription whose oldest unacked message is 3 days old. If a snapshot is created from this subscription, the snapshot -- which will always capture this 3-day-old backlog as long as the snapshot exists -- will expire in 4 days. The service will refuse to create a snapshot that would expire in less than 1 hour after creation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/snapshots_iam_bindings/index.md b/docs/google-docs/providers/google/pubsub/snapshots_iam_bindings/index.md deleted file mode 100644 index 18dc6e7e45..0000000000 --- a/docs/google-docs/providers/google/pubsub/snapshots_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: snapshots_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - snapshots_iam_bindings - - pubsub - - 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 ---- - - - -## Overview - - - - -
Namesnapshots_iam_bindings
TypeResource
Idgoogle.pubsub.snapshots_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_snapshots_getIamPolicy` | `SELECT` | `projectsId, snapshotsId` | diff --git a/docs/google-docs/providers/google/pubsub/snapshots_iam_policies/index.md b/docs/google-docs/providers/google/pubsub/snapshots_iam_policies/index.md index 6c67200cc5..421be5511d 100644 --- a/docs/google-docs/providers/google/pubsub/snapshots_iam_policies/index.md +++ b/docs/google-docs/providers/google/pubsub/snapshots_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/subscriptions_iam_bindings/index.md b/docs/google-docs/providers/google/pubsub/subscriptions_iam_bindings/index.md deleted file mode 100644 index e2ab175a05..0000000000 --- a/docs/google-docs/providers/google/pubsub/subscriptions_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: subscriptions_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - subscriptions_iam_bindings - - pubsub - - 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 ---- - - - -## Overview - - - - -
Namesubscriptions_iam_bindings
TypeResource
Idgoogle.pubsub.subscriptions_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_subscriptions_getIamPolicy` | `SELECT` | `projectsId, subscriptionsId` | diff --git a/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md b/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md index 4dee8a46a6..22d41e9633 100644 --- a/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md +++ b/docs/google-docs/providers/google/pubsub/subscriptions_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/topics/index.md b/docs/google-docs/providers/google/pubsub/topics/index.md index 9cf71e52ce..cd0242f5bf 100644 --- a/docs/google-docs/providers/google/pubsub/topics/index.md +++ b/docs/google-docs/providers/google/pubsub/topics/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The name of the topic. It must have the format `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter, and contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters in length, and it must not start with `"goog"`. | -| `messageRetentionDuration` | `string` | Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. | -| `messageStoragePolicy` | `object` | A policy constraining the storage of messages published to the topic. | | `satisfiesPzs` | `boolean` | Optional. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. | | `schemaSettings` | `object` | Settings for validating messages published against a schema. | | `kmsKeyName` | `string` | Optional. The resource name of the Cloud KMS CryptoKey to be used to protect access to messages published on this topic. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. | | `labels` | `object` | Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels). | +| `messageRetentionDuration` | `string` | Optional. Indicates the minimum duration to retain a message after it is published to the topic. If this field is set, messages published to the topic in the last `message_retention_duration` are always available to subscribers. For instance, it allows any attached subscription to [seek to a timestamp](https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) that is up to `message_retention_duration` in the past. If this field is not set, message retention is controlled by settings on individual subscriptions. Cannot be more than 31 days or less than 10 minutes. | +| `messageStoragePolicy` | `object` | A policy constraining the storage of messages published to the topic. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/topics_iam_bindings/index.md b/docs/google-docs/providers/google/pubsub/topics_iam_bindings/index.md deleted file mode 100644 index a27ed9ab99..0000000000 --- a/docs/google-docs/providers/google/pubsub/topics_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: topics_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - topics_iam_bindings - - pubsub - - 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 ---- - - - -## Overview - - - - -
Nametopics_iam_bindings
TypeResource
Idgoogle.pubsub.topics_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_topics_getIamPolicy` | `SELECT` | `projectsId, topicsId` | diff --git a/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md b/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md index ee508a8a7b..5b52bf2eec 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name for the Key in the format "projects/{project}/keys/{key}". | -| `iosSettings` | `object` | Settings specific to keys that can be used by iOS apps. | -| `createTime` | `string` | Output only. The timestamp corresponding to the creation of this key. | -| `wafSettings` | `object` | Settings specific to keys that can be used for WAF (Web Application Firewall). | -| `androidSettings` | `object` | Settings specific to keys that can be used by Android apps. | +| `testingOptions` | `object` | Options for user acceptance testing. | | `labels` | `object` | See Creating and managing labels. | | `displayName` | `string` | Human-readable display name of this key. Modifiable by user. | -| `testingOptions` | `object` | Options for user acceptance testing. | | `webSettings` | `object` | Settings specific to keys that can be used by websites. | +| `androidSettings` | `object` | Settings specific to keys that can be used by Android apps. | +| `iosSettings` | `object` | Settings specific to keys that can be used by iOS apps. | +| `createTime` | `string` | Output only. The timestamp corresponding to the creation of this key. | +| `wafSettings` | `object` | Settings specific to keys that can be used for WAF (Web Application Firewall). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md b/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md index 50247d51e3..0ea7f6ead5 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/keys_metrics/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the metrics, in the format "projects/{project}/keys/{key}/metrics". | -| `scoreMetrics` | `array` | Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data. | | `startTime` | `string` | Inclusive start time aligned to a day (UTC). | | `challengeMetrics` | `array` | Metrics will be continuous and in order by dates, and in the granularity of day. Only challenge-based keys (CHECKBOX, INVISIBLE), will have challenge-based data. | +| `scoreMetrics` | `array` | Metrics will be continuous and in order by dates, and in the granularity of day. All Key types should have score-based data. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md b/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md index 570fc299af..0133fd8a5d 100644 --- a/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md +++ b/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Required. Catalog item identifier. UTF-8 encoded string with a length limit of 128 bytes. This id must be unique among all catalog items within the same catalog. It should also be used when logging user events in order for the user events to be joined with the Catalog. | | `description` | `string` | Optional. Catalog item description. UTF-8 encoded string with a length limit of 5 KiB. | +| `languageCode` | `string` | Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. | | `categoryHierarchies` | `array` | Required. Catalog item categories. This field is repeated for supporting one catalog item belonging to several parallel category hierarchies. For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categoryHierarchies": [ { "categories": ["Shoes & Accessories", "Shoes"]}, { "categories": ["Sports & Fitness", "Athletic Clothing", "Shoes"] } ] | | `itemAttributes` | `object` | FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features. | -| `languageCode` | `string` | Optional. Deprecated. The model automatically detects the text language. Your catalog can include text in different languages, but duplicating catalog items to provide text in multiple languages can result in degraded model performance. | -| `itemGroupId` | `string` | Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). | | `title` | `string` | Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. | +| `itemGroupId` | `string` | Optional. Variant group identifier for prediction results. UTF-8 encoded string with a length limit of 128 bytes. This field must be enabled before it can be used. [Learn more](/recommendations-ai/docs/catalog#item-group-id). | | `productMetadata` | `object` | ProductCatalogItem captures item metadata specific to retail products. | | `tags` | `array` | Optional. Filtering tags associated with the catalog item. Each tag should be a UTF-8 encoded string with a length limit of 1 KiB. This tag can be used for filtering recommendation results by passing the tag as part of the predict request filter. | ## Methods diff --git a/docs/google-docs/providers/google/recommendationengine/operations/index.md b/docs/google-docs/providers/google/recommendationengine/operations/index.md index 3073f6fa79..d07dbd4fcd 100644 --- a/docs/google-docs/providers/google/recommendationengine/operations/index.md +++ b/docs/google-docs/providers/google/recommendationengine/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommendationengine/user_events/index.md b/docs/google-docs/providers/google/recommendationengine/user_events/index.md index 1a98a04ea0..0225bb12e0 100644 --- a/docs/google-docs/providers/google/recommendationengine/user_events/index.md +++ b/docs/google-docs/providers/google/recommendationengine/user_events/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `eventType` | `string` | Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager. | +| `productEventDetail` | `object` | ProductEventDetail captures user event information specific to retail products. | | `userInfo` | `object` | Information of end users. | | `eventDetail` | `object` | User event details shared by all recommendation types. | | `eventSource` | `string` | Optional. This field should *not* be set when using JavaScript pixel or the Recommendations AI Tag. Defaults to `EVENT_SOURCE_UNSPECIFIED`. | | `eventTime` | `string` | Optional. Only required for ImportUserEvents method. Timestamp of user event created. | -| `eventType` | `string` | Required. User event type. Allowed values are: * `add-to-cart` Products being added to cart. * `add-to-list` Items being added to a list (shopping list, favorites etc). * `category-page-view` Special pages such as sale or promotion pages viewed. * `checkout-start` User starting a checkout process. * `detail-page-view` Products detail page viewed. * `home-page-view` Homepage viewed. * `page-visit` Generic page visits not included in the event types above. * `purchase-complete` User finishing a purchase. * `refund` Purchased items being refunded or returned. * `remove-from-cart` Products being removed from cart. * `remove-from-list` Items being removed from a list. * `search` Product search. * `shopping-cart-page-view` User viewing a shopping cart. * `impression` List of items displayed. Used by Google Tag Manager. | -| `productEventDetail` | `object` | ProductEventDetail captures user event information specific to retail products. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommender/insight_types/index.md b/docs/google-docs/providers/google/recommender/insight_types/index.md deleted file mode 100644 index 102a25716f..0000000000 --- a/docs/google-docs/providers/google/recommender/insight_types/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: insight_types -hide_title: false -hide_table_of_contents: false -keywords: - - insight_types - - recommender - - 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 ---- - - - -## Overview - - - - -
Nameinsight_types
TypeResource
Idgoogle.recommender.insight_types
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `billingAccounts_locations_insightTypes_updateConfig` | `EXEC` | `billingAccountsId, insightTypesId, locationsId` | -| `organizations_locations_insightTypes_updateConfig` | `EXEC` | `insightTypesId, locationsId, organizationsId` | -| `projects_locations_insightTypes_updateConfig` | `EXEC` | `insightTypesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/recommender/insights/index.md b/docs/google-docs/providers/google/recommender/insights/index.md index f86b48796a..2e43bb32ef 100644 --- a/docs/google-docs/providers/google/recommender/insights/index.md +++ b/docs/google-docs/providers/google/recommender/insights/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Name of the insight. | | `description` | `string` | Free-form human readable summary in English. The maximum length is 500 characters. | +| `category` | `string` | Category being targeted by the insight. | +| `content` | `object` | A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000" | | `lastRefreshTime` | `string` | Timestamp of the latest data used to generate the insight. | | `etag` | `string` | Fingerprint of the Insight. Provides optimistic locking when updating states. | -| `targetResources` | `array` | Fully qualified resource names that this insight is targeting. | +| `insightSubtype` | `string` | Insight subtype. Insight content schema will be stable for a given subtype. | +| `stateInfo` | `object` | Information related to insight state. | | `associatedRecommendations` | `array` | Recommendations derived from this insight. | | `severity` | `string` | Insight's severity. | -| `stateInfo` | `object` | Information related to insight state. | -| `insightSubtype` | `string` | Insight subtype. Insight content schema will be stable for a given subtype. | +| `targetResources` | `array` | Fully qualified resource names that this insight is targeting. | | `observationPeriod` | `string` | Observation period that led to the insight. The source data used to generate the insight ends at last_refresh_time and begins at (last_refresh_time - observation_period). | -| `category` | `string` | Category being targeted by the insight. | -| `content` | `object` | A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000" | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommender/recommendations/index.md b/docs/google-docs/providers/google/recommender/recommendations/index.md index 4a18535470..b378688eb7 100644 --- a/docs/google-docs/providers/google/recommender/recommendations/index.md +++ b/docs/google-docs/providers/google/recommender/recommendations/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Name of recommendation. | | `description` | `string` | Free-form human readable summary in English. The maximum length is 500 characters. | +| `stateInfo` | `object` | Information for state. Contains state and metadata. | | `associatedInsights` | `array` | Insights that led to this recommendation. | -| `lastRefreshTime` | `string` | Last time this recommendation was refreshed by the system that created it in the first place. | -| `additionalImpact` | `array` | Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. | -| `xorGroupId` | `string` | Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. | | `etag` | `string` | Fingerprint of the Recommendation. Provides optimistic locking when updating states. | +| `primaryImpact` | `object` | Contains the impact a recommendation can have for a given category. | | `recommenderSubtype` | `string` | Contains an identifier for a subtype of recommendations produced for the same recommender. Subtype is a function of content and impact, meaning a new subtype might be added when significant changes to `content` or `primary_impact.category` are introduced. See the Recommenders section to see a list of subtypes for a given Recommender. Examples: For recommender = "google.iam.policy.Recommender", recommender_subtype can be one of "REMOVE_ROLE"/"REPLACE_ROLE" | +| `additionalImpact` | `array` | Optional set of additional impact that this recommendation may have when trying to optimize for the primary category. These may be positive or negative. | | `content` | `object` | Contains what resources are changing and how they are changing. | -| `primaryImpact` | `object` | Contains the impact a recommendation can have for a given category. | | `priority` | `string` | Recommendation's priority. | -| `stateInfo` | `object` | Information for state. Contains state and metadata. | +| `xorGroupId` | `string` | Corresponds to a mutually exclusive group ID within a recommender. A non-empty ID indicates that the recommendation belongs to a mutually exclusive group. This means that only one recommendation within the group is suggested to be applied. | +| `lastRefreshTime` | `string` | Last time this recommendation was refreshed by the system that created it in the first place. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommender/recommenders/index.md b/docs/google-docs/providers/google/recommender/recommenders/index.md deleted file mode 100644 index 792a154014..0000000000 --- a/docs/google-docs/providers/google/recommender/recommenders/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: recommenders -hide_title: false -hide_table_of_contents: false -keywords: - - recommenders - - recommender - - 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 ---- - - - -## Overview - - - - -
Namerecommenders
TypeResource
Idgoogle.recommender.recommenders
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `billingAccounts_locations_recommenders_updateConfig` | `EXEC` | `billingAccountsId, locationsId, recommendersId` | -| `organizations_locations_recommenders_updateConfig` | `EXEC` | `locationsId, organizationsId, recommendersId` | -| `projects_locations_recommenders_updateConfig` | `EXEC` | `locationsId, projectsId, recommendersId` | diff --git a/docs/google-docs/providers/google/redis/instances/index.md b/docs/google-docs/providers/google/redis/instances/index.md index 79e2b38899..989c7a46fc 100644 --- a/docs/google-docs/providers/google/redis/instances/index.md +++ b/docs/google-docs/providers/google/redis/instances/index.md @@ -28,40 +28,40 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/instances/{instance_id}` Note: Redis instances are managed and addressed at regional level so location_id here refers to a GCP region; however, users may choose which specific zone (or collection of zones for cross-zone instances) an instance should be provisioned in. Refer to location_id and alternative_location_id fields for more details. | -| `redisVersion` | `string` | Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility | -| `reservedIpRange` | `string` | Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. | -| `memorySizeGb` | `integer` | Required. Redis memory size in GiB. | -| `currentLocationId` | `string` | Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance. | -| `readEndpointPort` | `integer` | Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. | -| `readReplicasMode` | `string` | Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. | -| `suspensionReasons` | `array` | Optional. reasons that causes instance in "SUSPENDED" state. | -| `transitEncryptionMode` | `string` | Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. | -| `connectMode` | `string` | Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. | -| `authorizedNetwork` | `string` | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used. | -| `createTime` | `string` | Output only. The time the instance was created. | -| `customerManagedKey` | `string` | Optional. The KMS key reference that the customer provides when trying to create the instance. | -| `authEnabled` | `boolean` | Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. | -| `alternativeLocationId` | `string` | Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service. | -| `state` | `string` | Output only. The current state of this instance. | -| `tier` | `string` | Required. The service tier of the instance. | +| `persistenceIamIdentity` | `string` | Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation. | +| `maintenanceSchedule` | `object` | Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. | +| `host` | `string` | Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. | +| `statusMessage` | `string` | Output only. Additional information about the current status of this instance, if available. | | `displayName` | `string` | An arbitrary and optional user-provided name for the instance. | -| `labels` | `object` | Resource labels to represent user provided metadata | +| `state` | `string` | Output only. The current state of this instance. | | `persistenceConfig` | `object` | Configuration of the persistence functionality. | -| `readEndpoint` | `string` | Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. | -| `port` | `integer` | Output only. The port number of the exposed Redis endpoint. | -| `statusMessage` | `string` | Output only. Additional information about the current status of this instance, if available. | -| `redisConfigs` | `object` | Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries | +| `nodes` | `array` | Output only. Info per node. | +| `locationId` | `string` | Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone. | +| `alternativeLocationId` | `string` | Optional. If specified, at least one node will be provisioned in this zone in addition to the zone specified in location_id. Only applicable to standard tier. If provided, it must be a different zone from the one provided in [location_id]. Additional nodes beyond the first 2 will be placed in zones selected by the service. | | `availableMaintenanceVersions` | `array` | Optional. The available maintenance versions that an instance could update to. | +| `replicaCount` | `integer` | Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. | +| `suspensionReasons` | `array` | Optional. reasons that causes instance in "SUSPENDED" state. | | `maintenanceVersion` | `string` | Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". | +| `createTime` | `string` | Output only. The time the instance was created. | | `secondaryIpRange` | `string` | Optional. Additional IP range for node placement. Required when enabling read replicas on an existing instance. For DIRECT_PEERING mode value must be a CIDR range of size /28, or "auto". For PRIVATE_SERVICE_ACCESS mode value must be the name of an allocated address range associated with the private service access connection, or "auto". | -| `replicaCount` | `integer` | Optional. The number of replica nodes. The valid range for the Standard Tier with read replicas enabled is [1-5] and defaults to 2. If read replicas are not enabled for a Standard Tier instance, the only valid value is 1 and the default is 1. The valid value for basic tier is 0 and the default is also 0. | -| `serverCaCerts` | `array` | Output only. List of server CA certificates for the instance. | -| `host` | `string` | Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. | -| `locationId` | `string` | Optional. The zone where the instance will be provisioned. If not provided, the service will choose a zone from the specified region for the instance. For standard tier, additional nodes will be added across multiple zones for protection against zonal failures. If specified, at least one node will be provisioned in this zone. | -| `maintenanceSchedule` | `object` | Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. | -| `persistenceIamIdentity` | `string` | Output only. Cloud IAM identity used by import / export operations to transfer data to/from Cloud Storage. Format is "serviceAccount:". The value may change over time for a given instance so should be checked before each import/export operation. | +| `transitEncryptionMode` | `string` | Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. | +| `tier` | `string` | Required. The service tier of the instance. | +| `authorizedNetwork` | `string` | Optional. The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used. | +| `readReplicasMode` | `string` | Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. | +| `reservedIpRange` | `string` | Optional. For DIRECT_PEERING mode, the CIDR range of internal addresses that are reserved for this instance. Range must be unique and non-overlapping with existing subnets in an authorized network. For PRIVATE_SERVICE_ACCESS mode, the name of one allocated IP address ranges associated with this private service access connection. If not provided, the service will choose an unused /29 block, for example, 10.0.0.0/29 or 192.168.0.0/29. For READ_REPLICAS_ENABLED the default block size is /28. | +| `readEndpointPort` | `integer` | Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. | | `maintenancePolicy` | `object` | Maintenance policy for an instance. | -| `nodes` | `array` | Output only. Info per node. | +| `redisVersion` | `string` | Optional. The version of Redis software. If not provided, latest supported version will be used. Currently, the supported values are: * `REDIS_3_2` for Redis 3.2 compatibility * `REDIS_4_0` for Redis 4.0 compatibility (default) * `REDIS_5_0` for Redis 5.0 compatibility * `REDIS_6_X` for Redis 6.x compatibility | +| `readEndpoint` | `string` | Output only. Hostname or IP address of the exposed readonly Redis endpoint. Standard tier only. Targets all healthy replica nodes in instance. Replication is asynchronous and replica nodes will exhibit some lag behind the primary. Write requests must target 'host'. | +| `connectMode` | `string` | Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. | +| `port` | `integer` | Output only. The port number of the exposed Redis endpoint. | +| `labels` | `object` | Resource labels to represent user provided metadata | +| `memorySizeGb` | `integer` | Required. Redis memory size in GiB. | +| `currentLocationId` | `string` | Output only. The current zone where the Redis primary node is located. In basic tier, this will always be the same as [location_id]. In standard tier, this can be the zone of any node in the instance. | +| `serverCaCerts` | `array` | Output only. List of server CA certificates for the instance. | +| `redisConfigs` | `object` | Optional. Redis configuration parameters, according to http://redis.io/topics/config. Currently, the only supported parameters are: Redis version 3.2 and newer: * maxmemory-policy * notify-keyspace-events Redis version 4.0 and newer: * activedefrag * lfu-decay-time * lfu-log-factor * maxmemory-gb Redis version 5.0 and newer: * stream-node-max-bytes * stream-node-max-entries | +| `authEnabled` | `boolean` | Optional. Indicates whether OSS Redis AUTH is enabled for the instance. If set to "true" AUTH is enabled on the instance. Default value is "false" meaning AUTH is disabled. | +| `customerManagedKey` | `string` | Optional. The KMS key reference that the customer provides when trying to create the instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/redis/locations/index.md b/docs/google-docs/providers/google/redis/locations/index.md index 53de0ea7c8..6839891baf 100644 --- a/docs/google-docs/providers/google/redis/locations/index.md +++ b/docs/google-docs/providers/google/redis/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full resource name for the region. For example: "projects/example-project/locations/us-east1". | -| `locationId` | `string` | Resource ID for the region. For example: "us-east1". | -| `metadata` | `object` | Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | Resource ID for the region. For example: "us-east1". | +| `metadata` | `object` | Output only. The set of available zones in the location. The map is keyed by the lowercase ID of each zone, as defined by Compute Engine. These keys can be specified in `location_id` or `alternative_location_id` fields when creating a Redis instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/redis/operations/index.md b/docs/google-docs/providers/google/redis/operations/index.md index b7f4bf0a80..69316a82cf 100644 --- a/docs/google-docs/providers/google/redis/operations/index.md +++ b/docs/google-docs/providers/google/redis/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `object` | The normal response of the operation in case of success. 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`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `object` | { `createTime`: The time the operation was created. `endTime`: The time the operation finished running. `target`: Server-defined resource path for the target of the operation. `verb`: Name of the verb executed by the operation. `statusDetail`: Human-readable status of the operation, if any. `cancelRequested`: Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. `apiVersion`: API version used to start the operation. } | +| `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/resourcesettings/settings/index.md b/docs/google-docs/providers/google/resourcesettings/settings/index.md index f74ff7bad0..88dbb4914b 100644 --- a/docs/google-docs/providers/google/resourcesettings/settings/index.md +++ b/docs/google-docs/providers/google/resourcesettings/settings/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the setting. Must be in one of the following forms: * `projects/{project_number}/settings/{setting_name}` * `folders/{folder_id}/settings/{setting_name}` * `organizations/{organization_id}/settings/{setting_name}` For example, "/projects/123/settings/gcp-enableMyFeature" | +| `metadata` | `object` | Metadata about a setting which is not editable by the end user. | | `effectiveValue` | `object` | The data in a setting value. | | `etag` | `string` | A fingerprint used for optimistic concurrency. See UpdateSetting for more details. | | `localValue` | `object` | The data in a setting value. | -| `metadata` | `object` | Metadata about a setting which is not editable by the end user. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/catalogs/index.md b/docs/google-docs/providers/google/retail/catalogs/index.md index eb8e1529ec..cfa1206190 100644 --- a/docs/google-docs/providers/google/retail/catalogs/index.md +++ b/docs/google-docs/providers/google/retail/catalogs/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Immutable. The fully qualified resource name of the catalog. | -| `productLevelConfig` | `object` | Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made. | | `displayName` | `string` | Required. Immutable. The catalog display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. | +| `productLevelConfig` | `object` | Configures what level the product should be uploaded with regards to how users will be send events and how predictions will be made. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md b/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md index 40f7f67dc1..c4fce70343 100644 --- a/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md +++ b/docs/google-docs/providers/google/retail/catalogs_completion_config/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig` | -| `lastDenylistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | +| `autoLearning` | `boolean` | If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in CompleteQueryRequest. | | `matchingOrder` | `string` | Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values: * 'out-of-order' * 'exact-prefix' Default value: 'exact-prefix'. | -| `maxSuggestions` | `integer` | The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. | -| `lastSuggestionsImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation. | -| `minPrefixLength` | `integer` | The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. | | `suggestionsInputConfig` | `object` | The input config source for completion data. | +| `lastAllowlistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | | `allowlistInputConfig` | `object` | The input config source for completion data. | | `denylistInputConfig` | `object` | The input config source for completion data. | -| `autoLearning` | `boolean` | If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use `cloud-retail` data in CompleteQueryRequest. | -| `lastAllowlistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest allowlist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | +| `lastDenylistImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest denylist import. Can use GetOperation API to retrieve the latest state of the Long Running Operation. | +| `maxSuggestions` | `integer` | The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. | +| `lastSuggestionsImportOperation` | `string` | Output only. Name of the LRO corresponding to the latest suggestion terms list import. Can use GetOperation API method to retrieve the latest state of the Long Running Operation. | +| `minPrefixLength` | `integer` | The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value. Value range is 1 to 20. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/catalogs_default_branch/index.md b/docs/google-docs/providers/google/retail/catalogs_default_branch/index.md index 98e33b240f..5562650718 100644 --- a/docs/google-docs/providers/google/retail/catalogs_default_branch/index.md +++ b/docs/google-docs/providers/google/retail/catalogs_default_branch/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `branch` | `string` | Full resource name of the branch id currently set as default branch. | | `note` | `string` | This corresponds to SetDefaultBranchRequest.note field, when this branch was set as default. | | `setTime` | `string` | The time when this branch is set to default. | +| `branch` | `string` | Full resource name of the branch id currently set as default branch. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/retail/controls/index.md b/docs/google-docs/providers/google/retail/controls/index.md index 926941ea37..672083017e 100644 --- a/docs/google-docs/providers/google/retail/controls/index.md +++ b/docs/google-docs/providers/google/retail/controls/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*` | -| `associatedServingConfigIds` | `array` | Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view. | -| `displayName` | `string` | Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown. | | `rule` | `object` | A rule is a condition-action pair * A condition defines when a rule is to be triggered. * An action specifies what occurs on that trigger. Currently rules only work for controls with SOLUTION_TYPE_SEARCH. | | `searchSolutionUseCase` | `array` | Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control. | | `solutionTypes` | `array` | Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH. | +| `associatedServingConfigIds` | `array` | Output only. List of serving config ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view. | +| `displayName` | `string` | Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/models/index.md b/docs/google-docs/providers/google/retail/models/index.md index 6297bece9f..b15250866c 100644 --- a/docs/google-docs/providers/google/retail/models/index.md +++ b/docs/google-docs/providers/google/retail/models/index.md @@ -28,20 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location_id}/catalogs/{catalog_id}/models/{model_id}` catalog_id has char limit of 50. recommendation_model_id has char limit of 40. | -| `periodicTuningState` | `string` | Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`. | -| `displayName` | `string` | Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters. | -| `dataState` | `string` | Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training. | -| `trainingState` | `string` | Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before. | | `type` | `string` | Required. The type of model e.g. `home-page`. Currently supported values: `recommended-for-you`, `others-you-may-like`, `frequently-bought-together`, `page-optimization`, `similar-items`, `buy-it-again`, `on-sale-items`, and `recently-viewed`(readonly value). This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. | +| `updateTime` | `string` | Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. | | `filteringOption` | `string` | Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model. | -| `createTime` | `string` | Output only. Timestamp the Recommendation Model was created at. | | `tuningOperation` | `string` | Output only. The tune operation associated with the model. Can be used to determine if there is an ongoing tune for this recommendation. Empty field implies no tune is goig on. | -| `optimizationObjective` | `string` | Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. | +| `createTime` | `string` | Output only. Timestamp the Recommendation Model was created at. | | `servingState` | `string` | Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`. | +| `dataState` | `string` | Output only. The state of data requirements for this model: `DATA_OK` and `DATA_ERROR`. Recommendation model cannot be trained if the data is in `DATA_ERROR` state. Recommendation model can have `DATA_ERROR` state even if serving state is `ACTIVE`: models were trained successfully before, but cannot be refreshed because model no longer has sufficient data for training. | +| `displayName` | `string` | Required. The display name of the model. Should be human readable, used to display Recommendation Models in the Retail Cloud Console Dashboard. UTF-8 encoded string with limit of 1024 characters. | | `modelFeaturesConfig` | `object` | Additional model features config. | +| `trainingState` | `string` | Optional. The training state that the model is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train model in order to control cost. If not specified: the default value for `CreateModel` method is `TRAINING`. The default value for `UpdateModel` method is to keep the state the same as before. | | `lastTuneTime` | `string` | Output only. The timestamp when the latest successful tune finished. | | `servingConfigLists` | `array` | Output only. The list of valid serving configs associated with the PageOptimizationConfig. | -| `updateTime` | `string` | Output only. Timestamp the Recommendation Model was last updated. E.g. if a Recommendation Model was paused - this would be the time the pause was initiated. | +| `optimizationObjective` | `string` | Optional. The optimization objective e.g. `cvr`. Currently supported values: `ctr`, `cvr`, `revenue-per-order`. If not specified, we choose default based on model type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr` `frequently-bought-together` => `revenue_per_order` This field together with optimization_objective describe model metadata to use to control model training and serving. See https://cloud.google.com/retail/docs/models for more details on what the model metadata control and which combination of parameters are valid. For invalid combinations of parameters (e.g. type = `frequently-bought-together` and optimization_objective = `ctr`), you receive an error 400 if you try to create/update a recommendation with this set of knobs. | +| `periodicTuningState` | `string` | Optional. The state of periodic tuning. The period we use is 3 months - to do a one-off tune earlier use the `TuneModel` method. Default value is `PERIODIC_TUNING_ENABLED`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/operations/index.md b/docs/google-docs/providers/google/retail/operations/index.md index 0ade325f75..9295f82768 100644 --- a/docs/google-docs/providers/google/retail/operations/index.md +++ b/docs/google-docs/providers/google/retail/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | -| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/products/index.md b/docs/google-docs/providers/google/retail/products/index.md index 218019921d..08c69b6f2c 100644 --- a/docs/google-docs/providers/google/retail/products/index.md +++ b/docs/google-docs/providers/google/retail/products/index.md @@ -30,37 +30,37 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Immutable. Product identifier, which is the final component of name. For example, this field is "id_1", if name is `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/id_1`. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [id](https://support.google.com/merchants/answer/6324405). Schema.org property [Product.sku](https://schema.org/sku). | | `name` | `string` | Immutable. Full resource name of the product, such as `projects/*/locations/global/catalogs/default_catalog/branches/default_branch/products/product_id`. | | `description` | `string` | Product description. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [description](https://support.google.com/merchants/answer/6324468). Schema.org property [Product.description](https://schema.org/description). | -| `sizes` | `array` | The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). | -| `colorInfo` | `object` | The color information of a Product. | +| `brands` | `array` | The brands of the product. A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand). | | `attributes` | `object` | Highly encouraged. Extra product attributes to be included. For example, for products, this could include the store name, vendor, style, color, etc. These are very strong signals for recommendation model, thus we highly recommend providing the attributes here. Features that can take on one of a limited number of possible values. Two types of features can be set are: Textual features. some examples would be the brand/maker of a product, or country of a customer. Numerical features. Some examples would be the height/weight of a product, or age of a customer. For example: `{ "vendor": {"text": ["vendor123", "vendor456"]}, "lengths_cm": {"numbers":[2.3, 15.4]}, "heights_cm": {"numbers":[8.1, 6.4]} }`. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * Max entries count: 200. * The key must be a UTF-8 encoded string with a length limit of 128 characters. * For indexable attribute, the key must match the pattern: `a-zA-Z0-9*`. For example, `key0LikeThis` or `KEY_1_LIKE_THIS`. * For text attributes, at most 400 values are allowed. Empty values are not allowed. Each value must be a non-empty UTF-8 encoded string with a length limit of 256 characters. * For number attributes, at most 400 values are allowed. | +| `variants` | `array` | Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primary_product_id for all the product variants. Only populated for Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. | +| `conditions` | `array` | The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition). | +| `materials` | `array` | The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material). | +| `retrievableFields` | `string` | Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. | +| `tags` | `array` | Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). | | `title` | `string` | Required. Product title. This field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [title](https://support.google.com/merchants/answer/6324415). Schema.org property [Product.name](https://schema.org/name). | -| `images` | `array` | Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image). | -| `availableQuantity` | `integer` | The available quantity of the item. | -| `availability` | `string` | The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). | -| `primaryProductId` | `string` | Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). | -| `publishTime` | `string` | The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation. | -| `collectionMemberIds` | `array` | The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return. | -| `audience` | `object` | An intended audience of the Product for whom it's sold. | | `priceInfo` | `object` | The price information of a Product. | -| `materials` | `array` | The material of the product. For example, "leather", "wooden". A maximum of 20 values are allowed. Each value must be a UTF-8 encoded string with a length limit of 200 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [material](https://support.google.com/merchants/answer/6324410). Schema.org property [Product.material](https://schema.org/material). | -| `expireTime` | `string` | The timestamp when this product becomes unavailable for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, the Product is not available for SearchService.Search after expire_time. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. expire_time must be later than available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499). | | `patterns` | `array` | The pattern or graphic print of the product. For example, "striped", "polka dot", "paisley". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [pattern](https://support.google.com/merchants/answer/6324483). Schema.org property [Product.pattern](https://schema.org/pattern). | +| `uri` | `string` | Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url). | | `categories` | `array` | Product categories. This field is repeated for supporting one product belonging to several parallel categories. Strongly recommended using the full path for better search / recommendation quality. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). For example, if a shoes product belongs to both ["Shoes & Accessories" -> "Shoes"] and ["Sports & Fitness" -> "Athletic Clothing" -> "Shoes"], it could be represented as: "categories": [ "Shoes & Accessories > Shoes", "Sports & Fitness > Athletic Clothing > Shoes" ] Must be set for Type.PRIMARY Product otherwise an INVALID_ARGUMENT error is returned. At most 250 values are allowed per Product. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property google_product_category. Schema.org property [Product.category] (https://schema.org/category). [mc_google_product_category]: https://support.google.com/merchants/answer/6324436 | -| `fulfillmentInfo` | `array` | Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned. | -| `gtin` | `string` | The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned. | -| `brands` | `array` | The brands of the product. A maximum of 30 brands are allowed unless overridden through the Google Cloud console. Each brand must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [brand](https://support.google.com/merchants/answer/6324351). Schema.org property [Product.brand](https://schema.org/brand). | -| `promotions` | `array` | The promotions applied to the product. A maximum of 10 values are allowed per Product. Only Promotion.promotion_id will be used, other fields will be ignored if set. | -| `tags` | `array` | Custom tags associated with the product. At most 250 values are allowed per Product. This value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This tag can be used for filtering recommendation results by passing the tag as part of the PredictRequest.filter. Corresponding properties: Google Merchant Center property [custom_label_0–4](https://support.google.com/merchants/answer/6324473). | +| `publishTime` | `string` | The timestamp when the product is published by the retailer for the first time, which indicates the freshness of the products. Note that this field is different from available_time, given it purely describes product freshness regardless of when it is available on search and recommendation. | | `type` | `string` | Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset. | -| `conditions` | `array` | The condition of the product. Strongly encouraged to use the standard values: "new", "refurbished", "used". A maximum of 1 value is allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [condition](https://support.google.com/merchants/answer/6324469). Schema.org property [Offer.itemCondition](https://schema.org/itemCondition). | -| `retrievableFields` | `string` | Indicates which fields in the Products are returned in SearchResponse. Supported fields for all types: * audience * availability * brands * color_info * conditions * gtin * materials * name * patterns * price_info * rating * sizes * title * uri Supported fields only for Type.PRIMARY and Type.COLLECTION: * categories * description * images Supported fields only for Type.VARIANT: * Only the first image in images To mark attributes as retrievable, include paths of the form "attributes.key" where "key" is the key of a custom attribute, as specified in attributes. For Type.PRIMARY and Type.COLLECTION, the following fields are always returned in SearchResponse by default: * name For Type.VARIANT, the following fields are always returned in by default: * name * color_info The maximum number of paths is 30. Otherwise, an INVALID_ARGUMENT error is returned. Note: Returning more fields in SearchResponse can increase response payload size and serving latency. This field is deprecated. Use the retrievable site-wide control instead. | -| `localInventories` | `array` | Output only. A list of local inventories specific to different places. This field can be managed by ProductService.AddLocalInventories and ProductService.RemoveLocalInventories APIs if fine-grained, high-volume updates are necessary. | -| `uri` | `string` | Canonical URL directly linking to the product detail page. It is strongly recommended to provide a valid uri for the product, otherwise the service performance could be significantly degraded. This field must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [link](https://support.google.com/merchants/answer/6324416). Schema.org property [Offer.url](https://schema.org/url). | -| `variants` | `array` | Output only. Product variants grouped together on primary product which share similar product attributes. It's automatically grouped by primary_product_id for all the product variants. Only populated for Type.PRIMARY Products. Note: This field is OUTPUT_ONLY for ProductService.GetProduct. Do not set this field in API requests. | -| `availableTime` | `string` | The timestamp when this Product becomes available for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. | | `rating` | `object` | The rating of a Product. | -| `ttl` | `string` | Input only. The TTL (time to live) of the product. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and expire_time is set as current timestamp plus ttl. The derived expire_time is returned in the output and ttl is left blank when retrieving the Product. If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. | +| `promotions` | `array` | The promotions applied to the product. A maximum of 10 values are allowed per Product. Only Promotion.promotion_id will be used, other fields will be ignored if set. | | `languageCode` | `string` | Language of the title/description and other string attributes. Use language tags defined by [BCP 47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). For product prediction, this field is ignored and the model automatically detects the text language. The Product can include text in different languages, but duplicating Products to provide text in multiple languages can result in degraded model performance. For product search this field is in use. It defaults to "en-US" if unset. | +| `images` | `array` | Product images for the product. We highly recommend putting the main image first. A maximum of 300 images are allowed. Corresponding properties: Google Merchant Center property [image_link](https://support.google.com/merchants/answer/6324350). Schema.org property [Product.image](https://schema.org/image). | +| `audience` | `object` | An intended audience of the Product for whom it's sold. | +| `ttl` | `string` | Input only. The TTL (time to live) of the product. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, it must be a non-negative value, and expire_time is set as current timestamp plus ttl. The derived expire_time is returned in the output and ttl is left blank when retrieving the Product. If it is set, the product is not available for SearchService.Search after current timestamp plus ttl. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. | +| `availability` | `string` | The online availability of the Product. Default to Availability.IN_STOCK. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability). | +| `availableTime` | `string` | The timestamp when this Product becomes available for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. | +| `expireTime` | `string` | The timestamp when this product becomes unavailable for SearchService.Search. Note that this is only applicable to Type.PRIMARY and Type.COLLECTION, and ignored for Type.VARIANT. In general, we suggest the users to delete the stale products explicitly, instead of using this field to determine staleness. If it is set, the Product is not available for SearchService.Search after expire_time. However, the product can still be retrieved by ProductService.GetProduct and ProductService.ListProducts. expire_time must be later than available_time and publish_time, otherwise an INVALID_ARGUMENT error is thrown. Corresponding properties: Google Merchant Center property [expiration_date](https://support.google.com/merchants/answer/6324499). | +| `primaryProductId` | `string` | Variant group identifier. Must be an id, with the same parent branch with this product. Otherwise, an error is thrown. For Type.PRIMARY Products, this field can only be empty or set to the same value as id. For VARIANT Products, this field cannot be empty. A maximum of 2,000 products are allowed to share the same Type.PRIMARY Product. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [item_group_id](https://support.google.com/merchants/answer/6324507). Schema.org property [Product.inProductGroupWithID](https://schema.org/inProductGroupWithID). | +| `colorInfo` | `object` | The color information of a Product. | +| `gtin` | `string` | The Global Trade Item Number (GTIN) of the product. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. This field must be a Unigram. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [gtin](https://support.google.com/merchants/answer/6324461). Schema.org property [Product.isbn](https://schema.org/isbn), [Product.gtin8](https://schema.org/gtin8), [Product.gtin12](https://schema.org/gtin12), [Product.gtin13](https://schema.org/gtin13), or [Product.gtin14](https://schema.org/gtin14). If the value is not a valid GTIN, an INVALID_ARGUMENT error is returned. | +| `sizes` | `array` | The size of the product. To represent different size systems or size types, consider using this format: [[[size_system:]size_type:]size_value]. For example, in "US:MENS:M", "US" represents size system; "MENS" represents size type; "M" represents size value. In "GIRLS:27", size system is empty; "GIRLS" represents size type; "27" represents size value. In "32 inches", both size system and size type are empty, while size value is "32 inches". A maximum of 20 values are allowed per Product. Each value must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. Corresponding properties: Google Merchant Center property [size](https://support.google.com/merchants/answer/6324492), [size_type](https://support.google.com/merchants/answer/6324497), and [size_system](https://support.google.com/merchants/answer/6324502). Schema.org property [Product.size](https://schema.org/size). | +| `availableQuantity` | `integer` | The available quantity of the item. | +| `collectionMemberIds` | `array` | The id of the collection members when type is Type.COLLECTION. Non-existent product ids are allowed. The type of the members must be either Type.PRIMARY or Type.VARIANT otherwise an INVALID_ARGUMENT error is thrown. Should not set it for other types. A maximum of 1000 values are allowed. Otherwise, an INVALID_ARGUMENT error is return. | +| `localInventories` | `array` | Output only. A list of local inventories specific to different places. This field can be managed by ProductService.AddLocalInventories and ProductService.RemoveLocalInventories APIs if fine-grained, high-volume updates are necessary. | +| `fulfillmentInfo` | `array` | Fulfillment information, such as the store IDs for in-store pickup or region IDs for different shipping methods. All the elements must have distinct FulfillmentInfo.type. Otherwise, an INVALID_ARGUMENT error is returned. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/serving_configs/index.md b/docs/google-docs/providers/google/retail/serving_configs/index.md index a39f8758fd..4d63ef3bda 100644 --- a/docs/google-docs/providers/google/retail/serving_configs/index.md +++ b/docs/google-docs/providers/google/retail/serving_configs/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/servingConfig/*` | -| `doNotAssociateControlIds` | `array` | Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `displayName` | `string` | Required. The human readable serving config display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. | +| `boostControlIds` | `array` | Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100. Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `replacementControlIds` | `array` | Condition replacement specifications. - Applied according to the order in the list. - A previously replaced term can not be re-replaced. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `redirectControlIds` | `array` | Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | | `personalizationSpec` | `object` | The specification for personalization. | | `diversityType` | `string` | What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY. | -| `displayName` | `string` | Required. The human readable serving config display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. | -| `dynamicFacetSpec` | `object` | The specifications of dynamically generated facets. | -| `facetControlIds` | `array` | Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | -| `ignoreControlIds` | `array` | Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | | `onewaySynonymsControlIds` | `array` | Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `doNotAssociateControlIds` | `array` | Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | | `solutionTypes` | `array` | Required. Immutable. Specifies the solution types that a serving config can be associated with. Currently we support setting only one type of solution. | -| `priceRerankingLevel` | `string` | How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are: * `no-price-reranking` * `low-price-reranking` * `medium-price-reranking` * `high-price-reranking` If not specified, we choose default based on model type. Default value: `no-price-reranking`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | | `modelId` | `string` | The id of the model in the same Catalog to use at serving time. Currently only RecommendationModels are supported: https://cloud.google.com/retail/recommendations-ai/docs/create-models Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when solution_types is SOLUTION_TYPE_RECOMMENDATION. | +| `diversityLevel` | `string` | How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | | `filterControlIds` | `array` | Condition filter specifications. If a product matches multiple conditions in the specifications, filters from these specifications are all applied and combined via the AND operator. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | -| `redirectControlIds` | `array` | Condition redirect specifications. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 1000. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `dynamicFacetSpec` | `object` | The specifications of dynamically generated facets. | +| `priceRerankingLevel` | `string` | How much price ranking we want in serving results. Price reranking causes product items with a similar recommendation probability to be ordered by price, with the highest-priced items first. This setting could result in a decrease in click-through and conversion rates. Allowed values are: * `no-price-reranking` * `low-price-reranking` * `medium-price-reranking` * `high-price-reranking` If not specified, we choose default based on model type. Default value: `no-price-reranking`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | +| `ignoreControlIds` | `array` | Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. - Order does not matter. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | +| `facetControlIds` | `array` | Facet specifications for faceted search. If empty, no facets are returned. The ids refer to the ids of Control resources with only the Facet control set. These controls are assumed to be in the same Catalog as the ServingConfig. A maximum of 100 values are allowed. Otherwise, an INVALID_ARGUMENT error is returned. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | | `twowaySynonymsControlIds` | `array` | Condition synonyms specifications. If multiple syonyms conditions match, all matching synonyms control in the list will execute. Order of controls in the list will not matter. Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | -| `diversityLevel` | `string` | How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | -| `boostControlIds` | `array` | Condition boost specifications. If a product matches multiple conditions in the specifications, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 100. Notice that if both ServingConfig.boost_control_ids and SearchRequest.boost_spec are set, the boost conditions from both places are evaluated. If a search request matches multiple boost conditions, the final boost score is equal to the sum of the boost scores from all matched boost conditions. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | | `enableCategoryFilterLevel` | `string` | Whether to add additional category filters on the `similar-items` model. If not specified, we enable it by default. Allowed values are: * `no-category-match`: No additional filtering of original results from the model and the customer's filters. * `relaxed-category-match`: Only keep results with categories that match at least one item categories in the PredictRequests's context item. * If customer also sends filters in the PredictRequest, then the results will satisfy both conditions (user given and category match). Can only be set if solution_types is SOLUTION_TYPE_RECOMMENDATION. | -| `replacementControlIds` | `array` | Condition replacement specifications. - Applied according to the order in the list. - A previously replaced term can not be re-replaced. - Maximum number of specifications is 100. Can only be set if solution_types is SOLUTION_TYPE_SEARCH. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/executions/index.md b/docs/google-docs/providers/google/run/executions/index.md index cdf6629b77..db1c801014 100644 --- a/docs/google-docs/providers/google/run/executions/index.md +++ b/docs/google-docs/providers/google/run/executions/index.md @@ -29,31 +29,31 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The unique name of this Execution. | | `updateTime` | `string` | Output only. The last-modified time. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `retriedCount` | `integer` | Output only. The number of tasks which have retried at least once. | +| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels | +| `cancelledCount` | `integer` | Output only. The number of tasks which reached phase Cancelled. | +| `conditions` | `array` | Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state. | | `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | | `failedCount` | `integer` | Output only. The number of tasks which reached phase Failed. | -| `template` | `object` | TaskTemplate describes the data a task should have when created from a template. | -| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `runningCount` | `integer` | Output only. The number of actively running tasks. | +| `succeededCount` | `integer` | Output only. The number of tasks which reached phase Succeeded. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `uid` | `string` | Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | | `job` | `string` | Output only. The name of the parent Job. | -| `observedGeneration` | `string` | Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels | +| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | +| `template` | `object` | TaskTemplate describes the data a task should have when created from a template. | | `startTime` | `string` | Output only. Represents time when the execution started to run. It is not guaranteed to be set in happens-before order across separate operations. | -| `retriedCount` | `integer` | Output only. The number of tasks which have retried at least once. | -| `cancelledCount` | `integer` | Output only. The number of tasks which reached phase Cancelled. | +| `observedGeneration` | `string` | Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `parallelism` | `integer` | Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. | +| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | +| `createTime` | `string` | Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations. | | `taskCount` | `integer` | Output only. Specifies the desired number of tasks the execution should run. Setting to 1 means that parallelism is limited to 1 and the success of that task signals the success of the execution. | -| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | -| `launchStage` | `string` | The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA. | | `annotations` | `object` | Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. | -| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | -| `runningCount` | `integer` | Output only. The number of actively running tasks. | +| `launchStage` | `string` | The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA. | | `completionTime` | `string` | Output only. Represents time when the execution was completed. It is not guaranteed to be set in happens-before order across separate operations. | -| `parallelism` | `integer` | Output only. Specifies the maximum desired number of tasks the execution should run at any given time. Must be <= task_count. The actual number of tasks running in steady state will be less than this number when ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when the work left to do is less than max parallelism. | -| `uid` | `string` | Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | -| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | -| `succeededCount` | `integer` | Output only. The number of tasks which reached phase Succeeded. | -| `createTime` | `string` | Output only. Represents time when the execution was acknowledged by the execution controller. It is not guaranteed to be set in happens-before order across separate operations. | -| `conditions` | `array` | Output only. The Condition of this Execution, containing its readiness status, and detailed error information in case it did not reach the desired state. | -| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/jobs/index.md b/docs/google-docs/providers/google/run/jobs/index.md index 72d9340a71..5ac6c30e81 100644 --- a/docs/google-docs/providers/google/run/jobs/index.md +++ b/docs/google-docs/providers/google/run/jobs/index.md @@ -28,29 +28,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The fully qualified name of this Job. Format: projects/{project}/locations/{location}/jobs/{job} | -| `reconciling` | `boolean` | Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, `observed_generation` and `latest_succeeded_execution`, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `observed_generation` and `generation`, `latest_succeeded_execution` and `latest_created_execution`. If reconciliation failed, `observed_generation` and `latest_succeeded_execution` will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in `terminal_condition` and `conditions`. | -| `executionCount` | `integer` | Output only. Number of executions created for this job. | +| `latestCreatedExecution` | `object` | Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. | +| `launchStage` | `string` | The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. | +| `terminalCondition` | `object` | Defines a status condition for a resource. | | `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. | +| `client` | `string` | Arbitrary identifier for the API client. | +| `labels` | `object` | Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. | +| `updateTime` | `string` | Output only. The last-modified time. | | `template` | `object` | ExecutionTemplate describes the data an execution should have when created from a template. | | `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | +| `clientVersion` | `string` | Arbitrary version identifier for the API client. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `createTime` | `string` | Output only. The creation time. | | `conditions` | `array` | Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Job does not reach its desired state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `reconciling` | `boolean` | Output only. Returns true if the Job is currently being acted upon by the system to bring it into the desired state. When a new Job is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Job to the desired state. This process is called reconciliation. While reconciliation is in process, `observed_generation` and `latest_succeeded_execution`, will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the state matches the Job, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `observed_generation` and `generation`, `latest_succeeded_execution` and `latest_created_execution`. If reconciliation failed, `observed_generation` and `latest_succeeded_execution` will have the state of the last succeeded execution or empty for newly created Job. Additional information on the failure can be found in `terminal_condition` and `conditions`. | +| `uid` | `string` | Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `executionCount` | `integer` | Output only. Number of executions created for this job. | +| `deleteTime` | `string` | Output only. The deletion time. | | `creator` | `string` | Output only. Email address of the authenticated creator. | -| `latestCreatedExecution` | `object` | Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. | | `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | -| `labels` | `object` | Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Job. | -| `clientVersion` | `string` | Arbitrary version identifier for the API client. | | `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | -| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | | `observedGeneration` | `string` | Output only. The generation of this Job. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `deleteTime` | `string` | Output only. The deletion time. | -| `updateTime` | `string` | Output only. The last-modified time. | -| `client` | `string` | Arbitrary identifier for the API client. | -| `launchStage` | `string` | The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. | -| `terminalCondition` | `object` | Defines a status condition for a resource. | -| `createTime` | `string` | Output only. The creation time. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | | `annotations` | `object` | Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected on new resources. All system annotations in v1 now have a corresponding field in v2 Job. This field follows Kubernetes annotations' namespacing, limits, and rules. | -| `uid` | `string` | Output only. Server assigned unique identifier for the Execution. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/jobs_iam_audit_configs/index.md b/docs/google-docs/providers/google/run/jobs_iam_audit_configs/index.md deleted file mode 100644 index 9f693ebcfa..0000000000 --- a/docs/google-docs/providers/google/run/jobs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: jobs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_audit_configs - - run - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_audit_configs
TypeResource
Idgoogle.run.jobs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_jobs_getIamPolicy` | `SELECT` | `jobsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/run/jobs_iam_bindings/index.md b/docs/google-docs/providers/google/run/jobs_iam_bindings/index.md deleted file mode 100644 index 2ee70ad4cd..0000000000 --- a/docs/google-docs/providers/google/run/jobs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: jobs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - jobs_iam_bindings - - run - - 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 ---- - - - -## Overview - - - - -
Namejobs_iam_bindings
TypeResource
Idgoogle.run.jobs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_jobs_getIamPolicy` | `SELECT` | `jobsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/run/operations/index.md b/docs/google-docs/providers/google/run/operations/index.md index e16fa31214..329282aba0 100644 --- a/docs/google-docs/providers/google/run/operations/index.md +++ b/docs/google-docs/providers/google/run/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/revisions/index.md b/docs/google-docs/providers/google/run/revisions/index.md index fcc90b29c6..2bfde42a55 100644 --- a/docs/google-docs/providers/google/run/revisions/index.md +++ b/docs/google-docs/providers/google/run/revisions/index.md @@ -28,34 +28,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique name of this Revision. | -| `logUri` | `string` | Output only. The Google Console URI to obtain logs for the Revision. | -| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. | -| `service` | `string` | Output only. The name of the parent service. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | +| `encryptionKeyRevocationAction` | `string` | The action to take if the encryption key is revoked. | | `volumes` | `array` | A list of Volumes to make available to containers. | -| `executionEnvironment` | `string` | The execution environment being used to host this Revision. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | | `sessionAffinity` | `boolean` | Enable session affinity. | -| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | -| `createTime` | `string` | Output only. The creation time. | -| `encryptionKeyShutdownDuration` | `string` | If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. | -| `uid` | `string` | Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | -| `encryptionKeyRevocationAction` | `string` | The action to take if the encryption key is revoked. | -| `updateTime` | `string` | Output only. The last-modified time. | -| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run. | -| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | -| `timeout` | `string` | Max allowed time for an instance to respond to a request. | +| `service` | `string` | Output only. The name of the parent service. | | `containers` | `array` | Holds the single container that defines the unit of execution for this Revision. | +| `executionEnvironment` | `string` | The execution environment being used to host this Revision. | +| `logUri` | `string` | Output only. The Google Console URI to obtain logs for the Revision. | | `scaling` | `object` | Settings for revision-level scaling settings. | | `annotations` | `object` | Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `updateTime` | `string` | Output only. The last-modified time. | | `serviceAccount` | `string` | Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. | -| `launchStage` | `string` | The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA. | +| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | +| `uid` | `string` | Output only. Server assigned unique identifier for the Revision. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | | `observedGeneration` | `string` | Output only. The generation of this Revision currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | -| `maxInstanceRequestConcurrency` | `integer` | Sets the maximum number of requests that each serving instance can receive. | -| `vpcAccess` | `object` | VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | +| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. | +| `launchStage` | `string` | The least stable launch stage needed to create this resource, as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. Note that this value might not be what was used as input. For example, if ALPHA was provided as input in the parent resource, but only BETA and GA-level features are were, this field will be BETA. | | `conditions` | `array` | Output only. The Condition of this Revision, containing its readiness status, and detailed error information in case it did not reach a serving state. | +| `createTime` | `string` | Output only. The creation time. | | `encryptionKey` | `string` | A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek | +| `vpcAccess` | `object` | VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Service.reconciling` for additional information on reconciliation process in Cloud Run. | +| `encryptionKeyShutdownDuration` | `string` | If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. | +| `timeout` | `string` | Max allowed time for an instance to respond to a request. | +| `maxInstanceRequestConcurrency` | `integer` | Sets the maximum number of requests that each serving instance can receive. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/services/index.md b/docs/google-docs/providers/google/run/services/index.md index 82c4c9b907..e1307f2060 100644 --- a/docs/google-docs/providers/google/run/services/index.md +++ b/docs/google-docs/providers/google/run/services/index.md @@ -29,34 +29,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The fully qualified name of this Service. In CreateServiceRequest, this field is ignored, and instead composed from CreateServiceRequest.parent and CreateServiceRequest.service_id. Format: projects/{project}/locations/{location}/services/{service_id} | | `description` | `string` | User-provided description of the Service. This field currently has a 512-character limit. | -| `ingress` | `string` | Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `reconciling` | `boolean` | Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. | -| `client` | `string` | Arbitrary identifier for the API client. | -| `latestReadyRevision` | `string` | Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | -| `clientVersion` | `string` | Arbitrary version identifier for the API client. | -| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | | `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. | +| `client` | `string` | Arbitrary identifier for the API client. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `template` | `object` | RevisionTemplate describes the data a revision should have when created from a template. | | `conditions` | `array` | Output only. The Conditions of all other associated sub-resources. They contain additional diagnostics information in case the Service does not reach its Serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `uid` | `string` | Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | +| `deleteTime` | `string` | Output only. The deletion time. | | `latestCreatedRevision` | `string` | Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `clientVersion` | `string` | Arbitrary version identifier for the API client. | +| `createTime` | `string` | Output only. The creation time. | +| `observedGeneration` | `string` | Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. | +| `labels` | `object` | Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. | +| `uri` | `string` | Output only. The main URI in which this Service is serving traffic. | +| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | +| `creator` | `string` | Output only. Email address of the authenticated creator. | +| `reconciling` | `boolean` | Output only. Returns true if the Service is currently being acted upon by the system to bring it into the desired state. When a new Service is created, or an existing one is updated, Cloud Run will asynchronously perform all necessary steps to bring the Service to the desired serving state. This process is called reconciliation. While reconciliation is in process, `observed_generation`, `latest_ready_revison`, `traffic_statuses`, and `uri` will have transient values that might mismatch the intended state: Once reconciliation is over (and this field is false), there are two possible outcomes: reconciliation succeeded and the serving state matches the Service, or there was an error, and reconciliation failed. This state can be found in `terminal_condition.state`. If reconciliation succeeded, the following fields will match: `traffic` and `traffic_statuses`, `observed_generation` and `generation`, `latest_ready_revision` and `latest_created_revision`. If reconciliation failed, `traffic_statuses`, `observed_generation`, and `latest_ready_revision` will have the state of the last serving revision, or empty for newly created Services. Additional information on the failure can be found in `terminal_condition` and `conditions`. | | `traffic` | `array` | Specifies how to distribute traffic over a collection of Revisions belonging to the Service. If traffic is empty or not provided, defaults to 100% traffic to the latest `Ready` Revision. | +| `ingress` | `string` | Provides the ingress settings for this Service. On output, returns the currently observed ingress settings, or INGRESS_TRAFFIC_UNSPECIFIED if no revision is active. | +| `annotations` | `object` | Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. | | `customAudiences` | `array` | One or more custom audiences that you want this service to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. | | `launchStage` | `string` | The launch stage as defined by [Google Cloud Platform Launch Stages](https://cloud.google.com/terms/launch-stages). Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA is assumed. Set the launch stage to a preview stage on input to allow use of preview features in that stage. On read (or output), describes whether the resource uses preview features. For example, if ALPHA is provided as input, but only BETA and GA-level features are used, this field will be BETA on output. | -| `annotations` | `object` | Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. Cloud Run API v2 does not support annotations with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected in new resources. All system annotations in v1 now have a corresponding field in v2 Service. This field follows Kubernetes annotations' namespacing, limits, and rules. | -| `uid` | `string` | Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | | `updateTime` | `string` | Output only. The last-modified time. | -| `observedGeneration` | `string` | Output only. The generation of this Service currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. | -| `template` | `object` | RevisionTemplate describes the data a revision should have when created from a template. | | `terminalCondition` | `object` | Defines a status condition for a resource. | -| `creator` | `string` | Output only. Email address of the authenticated creator. | -| `trafficStatuses` | `array` | Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `deleteTime` | `string` | Output only. The deletion time. | -| `createTime` | `string` | Output only. The creation time. | +| `latestReadyRevision` | `string` | Output only. Name of the latest revision that is serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | | `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. Please note that unlike v1, this is an int64 value. As with most Google APIs, its JSON representation will be a `string` instead of an `integer`. | -| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | -| `uri` | `string` | Output only. The main URI in which this Service is serving traffic. | -| `labels` | `object` | Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 Service. | +| `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | +| `trafficStatuses` | `array` | Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/services_iam_audit_configs/index.md b/docs/google-docs/providers/google/run/services_iam_audit_configs/index.md deleted file mode 100644 index ac86d5de32..0000000000 --- a/docs/google-docs/providers/google/run/services_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: services_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - services_iam_audit_configs - - run - - 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 ---- - - - -## Overview - - - - -
Nameservices_iam_audit_configs
TypeResource
Idgoogle.run.services_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_services_getIamPolicy` | `SELECT` | `locationsId, projectsId, servicesId` | diff --git a/docs/google-docs/providers/google/run/services_iam_bindings/index.md b/docs/google-docs/providers/google/run/services_iam_bindings/index.md deleted file mode 100644 index d5f9139c23..0000000000 --- a/docs/google-docs/providers/google/run/services_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - services_iam_bindings - - run - - 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 ---- - - - -## Overview - - - - -
Nameservices_iam_bindings
TypeResource
Idgoogle.run.services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_services_getIamPolicy` | `SELECT` | `locationsId, projectsId, servicesId` | diff --git a/docs/google-docs/providers/google/run/services_iam_policies/index.md b/docs/google-docs/providers/google/run/services_iam_policies/index.md index 04cedc401e..90b88dc0a6 100644 --- a/docs/google-docs/providers/google/run/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/run/services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/tasks/index.md b/docs/google-docs/providers/google/run/tasks/index.md index e85bb9b99e..d9cb243884 100644 --- a/docs/google-docs/providers/google/run/tasks/index.md +++ b/docs/google-docs/providers/google/run/tasks/index.md @@ -28,35 +28,35 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique name of this Task. | -| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | -| `vpcAccess` | `object` | VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc | -| `createTime` | `string` | Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. | -| `observedGeneration` | `string` | Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | -| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | -| `execution` | `string` | Output only. The name of the parent Execution. | -| `maxRetries` | `integer` | Number of retries allowed per Task, before marking this Task failed. | -| `retried` | `integer` | Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit. | | `updateTime` | `string` | Output only. The last-modified time. | -| `timeout` | `string` | Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. | -| `job` | `string` | Output only. The name of the parent Job. | -| `completionTime` | `string` | Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations. | -| `lastAttemptResult` | `object` | Result of a task attempt. | -| `encryptionKey` | `string` | Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek | -| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | | `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `volumes` | `array` | A list of Volumes to make available to containers. | -| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | -| `startTime` | `string` | Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations. | -| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels | -| `executionEnvironment` | `string` | The execution environment being used to host this Task. | | `uid` | `string` | Output only. Server assigned unique identifier for the Task. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. | -| `serviceAccount` | `string` | Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. | | `annotations` | `object` | Output only. Unstructured key value map that may be set by external tools to store and arbitrary metadata. They are not queryable and should be preserved when modifying objects. | +| `startTime` | `string` | Output only. Represents time when the task started to run. It is not guaranteed to be set in happens-before order across separate operations. | +| `job` | `string` | Output only. The name of the parent Job. | +| `retried` | `integer` | Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit. | +| `vpcAccess` | `object` | VPC Access settings. For more information on creating a VPC Connector, visit https://cloud.google.com/vpc/docs/configure-serverless-vpc-access For information on how to configure Cloud Run with an existing VPC Connector, visit https://cloud.google.com/run/docs/configuring/connecting-vpc | | `containers` | `array` | Holds the single container that defines the unit of execution for this task. | -| `conditions` | `array` | Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state. | -| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | | `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | +| `lastAttemptResult` | `object` | Result of a task attempt. | +| `completionTime` | `string` | Output only. Represents time when the Task was completed. It is not guaranteed to be set in happens-before order across separate operations. | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. It is only populated as a response to a Delete request. | +| `observedGeneration` | `string` | Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | +| `executionEnvironment` | `string` | The execution environment being used to host this Task. | +| `createTime` | `string` | Output only. Represents time when the task was created by the job controller. It is not guaranteed to be set in happens-before order across separate operations. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | +| `conditions` | `array` | Output only. The Condition of this Task, containing its readiness status, and detailed error information in case it did not reach the desired state. | | `index` | `integer` | Output only. Index of the Task, unique per execution, and beginning at 0. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `execution` | `string` | Output only. The name of the parent Execution. | +| `volumes` | `array` | A list of Volumes to make available to containers. | +| `labels` | `object` | Output only. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels | +| `maxRetries` | `integer` | Number of retries allowed per Task, before marking this Task failed. | +| `encryptionKey` | `string` | Output only. A reference to a customer managed encryption key (CMEK) to use to encrypt this container image. For more information, go to https://cloud.google.com/run/docs/securing/using-cmek | +| `serviceAccount` | `string` | Email address of the IAM service account associated with the Task of a Job. The service account represents the identity of the running task, and determines what permissions the task has. If not provided, the task will use the project's default service account. | +| `reconciling` | `boolean` | Output only. Indicates whether the resource's reconciliation is still in progress. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | +| `timeout` | `string` | Max allowed time duration the Task may be active before the system will actively try to mark it failed and kill associated containers. This applies per attempt of a task, meaning each retry can run for the full timeout. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/runtimeconfig/operations/index.md b/docs/google-docs/providers/google/runtimeconfig/operations/index.md index 3593e926a1..305a7dc0dc 100644 --- a/docs/google-docs/providers/google/runtimeconfig/operations/index.md +++ b/docs/google-docs/providers/google/runtimeconfig/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `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. | | `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sasportal/customer_node/index.md b/docs/google-docs/providers/google/sasportal/customer_node/index.md index 0581d630ab..3e411ba9e9 100644 --- a/docs/google-docs/providers/google/sasportal/customer_node/index.md +++ b/docs/google-docs/providers/google/sasportal/customer_node/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | -| `sasUserIds` | `array` | User ids used by the devices belonging to this node. | | `displayName` | `string` | The node's display name. | +| `sasUserIds` | `array` | User ids used by the devices belonging to this node. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sasportal/customer_nodes/index.md b/docs/google-docs/providers/google/sasportal/customer_nodes/index.md index 335b231a9d..a57104b85c 100644 --- a/docs/google-docs/providers/google/sasportal/customer_nodes/index.md +++ b/docs/google-docs/providers/google/sasportal/customer_nodes/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | -| `displayName` | `string` | The node's display name. | | `sasUserIds` | `array` | User ids used by the devices belonging to this node. | +| `displayName` | `string` | The node's display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sasportal/deployments/index.md b/docs/google-docs/providers/google/sasportal/deployments/index.md index fef51077f0..1457442c8b 100644 --- a/docs/google-docs/providers/google/sasportal/deployments/index.md +++ b/docs/google-docs/providers/google/sasportal/deployments/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name. | +| `displayName` | `string` | The deployment's display name. | | `frns` | `array` | Output only. The FCC Registration Numbers (FRNs) copied from its direct parent. | | `sasUserIds` | `array` | User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. | -| `displayName` | `string` | The deployment's display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sasportal/devices/index.md b/docs/google-docs/providers/google/sasportal/devices/index.md index aa94155b8f..a7474cd2f1 100644 --- a/docs/google-docs/providers/google/sasportal/devices/index.md +++ b/docs/google-docs/providers/google/sasportal/devices/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource path name. | -| `state` | `string` | Output only. Device state. | -| `displayName` | `string` | Device display name. | -| `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | +| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | | `preloadedConfig` | `object` | Information about the device configuration. | +| `fccId` | `string` | The FCC identifier of the device. | +| `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | +| `activeConfig` | `object` | Information about the device configuration. | +| `displayName` | `string` | Device display name. | | `grants` | `array` | Output only. Grants held by the device. | -| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | +| `state` | `string` | Output only. Device state. | | `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | -| `activeConfig` | `object` | Information about the device configuration. | | `currentChannels` | `array` | Output only. Current channels with scores. | -| `fccId` | `string` | The FCC identifier of the device. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/secretmanager/locations/index.md b/docs/google-docs/providers/google/secretmanager/locations/index.md index 46661e4a61..2a3d9b41a8 100644 --- a/docs/google-docs/providers/google/secretmanager/locations/index.md +++ b/docs/google-docs/providers/google/secretmanager/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/secretmanager/secrets/index.md b/docs/google-docs/providers/google/secretmanager/secrets/index.md index 455aad4aaf..d4a3a2d794 100644 --- a/docs/google-docs/providers/google/secretmanager/secrets/index.md +++ b/docs/google-docs/providers/google/secretmanager/secrets/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the Secret in the format `projects/*/secrets/*`. | -| `rotation` | `object` | The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. | -| `labels` | `object` | The labels assigned to this Secret. 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 0 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 assigned to a given resource. | -| `ttl` | `string` | Input only. The TTL for the Secret. | | `etag` | `string` | Optional. Etag of the currently stored Secret. | +| `annotations` | `object` | Optional. Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB. | +| `labels` | `object` | The labels assigned to this Secret. 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 0 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 assigned to a given resource. | | `versionAliases` | `object` | Optional. Mapping from version alias to version name. A version alias is a string with a maximum length of 63 characters and can contain uppercase and lowercase letters, numerals, and the hyphen (`-`) and underscore ('_') characters. An alias string must start with a letter and cannot be the string 'latest' or 'NEW'. No more than 50 aliases can be assigned to a given secret. Version-Alias pairs will be viewable via GetSecret and modifiable via UpdateSecret. At launch Access by Allias will only be supported on GetSecretVersion and AccessSecretVersion. | | `expireTime` | `string` | Optional. Timestamp in UTC when the Secret is scheduled to expire. This is always provided on output, regardless of what was sent on input. | -| `annotations` | `object` | Optional. Custom metadata about the secret. Annotations are distinct from various forms of labels. Annotations exist to allow client tools to store their own state information without requiring a database. Annotation keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, begin and end with an alphanumeric character ([a-z0-9A-Z]), and may have dashes (-), underscores (_), dots (.), and alphanumerics in between these symbols. The total size of annotation keys and values must be less than 16KiB. | +| `createTime` | `string` | Output only. The time at which the Secret was created. | +| `rotation` | `object` | The rotation time and period for a Secret. At next_rotation_time, Secret Manager will send a Pub/Sub notification to the topics configured on the Secret. Secret.topics must be set to configure rotation. | | `replication` | `object` | A policy that defines the replication and encryption configuration of data. | | `topics` | `array` | Optional. A list of up to 10 Pub/Sub topics to which messages are published when control plane operations are called on the secret or its versions. | -| `createTime` | `string` | Output only. The time at which the Secret was created. | +| `ttl` | `string` | Input only. The TTL for the Secret. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/secretmanager/secrets_iam_audit_configs/index.md b/docs/google-docs/providers/google/secretmanager/secrets_iam_audit_configs/index.md deleted file mode 100644 index b33452b903..0000000000 --- a/docs/google-docs/providers/google/secretmanager/secrets_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: secrets_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - secrets_iam_audit_configs - - secretmanager - - 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 ---- - - - -## Overview - - - - -
Namesecrets_iam_audit_configs
TypeResource
Idgoogle.secretmanager.secrets_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_secrets_getIamPolicy` | `SELECT` | `projectsId, secretsId` | diff --git a/docs/google-docs/providers/google/secretmanager/secrets_iam_bindings/index.md b/docs/google-docs/providers/google/secretmanager/secrets_iam_bindings/index.md deleted file mode 100644 index 7f2e484941..0000000000 --- a/docs/google-docs/providers/google/secretmanager/secrets_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: secrets_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - secrets_iam_bindings - - secretmanager - - 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 ---- - - - -## Overview - - - - -
Namesecrets_iam_bindings
TypeResource
Idgoogle.secretmanager.secrets_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_secrets_getIamPolicy` | `SELECT` | `projectsId, secretsId` | diff --git a/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md b/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md index 4f564c4b18..4acf32ef6d 100644 --- a/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md +++ b/docs/google-docs/providers/google/secretmanager/secrets_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/secretmanager/versions/index.md b/docs/google-docs/providers/google/secretmanager/versions/index.md index f28b170eaa..1481225998 100644 --- a/docs/google-docs/providers/google/secretmanager/versions/index.md +++ b/docs/google-docs/providers/google/secretmanager/versions/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. | +| `createTime` | `string` | Output only. The time at which the SecretVersion was created. | +| `destroyTime` | `string` | Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. | | `etag` | `string` | Output only. Etag of the currently stored SecretVersion. | | `replicationStatus` | `object` | The replication status of a SecretVersion. | | `state` | `string` | Output only. The current state of the SecretVersion. | | `clientSpecifiedPayloadChecksum` | `boolean` | Output only. True if payload checksum specified in SecretPayload object has been received by SecretManagerService on SecretManagerService.AddSecretVersion. | -| `createTime` | `string` | Output only. The time at which the SecretVersion was created. | -| `destroyTime` | `string` | Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md b/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md index ed55132eb2..41d469255c 100644 --- a/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md +++ b/docs/google-docs/providers/google/securitycenter/big_query_exports/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: "organizations/{organization_id}/bigQueryExports/{export_id}" Example format: "folders/{folder_id}/bigQueryExports/{export_id}" Example format: "projects/{project_id}/bigQueryExports/{export_id}" This field is provided in responses, and is ignored when provided in create requests. | | `description` | `string` | The description of the export (max of 1024 characters). | -| `principal` | `string` | Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. | | `updateTime` | `string` | Output only. The most recent time at which the BigQuery export was updated. This field is set by the server and will be ignored if provided on export creation or update. | | `createTime` | `string` | Output only. The time at which the BigQuery export was created. This field is set by the server and will be ignored if provided on export on creation. | | `dataset` | `string` | The dataset to write findings' updates to. Its format is "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). | | `filter` | `string` | Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. | | `mostRecentEditor` | `string` | Output only. Email address of the user who last edited the BigQuery export. This field is set by the server and will be ignored if provided on export creation or update. | +| `principal` | `string` | Output only. The service account that needs permission to create table and upload data to the BigQuery dataset. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md b/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md index baa19411cc..274fb4478b 100644 --- a/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md +++ b/docs/google-docs/providers/google/securitycenter/custom_modules_descendant/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. | -| `displayName` | `string` | The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. | | `enablementState` | `string` | The enablement state of the custom module. | | `lastEditor` | `string` | Output only. The editor that last updated the custom module. | | `updateTime` | `string` | Output only. The time at which the custom module was last updated. | | `ancestorModule` | `string` | Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. | | `customConfig` | `object` | Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. | +| `displayName` | `string` | The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md b/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md index 94b680f1e5..56166c16eb 100644 --- a/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md +++ b/docs/google-docs/providers/google/securitycenter/event_threat_detection_modules/index.md @@ -29,12 +29,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". | | `description` | `string` | The description for the module. | +| `enablementState` | `string` | The state of enablement for the module at the given level of the hierarchy. | +| `lastEditor` | `string` | Output only. The editor the module was last updated by. | | `type` | `string` | Type for the module. e.g. CONFIGURABLE_BAD_IP. | | `updateTime` | `string` | Output only. The time the module was last updated. | | `config` | `object` | Config for the module. For the resident module, its config value is defined at this level. For the inherited module, its config value is inherited from the ancestor module. | | `displayName` | `string` | The human readable name to be displayed for the module. | -| `enablementState` | `string` | The state of enablement for the module at the given level of the hierarchy. | -| `lastEditor` | `string` | Output only. The editor the module was last updated by. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/findings/index.md b/docs/google-docs/providers/google/securitycenter/findings/index.md index 385b83b224..5985f89108 100644 --- a/docs/google-docs/providers/google/securitycenter/findings/index.md +++ b/docs/google-docs/providers/google/securitycenter/findings/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `finding` | `object` | Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. | | `resource` | `object` | Information related to the Google Cloud resource that is associated with this finding. | | `stateChange` | `string` | State change of the finding between the points in time. | +| `finding` | `object` | Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/mute_configs/index.md b/docs/google-docs/providers/google/securitycenter/mute_configs/index.md index 8b5227eafa..1147ab3306 100644 --- a/docs/google-docs/providers/google/securitycenter/mute_configs/index.md +++ b/docs/google-docs/providers/google/securitycenter/mute_configs/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | This field will be ignored if provided on config creation. Format "organizations/{organization}/muteConfigs/{mute_config}" "folders/{folder}/muteConfigs/{mute_config}" "projects/{project}/muteConfigs/{mute_config}" | | `description` | `string` | A description of the mute config. | +| `mostRecentEditor` | `string` | Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. | | `updateTime` | `string` | Output only. The most recent time at which the mute config was updated. This field is set by the server and will be ignored if provided on config creation or update. | | `createTime` | `string` | Output only. The time at which the mute config was created. This field is set by the server and will be ignored if provided on config creation. | | `displayName` | `string` | The human readable name to be displayed for the mute config. | | `filter` | `string` | Required. An expression that defines the filter to apply across create/update events of findings. While creating a filter string, be mindful of the scope in which the mute configuration is being created. E.g., If a filter contains project = X but is created under the project = Y scope, it might not match any findings. The following field and operator combinations are supported: * severity: `=`, `:` * category: `=`, `:` * resource.name: `=`, `:` * resource.project_name: `=`, `:` * resource.project_display_name: `=`, `:` * resource.folders.resource_folder: `=`, `:` * resource.parent_name: `=`, `:` * resource.parent_display_name: `=`, `:` * resource.type: `=`, `:` * finding_class: `=`, `:` * indicator.ip_addresses: `=`, `:` * indicator.domains: `=`, `:` | -| `mostRecentEditor` | `string` | Output only. Email address of the user who last edited the mute config. This field is set by the server and will be ignored if provided on config creation or update. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/notification_configs/index.md b/docs/google-docs/providers/google/securitycenter/notification_configs/index.md index 71851aa2dd..fe820b04f2 100644 --- a/docs/google-docs/providers/google/securitycenter/notification_configs/index.md +++ b/docs/google-docs/providers/google/securitycenter/notification_configs/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket". | | `description` | `string` | The description of the notification config (max of 1024 characters). | -| `streamingConfig` | `object` | The config for streaming-based notifications, which send each event as soon as it is detected. | | `pubsubTopic` | `string` | The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". | | `serviceAccount` | `string` | Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic. | +| `streamingConfig` | `object` | The config for streaming-based notifications, which send each event as soon as it is detected. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/operations/index.md b/docs/google-docs/providers/google/securitycenter/operations/index.md index 9e59856ca4..5e215150db 100644 --- a/docs/google-docs/providers/google/securitycenter/operations/index.md +++ b/docs/google-docs/providers/google/securitycenter/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/organizations/index.md b/docs/google-docs/providers/google/securitycenter/organizations/index.md deleted file mode 100644 index 24f411577b..0000000000 --- a/docs/google-docs/providers/google/securitycenter/organizations/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: organizations -hide_title: false -hide_table_of_contents: false -keywords: - - organizations - - securitycenter - - 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 ---- - - - -## Overview - - - - -
Nameorganizations
TypeResource
Idgoogle.securitycenter.organizations
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateOrganizationSettings` | `EXEC` | `organizationsId` | diff --git a/docs/google-docs/providers/google/securitycenter/organizations_organization_settings/index.md b/docs/google-docs/providers/google/securitycenter/organizations_organization_settings/index.md deleted file mode 100644 index 3fe145f4c3..0000000000 --- a/docs/google-docs/providers/google/securitycenter/organizations_organization_settings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: organizations_organization_settings -hide_title: false -hide_table_of_contents: false -keywords: - - organizations_organization_settings - - securitycenter - - 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 ---- - - - -## Overview - - - - -
Nameorganizations_organization_settings
TypeResource
Idgoogle.securitycenter.organizations_organization_settings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The relative resource name of the settings. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/organizationSettings". | -| `assetDiscoveryConfig` | `object` | The configuration used for Asset Discovery runs. | -| `enableAssetDiscovery` | `boolean` | A flag that indicates if Asset Discovery should be enabled. If the flag is set to `true`, then discovery of assets will occur. If it is set to `false, all historical assets will remain, but discovery of future assets will not occur. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_getOrganizationSettings` | `SELECT` | `organizationsId` | diff --git a/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md b/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md index 35320af893..1cb56bd0c5 100644 --- a/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md +++ b/docs/google-docs/providers/google/securitycenter/resource_value_configs/index.md @@ -29,13 +29,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Name for the resource value config | | `description` | `string` | Description of the resource value config. | -| `tagValues` | `array` | Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing | -| `createTime` | `string` | Output only. Timestamp this resource value config was created. | | `resourceLabelsSelector` | `object` | List of resource labels to search for, evaluated with AND. E.g. "resource_labels_selector": {"key": "value", "env": "prod"} will match resources with labels "key": "value" AND "env": "prod" https://cloud.google.com/resource-manager/docs/creating-managing-labels | +| `updateTime` | `string` | Output only. Timestamp this resource value config was last updated. | | `resourceValue` | `string` | Required. Resource value level this expression represents | | `scope` | `string` | Project or folder to scope this config to. For example, "project/456" would apply this config only to resources in "project/456" scope will be checked with "AND" of other resources. | -| `updateTime` | `string` | Output only. Timestamp this resource value config was last updated. | | `resourceType` | `string` | Apply resource_value only to resources that match resource_type. resource_type will be checked with "AND" of other resources. E.g. "storage.googleapis.com/Bucket" with resource_value "HIGH" will apply "HIGH" value only to "storage.googleapis.com/Bucket" resources. | +| `createTime` | `string` | Output only. Timestamp this resource value config was created. | +| `tagValues` | `array` | Required. Tag values combined with AND to check against. Values in the form "tagValues/123" E.g. [ "tagValues/123", "tagValues/456", "tagValues/789" ] https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md b/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md index acfd2aea75..e05374ccbb 100644 --- a/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md +++ b/docs/google-docs/providers/google/securitycenter/security_health_analytics_modules/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of the custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/customModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/customModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/customModules/{customModule}" The id {customModule} is server-generated and is not user settable. It will be a numeric id containing 1-20 digits. | -| `ancestorModule` | `string` | Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. | -| `customConfig` | `object` | Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. | -| `displayName` | `string` | The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. | | `enablementState` | `string` | The enablement state of the custom module. | | `lastEditor` | `string` | Output only. The editor that last updated the custom module. | | `updateTime` | `string` | Output only. The time at which the custom module was last updated. | +| `ancestorModule` | `string` | Output only. If empty, indicates that the custom module was created in the organization, folder, or project in which you are viewing the custom module. Otherwise, `ancestor_module` specifies the organization or folder from which the custom module is inherited. | +| `customConfig` | `object` | Defines the properties in a custom module configuration for Security Health Analytics. Use the custom module configuration to create custom detectors that generate custom findings for resources that you specify. | +| `displayName` | `string` | The display name of the Security Health Analytics custom module. This display name becomes the finding category for all findings that are returned by this custom module. The display name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/simulations/index.md b/docs/google-docs/providers/google/securitycenter/simulations/index.md index 9f1ae1fbde..bd60a2ab45 100644 --- a/docs/google-docs/providers/google/securitycenter/simulations/index.md +++ b/docs/google-docs/providers/google/securitycenter/simulations/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full resource name of the Simulation: organizations/123/simulations/456 | -| `resourceValueConfigsMetadata` | `array` | Resource value configurations' metadata used in this simulation. Maximum of 100. | | `createTime` | `string` | Output only. Time simulation was created | +| `resourceValueConfigsMetadata` | `array` | Resource value configurations' metadata used in this simulation. Maximum of 100. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/securitycenter/sources/index.md b/docs/google-docs/providers/google/securitycenter/sources/index.md index 2ab8d536ad..3064d05feb 100644 --- a/docs/google-docs/providers/google/securitycenter/sources/index.md +++ b/docs/google-docs/providers/google/securitycenter/sources/index.md @@ -29,8 +29,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The relative resource name of this source. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/sources/{source_id}" | | `description` | `string` | The description of the source (max of 1024 characters). Example: "Web Security Scanner is a web security scanner for common vulnerabilities in App Engine applications. It can automatically scan and detect four common vulnerabilities, including cross-site-scripting (XSS), Flash injection, mixed content (HTTP in HTTPS), and outdated or insecure libraries." | -| `canonicalName` | `string` | The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}" or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. | | `displayName` | `string` | The source's display name. A source's display name must be unique amongst its siblings, for example, two sources with the same parent can't share the same display name. The display name must have a length between 1 and 64 characters (inclusive). | +| `canonicalName` | `string` | The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}", "folders/{folder_id}/sources/{source_id}" or "projects/{project_number}/sources/{source_id}", depending on the closest CRM ancestor of the resource associated with the finding. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/sources_iam_audit_configs/index.md b/docs/google-docs/providers/google/securitycenter/sources_iam_audit_configs/index.md deleted file mode 100644 index 1621636e4d..0000000000 --- a/docs/google-docs/providers/google/securitycenter/sources_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: sources_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - sources_iam_audit_configs - - securitycenter - - 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 ---- - - - -## Overview - - - - -
Namesources_iam_audit_configs
TypeResource
Idgoogle.securitycenter.sources_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_sources_getIamPolicy` | `SELECT` | `organizationsId, sourcesId` | diff --git a/docs/google-docs/providers/google/securitycenter/sources_iam_bindings/index.md b/docs/google-docs/providers/google/securitycenter/sources_iam_bindings/index.md deleted file mode 100644 index 425c22a8d7..0000000000 --- a/docs/google-docs/providers/google/securitycenter/sources_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: sources_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - sources_iam_bindings - - securitycenter - - 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 ---- - - - -## Overview - - - - -
Namesources_iam_bindings
TypeResource
Idgoogle.securitycenter.sources_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `organizations_sources_getIamPolicy` | `SELECT` | `organizationsId, sourcesId` | diff --git a/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md b/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md index b4f3a2fca3..da93f66cd2 100644 --- a/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md +++ b/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/valued_resources/index.md b/docs/google-docs/providers/google/securitycenter/valued_resources/index.md index 576dd8665c..1ab5655d54 100644 --- a/docs/google-docs/providers/google/securitycenter/valued_resources/index.md +++ b/docs/google-docs/providers/google/securitycenter/valued_resources/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Valued resource name, for example, e.g.: `organizations/123/simulations/456/valuedResources/789` | +| `resource` | `string` | The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource. | +| `resourceType` | `string` | The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource. | | `resourceValue` | `string` | How valuable this resource is. | | `resourceValueConfigsUsed` | `array` | List of resource value configurations' metadata used to determine the value of this resource. Maximum of 100. | | `displayName` | `string` | Human-readable name of the valued resource. | | `exposedScore` | `number` | Exposed score for this valued resource. A value of 0 means no exposure was detected exposure. | -| `resource` | `string` | The [full resource name](https://cloud.google.com/apis/design/resource_names#full_resource_name) of the valued resource. | -| `resourceType` | `string` | The [resource type](https://cloud.google.com/asset-inventory/docs/supported-asset-types) of the valued resource. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md index 69baf0e54e..c20aa72f09 100644 --- a/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md +++ b/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md index 9eb2c5da6a..2266193c27 100644 --- a/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md +++ b/docs/google-docs/providers/google/serviceconsumermanagement/tenancy_units/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Globally unique identifier of this tenancy unit "services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}" | -| `createTime` | `string` | Output only. @OutputOnly The time this tenancy unit was created. | -| `service` | `string` | Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. | | `tenantResources` | `array` | Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. | | `consumer` | `string` | Output only. @OutputOnly Cloud resource name of the consumer of this service. For example 'projects/123456'. | +| `createTime` | `string` | Output only. @OutputOnly The time this tenancy unit was created. | +| `service` | `string` | Output only. Google Cloud API name of the managed service owning this tenancy unit. For example 'serviceconsumermanagement.googleapis.com'. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicedirectory/endpoints/index.md b/docs/google-docs/providers/google/servicedirectory/endpoints/index.md index 9fe328638f..72edb6f79b 100644 --- a/docs/google-docs/providers/google/servicedirectory/endpoints/index.md +++ b/docs/google-docs/providers/google/servicedirectory/endpoints/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name for the endpoint in the format `projects/*/locations/*/namespaces/*/services/*/endpoints/*`. | -| `network` | `string` | Immutable. The Google Compute Engine network (VPC) of the endpoint in the format `projects//locations/global/networks/*`. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified. | -| `port` | `integer` | Optional. Service Directory rejects values outside of `[0, 65535]`. | | `uid` | `string` | Output only. The globally unique identifier of the endpoint in the UUID4 format. | | `address` | `string` | Optional. An IPv4 or IPv6 address. Service Directory rejects bad addresses like: * `8.8.8` * `8.8.8.8:53` * `test:bad:address` * `[::1]` * `[::1]:8080` Limited to 45 characters. | | `annotations` | `object` | Optional. Annotations for the endpoint. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 512 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/) Annotations that fails to meet these requirements are rejected. Note: This field is equivalent to the `metadata` field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory. | +| `network` | `string` | Immutable. The Google Compute Engine network (VPC) of the endpoint in the format `projects//locations/global/networks/*`. The project must be specified by project number (project id is rejected). Incorrectly formatted networks are rejected, we also check to make sure that you have the servicedirectory.networks.attach permission on the project specified. | +| `port` | `integer` | Optional. Service Directory rejects values outside of `[0, 65535]`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicedirectory/namespaces_iam_bindings/index.md b/docs/google-docs/providers/google/servicedirectory/namespaces_iam_bindings/index.md deleted file mode 100644 index 8a13311439..0000000000 --- a/docs/google-docs/providers/google/servicedirectory/namespaces_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: namespaces_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - namespaces_iam_bindings - - servicedirectory - - 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 ---- - - - -## Overview - - - - -
Namenamespaces_iam_bindings
TypeResource
Idgoogle.servicedirectory.namespaces_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_namespaces_getIamPolicy` | `SELECT` | `locationsId, namespacesId, projectsId` | diff --git a/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md b/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md index 69c777b96b..741ec4b319 100644 --- a/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicedirectory/namespaces_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicedirectory/services/index.md b/docs/google-docs/providers/google/servicedirectory/services/index.md index 1b70777e27..6a5ba40c5e 100644 --- a/docs/google-docs/providers/google/servicedirectory/services/index.md +++ b/docs/google-docs/providers/google/servicedirectory/services/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name for the service in the format `projects/*/locations/*/namespaces/*/services/*`. | +| `endpoints` | `array` | Output only. Endpoints associated with this service. Returned on LookupService.ResolveService. Control plane clients should use RegistrationService.ListEndpoints. | | `uid` | `string` | Output only. The globally unique identifier of the service in the UUID4 format. | | `annotations` | `object` | Optional. Annotations for the service. This data can be consumed by service clients. Restrictions: * The entire annotations dictionary may contain up to 2000 characters, spread accoss all key-value pairs. Annotations that go beyond this limit are rejected * Valid annotation keys have two segments: an optional prefix and name, separated by a slash (/). The name segment is required and must be 63 characters or less, beginning and ending with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. The prefix is optional. If specified, the prefix must be a DNS subdomain: a series of DNS labels separated by dots (.), not longer than 253 characters in total, followed by a slash (/). Annotations that fails to meet these requirements are rejected Note: This field is equivalent to the `metadata` field in the v1beta1 API. They have the same syntax and read/write to the same location in Service Directory. | -| `endpoints` | `array` | Output only. Endpoints associated with this service. Returned on LookupService.ResolveService. Control plane clients should use RegistrationService.ListEndpoints. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicedirectory/services_iam_bindings/index.md b/docs/google-docs/providers/google/servicedirectory/services_iam_bindings/index.md deleted file mode 100644 index 1d75bb18a5..0000000000 --- a/docs/google-docs/providers/google/servicedirectory/services_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - services_iam_bindings - - servicedirectory - - 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 ---- - - - -## Overview - - - - -
Nameservices_iam_bindings
TypeResource
Idgoogle.servicedirectory.services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_namespaces_services_getIamPolicy` | `SELECT` | `locationsId, namespacesId, projectsId, servicesId` | diff --git a/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md b/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md index ade95c5732..837716b46b 100644 --- a/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicedirectory/services_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicemanagement/configs/index.md b/docs/google-docs/providers/google/servicemanagement/configs/index.md index d5ebccdb30..49a2d4921c 100644 --- a/docs/google-docs/providers/google/servicemanagement/configs/index.md +++ b/docs/google-docs/providers/google/servicemanagement/configs/index.md @@ -29,32 +29,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead. | | `name` | `string` | The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. | -| `usage` | `object` | Configuration controlling usage of a service. | -| `logs` | `array` | Defines the logs used by this service. | -| `monitoring` | `object` | Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue | +| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | | `backend` | `object` | `Backend` defines the backend configuration for a service. | -| `publishing` | `object` | This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config. | -| `billing` | `object` | Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: \| Predefined label to support billing location restriction. - key: city description: \| Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count | -| `types` | `array` | A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 | -| `endpoints` | `array` | Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. | | `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | -| `quota` | `object` | Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 | | `http` | `object` | Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. | -| `systemParameters` | `object` | ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. | +| `systemTypes` | `array` | A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. | +| `logs` | `array` | Defines the logs used by this service. | | `producerProjectId` | `string` | The Google project that owns this service. | +| `metrics` | `array` | Defines the metrics used by this service. | +| `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | | `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | -| `authentication` | `object` | `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read | -| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | -| `logging` | `object` | Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history | -| `apis` | `array` | A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. | | `enums` | `array` | A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum | -| `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | -| `metrics` | `array` | Defines the metrics used by this service. | -| `documentation` | `object` | `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. | -| `customError` | `object` | Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError | +| `types` | `array` | A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 | | `sourceInfo` | `object` | Source information used to create a Service Config | +| `customError` | `object` | Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError | +| `authentication` | `object` | `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read | | `context` | `object` | `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. | -| `systemTypes` | `array` | A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. | +| `quota` | `object` | Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 | +| `publishing` | `object` | This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config. | +| `endpoints` | `array` | Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. | +| `apis` | `array` | A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. | +| `logging` | `object` | Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history | +| `billing` | `object` | Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: \| Predefined label to support billing location restriction. - key: city description: \| Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count | +| `systemParameters` | `object` | ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. | +| `monitoring` | `object` | Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue | +| `usage` | `object` | Configuration controlling usage of a service. | +| `documentation` | `object` | `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicemanagement/consumers_iam_audit_configs/index.md b/docs/google-docs/providers/google/servicemanagement/consumers_iam_audit_configs/index.md deleted file mode 100644 index 5c04c3dcf4..0000000000 --- a/docs/google-docs/providers/google/servicemanagement/consumers_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: consumers_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - consumers_iam_audit_configs - - servicemanagement - - 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 ---- - - - -## Overview - - - - -
Nameconsumers_iam_audit_configs
TypeResource
Idgoogle.servicemanagement.consumers_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `services_consumers_getIamPolicy` | `SELECT` | `consumersId, servicesId` | diff --git a/docs/google-docs/providers/google/servicemanagement/consumers_iam_bindings/index.md b/docs/google-docs/providers/google/servicemanagement/consumers_iam_bindings/index.md deleted file mode 100644 index dcb693bcb6..0000000000 --- a/docs/google-docs/providers/google/servicemanagement/consumers_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: consumers_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - consumers_iam_bindings - - servicemanagement - - 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 ---- - - - -## Overview - - - - -
Nameconsumers_iam_bindings
TypeResource
Idgoogle.servicemanagement.consumers_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `services_consumers_getIamPolicy` | `SELECT` | `consumersId, servicesId` | diff --git a/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md b/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md index 2dfeb39d93..b08ce7776e 100644 --- a/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicemanagement/consumers_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicemanagement/rollouts/index.md b/docs/google-docs/providers/google/servicemanagement/rollouts/index.md index aac319f3da..55b3b90212 100644 --- a/docs/google-docs/providers/google/servicemanagement/rollouts/index.md +++ b/docs/google-docs/providers/google/servicemanagement/rollouts/index.md @@ -27,13 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `deleteServiceStrategy` | `object` | Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. | -| `rolloutId` | `string` | Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1' | | `serviceName` | `string` | The name of the service associated with this Rollout. | | `status` | `string` | The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly. | | `trafficPercentStrategy` | `object` | Strategy that specifies how clients of Google Service Controller want to send traffic to use different config versions. This is generally used by API proxy to split traffic based on your configured percentage for each config version. One example of how to gradually rollout a new service configuration using this strategy: Day 1 Rollout { id: "example.googleapis.com/rollout_20160206" traffic_percent_strategy { percentages: { "example.googleapis.com/20160201": 70.00 "example.googleapis.com/20160206": 30.00 } } } Day 2 Rollout { id: "example.googleapis.com/rollout_20160207" traffic_percent_strategy: { percentages: { "example.googleapis.com/20160206": 100.00 } } } | | `createTime` | `string` | Creation time of the rollout. Readonly. | | `createdBy` | `string` | The user who created the Rollout. Readonly. | +| `deleteServiceStrategy` | `object` | Strategy used to delete a service. This strategy is a placeholder only used by the system generated rollout to delete a service. | +| `rolloutId` | `string` | Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1' | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicemanagement/services_config/index.md b/docs/google-docs/providers/google/servicemanagement/services_config/index.md index 22bb5cf13d..d29016015b 100644 --- a/docs/google-docs/providers/google/servicemanagement/services_config/index.md +++ b/docs/google-docs/providers/google/servicemanagement/services_config/index.md @@ -29,32 +29,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead. | | `name` | `string` | The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure the owner of the service also owns the DNS name. | -| `apis` | `array` | A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. | -| `authentication` | `object` | `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read | -| `quota` | `object` | Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 | -| `sourceInfo` | `object` | Source information used to create a Service Config | -| `backend` | `object` | `Backend` defines the backend configuration for a service. | +| `monitoring` | `object` | Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue | +| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | +| `systemTypes` | `array` | A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. | +| `documentation` | `object` | `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. | +| `logging` | `object` | Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history | | `producerProjectId` | `string` | The Google project that owns this service. | +| `systemParameters` | `object` | ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. | +| `context` | `object` | `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. | | `customError` | `object` | Customize service error responses. For example, list any service specific protobuf types that can appear in error detail lists of error responses. Example: custom_error: types: - google.foo.v1.CustomError - google.foo.v1.AnotherError | +| `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | +| `authentication` | `object` | `Authentication` defines the authentication configuration for API methods provided by an API service. Example: name: calendar.googleapis.com authentication: providers: - id: google_calendar_auth jwks_uri: https://www.googleapis.com/oauth2/v1/certs issuer: https://securetoken.google.com rules: - selector: "*" requirements: provider_id: google_calendar_auth - selector: google.calendar.Delegate oauth: canonical_scopes: https://www.googleapis.com/auth/calendar.read | +| `quota` | `object` | Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 (The metric rules bind all methods to the read_calls metric, except for the UpdateBook and DeleteBook methods. These two methods are mapped to the write_calls metric, with the UpdateBook method consuming at twice rate as the DeleteBook method.) metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64 | +| `logs` | `array` | Defines the logs used by this service. | +| `metrics` | `array` | Defines the metrics used by this service. | +| `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | | `usage` | `object` | Configuration controlling usage of a service. | +| `apis` | `array` | A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files. | | `endpoints` | `array` | Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. | -| `logging` | `object` | Logging configuration of the service. The following example shows how to configure logs to be sent to the producer and consumer projects. In the example, the `activity_history` log is sent to both the producer and consumer projects, whereas the `purchase_history` log is only sent to the producer project. monitored_resources: - type: library.googleapis.com/branch labels: - key: /city description: The city where the library branch is located in. - key: /name description: The name of the branch. logs: - name: activity_history labels: - key: /customer_id - name: purchase_history logging: producer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history - purchase_history consumer_destinations: - monitored_resource: library.googleapis.com/branch logs: - activity_history | -| `metrics` | `array` | Defines the metrics used by this service. | +| `publishing` | `object` | This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config. | | `types` | `array` | A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32 | -| `documentation` | `object` | `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. | -| `monitoring` | `object` | Monitoring configuration of the service. The example below shows how to configure monitored resources and metrics for monitoring. In the example, a monitored resource and two metrics are defined. The `library.googleapis.com/book/returned_count` metric is sent to both producer and consumer projects, whereas the `library.googleapis.com/book/num_overdue` metric is only sent to the consumer project. monitored_resources: - type: library.googleapis.com/Branch display_name: "Library Branch" description: "A branch of a library." launch_stage: GA labels: - key: resource_container description: "The Cloud container (ie. project id) for the Branch." - key: location description: "The location of the library branch." - key: branch_id description: "The id of the branch." metrics: - name: library.googleapis.com/book/returned_count display_name: "Books Returned" description: "The count of books that have been returned." launch_stage: GA metric_kind: DELTA value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." - name: library.googleapis.com/book/num_overdue display_name: "Books Overdue" description: "The current number of overdue books." launch_stage: GA metric_kind: GAUGE value_type: INT64 unit: "1" labels: - key: customer_id description: "The id of the customer." monitoring: producer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count consumer_destinations: - monitored_resource: library.googleapis.com/Branch metrics: - library.googleapis.com/book/returned_count - library.googleapis.com/book/num_overdue | -| `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | -| `enums` | `array` | A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum | -| `http` | `object` | Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. | -| `systemTypes` | `array` | A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs. Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF. | -| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | -| `context` | `object` | `Context` defines which contexts an API requests. Example: context: rules: - selector: "*" requested: - google.rpc.context.ProjectContext - google.rpc.context.OriginContext The above specifies that all methods in the API request `google.rpc.context.ProjectContext` and `google.rpc.context.OriginContext`. Available context types are defined in package `google.rpc.context`. This also provides mechanism to allowlist any protobuf message extension that can be sent in grpc metadata using “x-goog-ext--bin” and “x-goog-ext--jspb” format. For example, list any service specific protobuf types that can appear in grpc metadata as follows in your yaml file: Example: context: rules: - selector: "google.example.library.v1.LibraryService.CreateBook" allowed_request_extensions: - google.foo.v1.NewExtension allowed_response_extensions: - google.foo.v1.NewExtension You can also specify extension ID instead of fully qualified extension name here. | -| `logs` | `array` | Defines the logs used by this service. | | `billing` | `object` | Billing related configuration of the service. The following example shows how to configure monitored resources and metrics for billing, `consumer_destinations` is the only supported destination and the monitored resources need at least one label key `cloud.googleapis.com/location` to indicate the location of the billing usage, using different monitored resources between monitoring and billing is recommended so they can be evolved independently: monitored_resources: - type: library.googleapis.com/billing_branch labels: - key: cloud.googleapis.com/location description: \| Predefined label to support billing location restriction. - key: city description: \| Custom label to define the city where the library branch is located in. - key: name description: Custom label to define the name of the library branch. metrics: - name: library.googleapis.com/book/borrowed_count metric_kind: DELTA value_type: INT64 unit: "1" billing: consumer_destinations: - monitored_resource: library.googleapis.com/billing_branch metrics: - library.googleapis.com/book/borrowed_count | -| `systemParameters` | `object` | ### System parameter configuration A system parameter is a special kind of parameter defined by the API system, not by an individual API. It is typically mapped to an HTTP header and/or a URL query parameter. This configuration specifies which methods change the names of the system parameters. | +| `sourceInfo` | `object` | Source information used to create a Service Config | | `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | -| `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | -| `publishing` | `object` | This message configures the settings for publishing [Google Cloud Client libraries](https://cloud.google.com/apis/docs/cloud-client-libraries) generated from the service config. | +| `backend` | `object` | `Backend` defines the backend configuration for a service. | +| `http` | `object` | Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. | +| `enums` | `array` | A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/servicemanagement/services_iam_audit_configs/index.md b/docs/google-docs/providers/google/servicemanagement/services_iam_audit_configs/index.md deleted file mode 100644 index f5fabf9696..0000000000 --- a/docs/google-docs/providers/google/servicemanagement/services_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: services_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - services_iam_audit_configs - - servicemanagement - - 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 ---- - - - -## Overview - - - - -
Nameservices_iam_audit_configs
TypeResource
Idgoogle.servicemanagement.services_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `services_getIamPolicy` | `SELECT` | `servicesId` | diff --git a/docs/google-docs/providers/google/servicemanagement/services_iam_bindings/index.md b/docs/google-docs/providers/google/servicemanagement/services_iam_bindings/index.md deleted file mode 100644 index b455a10797..0000000000 --- a/docs/google-docs/providers/google/servicemanagement/services_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: services_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - services_iam_bindings - - servicemanagement - - 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 ---- - - - -## Overview - - - - -
Nameservices_iam_bindings
TypeResource
Idgoogle.servicemanagement.services_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `services_getIamPolicy` | `SELECT` | `servicesId` | diff --git a/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md b/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md index 85685b8deb..9866097f85 100644 --- a/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md +++ b/docs/google-docs/providers/google/servicemanagement/services_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicenetworking/dns_record_set/index.md b/docs/google-docs/providers/google/servicenetworking/dns_record_set/index.md index 67379178c9..21574bdf34 100644 --- a/docs/google-docs/providers/google/servicenetworking/dns_record_set/index.md +++ b/docs/google-docs/providers/google/servicenetworking/dns_record_set/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `data` | `array` | Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for examples see https://cloud.google.com/dns/records/json-record. | -| `domain` | `string` | Required. The DNS or domain name of the record set, e.g. `test.example.com`. Cloud DNS requires that a DNS suffix ends with a trailing dot. | | `ttl` | `string` | Required. The period of time for which this RecordSet can be cached by resolvers. | | `type` | `string` | Required. The identifier of a supported record type. | +| `data` | `array` | Required. As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) for examples see https://cloud.google.com/dns/records/json-record. | +| `domain` | `string` | Required. The DNS or domain name of the record set, e.g. `test.example.com`. Cloud DNS requires that a DNS suffix ends with a trailing dot. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/servicenetworking/dns_zone/index.md b/docs/google-docs/providers/google/servicenetworking/dns_zone/index.md deleted file mode 100644 index 87ae9d94dd..0000000000 --- a/docs/google-docs/providers/google/servicenetworking/dns_zone/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: dns_zone -hide_title: false -hide_table_of_contents: false -keywords: - - dns_zone - - servicenetworking - - 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 ---- - - - -## Overview - - - - -
Namedns_zone
TypeResource
Idgoogle.servicenetworking.dns_zone
- -## Fields -| Name | Datatype | -|:-----|:---------| -| `consumerPeeringZone` | `object` | -| `producerPrivateZone` | `object` | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `get` | `SELECT` | `servicesId` | diff --git a/docs/google-docs/providers/google/servicenetworking/networks/index.md b/docs/google-docs/providers/google/servicenetworking/networks/index.md index aa0facadde..4b7e367f9c 100644 --- a/docs/google-docs/providers/google/servicenetworking/networks/index.md +++ b/docs/google-docs/providers/google/servicenetworking/networks/index.md @@ -27,19 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `producerExportCustomRoutes` | `boolean` | Export custom routes flag value for peering from producer to consumer. | +| `producerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from producer to consumer. | +| `consumerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from consumer to producer. | +| `reservedRanges` | `array` | Output only. The reserved ranges associated with this private service access connection. | +| `producerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from producer to consumer. | +| `producerNetwork` | `string` | Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name. | | `vpcScReferenceArchitectureEnabled` | `boolean` | Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network. | +| `consumerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from consumer to producer. | | `consumerExportCustomRoutes` | `boolean` | Export custom routes flag value for peering from consumer to producer. | -| `consumerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from consumer to producer. | | `producerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from producer to consumer. | -| `producerNetwork` | `string` | Output only. The VPC host network that is used to host managed service instances. In the format, projects/{project}/global/networks/{network} where {project} is the project number e.g. '12345' and {network} is the network name. | | `cloudsqlConfigs` | `array` | Represents one or multiple Cloud SQL configurations. | -| `consumerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from consumer to producer. | -| `consumerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from consumer to producer. | -| `reservedRanges` | `array` | Output only. The reserved ranges associated with this private service access connection. | -| `producerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from producer to consumer. | -| `producerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from producer to consumer. | | `usedIpRanges` | `array` | Output only. The IP ranges already in use by consumer or producer | +| `consumerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from consumer to producer. | +| `producerExportCustomRoutes` | `boolean` | Export custom routes flag value for peering from producer to consumer. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/servicenetworking/operations/index.md b/docs/google-docs/providers/google/servicenetworking/operations/index.md index 6ff0cda11a..46f550907f 100644 --- a/docs/google-docs/providers/google/servicenetworking/operations/index.md +++ b/docs/google-docs/providers/google/servicenetworking/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/serviceusage/operations/index.md b/docs/google-docs/providers/google/serviceusage/operations/index.md index cd125a8aa7..2c16fbd9c6 100644 --- a/docs/google-docs/providers/google/serviceusage/operations/index.md +++ b/docs/google-docs/providers/google/serviceusage/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | -| `response` | `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`. | -| `done` | `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. | | `error` | `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). | | `metadata` | `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. | +| `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/serviceusage/services/index.md b/docs/google-docs/providers/google/serviceusage/services/index.md index d5c82276ee..773b0fb565 100644 --- a/docs/google-docs/providers/google/serviceusage/services/index.md +++ b/docs/google-docs/providers/google/serviceusage/services/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the consumer and service. A valid name would be: - projects/123/services/serviceusage.googleapis.com | -| `state` | `string` | Whether or not the service has been enabled for use by the consumer. | | `config` | `object` | The configuration of the service. | | `parent` | `string` | The resource name of the consumer. A valid name would be: - projects/123 | +| `state` | `string` | Whether or not the service has been enabled for use by the consumer. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sourcerepo/projects/index.md b/docs/google-docs/providers/google/sourcerepo/projects/index.md deleted file mode 100644 index 371945c505..0000000000 --- a/docs/google-docs/providers/google/sourcerepo/projects/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: projects -hide_title: false -hide_table_of_contents: false -keywords: - - projects - - sourcerepo - - 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 ---- - - - -## Overview - - - - -
Nameprojects
TypeResource
Idgoogle.sourcerepo.projects
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `updateConfig` | `EXEC` | `projectsId` | diff --git a/docs/google-docs/providers/google/sourcerepo/projects_config/index.md b/docs/google-docs/providers/google/sourcerepo/projects_config/index.md deleted file mode 100644 index d15795fee7..0000000000 --- a/docs/google-docs/providers/google/sourcerepo/projects_config/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: projects_config -hide_title: false -hide_table_of_contents: false -keywords: - - projects_config - - sourcerepo - - 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 ---- - - - -## Overview - - - - -
Nameprojects_config
TypeResource
Idgoogle.sourcerepo.projects_config
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the project. Values are of the form `projects/`. | -| `enablePrivateKeyCheck` | `boolean` | Reject a Git push that contains a private key. | -| `pubsubConfigs` | `object` | How this project publishes a change in the repositories through Cloud Pub/Sub. Keyed by the topic names. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getConfig` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/sourcerepo/repos/index.md b/docs/google-docs/providers/google/sourcerepo/repos/index.md index 68748128a1..48edf0cb81 100644 --- a/docs/google-docs/providers/google/sourcerepo/repos/index.md +++ b/docs/google-docs/providers/google/sourcerepo/repos/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name of the repository, of the form `projects//repos/`. The repo name may contain slashes. eg, `projects/myproject/repos/name/with/slash` | +| `mirrorConfig` | `object` | Configuration to automatically mirror a repository from another hosting service, for example GitHub or Bitbucket. | | `pubsubConfigs` | `object` | How this repository publishes a change in the repository through Cloud Pub/Sub. Keyed by the topic names. | | `size` | `string` | The disk usage of the repo, in bytes. Read-only field. Size is only returned by GetRepo. | | `url` | `string` | URL to clone the repository from Google Cloud Source Repositories. Read-only field. | -| `mirrorConfig` | `object` | Configuration to automatically mirror a repository from another hosting service, for example GitHub or Bitbucket. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sourcerepo/repos_iam_audit_configs/index.md b/docs/google-docs/providers/google/sourcerepo/repos_iam_audit_configs/index.md deleted file mode 100644 index 022f13092b..0000000000 --- a/docs/google-docs/providers/google/sourcerepo/repos_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: repos_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - repos_iam_audit_configs - - sourcerepo - - 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 ---- - - - -## Overview - - - - -
Namerepos_iam_audit_configs
TypeResource
Idgoogle.sourcerepo.repos_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_repos_getIamPolicy` | `SELECT` | `projectsId, reposId` | diff --git a/docs/google-docs/providers/google/sourcerepo/repos_iam_bindings/index.md b/docs/google-docs/providers/google/sourcerepo/repos_iam_bindings/index.md deleted file mode 100644 index 48cf54a525..0000000000 --- a/docs/google-docs/providers/google/sourcerepo/repos_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: repos_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - repos_iam_bindings - - sourcerepo - - 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 ---- - - - -## Overview - - - - -
Namerepos_iam_bindings
TypeResource
Idgoogle.sourcerepo.repos_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_repos_getIamPolicy` | `SELECT` | `projectsId, reposId` | diff --git a/docs/google-docs/providers/google/sourcerepo/repos_iam_policies/index.md b/docs/google-docs/providers/google/sourcerepo/repos_iam_policies/index.md index fec1c15724..e8f3af14ea 100644 --- a/docs/google-docs/providers/google/sourcerepo/repos_iam_policies/index.md +++ b/docs/google-docs/providers/google/sourcerepo/repos_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | +| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/backup_operations/index.md b/docs/google-docs/providers/google/spanner/backup_operations/index.md index 05636382e8..3ceb9ebfe2 100644 --- a/docs/google-docs/providers/google/spanner/backup_operations/index.md +++ b/docs/google-docs/providers/google/spanner/backup_operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/spanner/backups/index.md b/docs/google-docs/providers/google/spanner/backups/index.md index d444250128..7789998826 100644 --- a/docs/google-docs/providers/google/spanner/backups/index.md +++ b/docs/google-docs/providers/google/spanner/backups/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form `projects//instances//backups/a-z*[a-z0-9]` The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form `projects//instances/`. | -| `maxExpireTime` | `string` | Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. | -| `sizeBytes` | `string` | Output only. Size of the backup in bytes. | -| `referencingDatabases` | `array` | Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. | | `createTime` | `string` | Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. | -| `database` | `string` | Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. | +| `maxExpireTime` | `string` | Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than `Backup.max_expire_time`. | | `referencingBackups` | `array` | Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form `projects//instances//backups/`. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. | -| `state` | `string` | Output only. The current state of the backup. | -| `versionTime` | `string` | The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. | +| `sizeBytes` | `string` | Output only. Size of the backup in bytes. | +| `databaseDialect` | `string` | Output only. The database dialect information for the backup. | | `encryptionInfo` | `object` | Encryption information for a Cloud Spanner database or backup. | +| `state` | `string` | Output only. The current state of the backup. | +| `database` | `string` | Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. | | `expireTime` | `string` | Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the `expire_time` has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. | -| `databaseDialect` | `string` | Output only. The database dialect information for the backup. | +| `versionTime` | `string` | The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`. If `version_time` is not specified, the system will set `version_time` to the `create_time` of the backup. | +| `referencingDatabases` | `array` | Output only. The names of the restored databases that reference the backup. The database names are of the form `projects//instances//databases/`. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the `READY` state, the reference to the backup is removed. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/backups_iam_bindings/index.md b/docs/google-docs/providers/google/spanner/backups_iam_bindings/index.md deleted file mode 100644 index af86fe41dd..0000000000 --- a/docs/google-docs/providers/google/spanner/backups_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: backups_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - backups_iam_bindings - - spanner - - 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 ---- - - - -## Overview - - - - -
Namebackups_iam_bindings
TypeResource
Idgoogle.spanner.backups_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_backups_getIamPolicy` | `SELECT` | `backupsId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md b/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md index 3d2a8558b6..3fa01f9cee 100644 --- a/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/spanner/backups_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/databases/index.md b/docs/google-docs/providers/google/spanner/databases/index.md index dae0d3e00a..85963939e0 100644 --- a/docs/google-docs/providers/google/spanner/databases/index.md +++ b/docs/google-docs/providers/google/spanner/databases/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The name of the database. Values are of the form `projects//instances//databases/`, where `` is as specified in the `CREATE DATABASE` statement. This name can be passed to other API methods to identify the database. | +| `defaultLeader` | `string` | Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty. | +| `enableDropProtection` | `boolean` | Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). | +| `restoreInfo` | `object` | Information about the database restore. | +| `reconciling` | `boolean` | Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. | | `state` | `string` | Output only. The current database state. | -| `earliestVersionTime` | `string` | Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. | +| `encryptionConfig` | `object` | Encryption configuration for a Cloud Spanner database. | | `versionRetentionPeriod` | `string` | Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set. | +| `encryptionInfo` | `array` | Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The `encryption_status' field inside of each `EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field. | +| `earliestVersionTime` | `string` | Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. | | `databaseDialect` | `string` | Output only. The dialect of the Cloud Spanner Database. | | `createTime` | `string` | Output only. If exists, the time at which the database creation started. | -| `enableDropProtection` | `boolean` | Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to [prevent accidental database deletion](https://cloud.google.com/spanner/docs/prevent-database-deletion). | -| `encryptionInfo` | `array` | Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The `encryption_status' field inside of each `EncryptionInfo` is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field. | -| `defaultLeader` | `string` | Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty. | -| `encryptionConfig` | `object` | Encryption configuration for a Cloud Spanner database. | -| `restoreInfo` | `object` | Information about the database restore. | -| `reconciling` | `boolean` | Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/databases_ddl/index.md b/docs/google-docs/providers/google/spanner/databases_ddl/index.md index c036e46a6d..ba598013ee 100644 --- a/docs/google-docs/providers/google/spanner/databases_ddl/index.md +++ b/docs/google-docs/providers/google/spanner/databases_ddl/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `statements` | `array` | A list of formatted DDL statements defining the schema of the database specified in the request. | | `protoDescriptors` | `string` | Proto descriptors stored in the database. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). | +| `statements` | `array` | A list of formatted DDL statements defining the schema of the database specified in the request. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/databases_iam_bindings/index.md b/docs/google-docs/providers/google/spanner/databases_iam_bindings/index.md deleted file mode 100644 index f2e3cce385..0000000000 --- a/docs/google-docs/providers/google/spanner/databases_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: databases_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - databases_iam_bindings - - spanner - - 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 ---- - - - -## Overview - - - - -
Namedatabases_iam_bindings
TypeResource
Idgoogle.spanner.databases_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_databases_getIamPolicy` | `SELECT` | `databasesId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md b/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md index 69a5d229dd..6a1d8c21bd 100644 --- a/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md +++ b/docs/google-docs/providers/google/spanner/databases_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | +| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/instance_config_operations/index.md b/docs/google-docs/providers/google/spanner/instance_config_operations/index.md index 8d9c7866d1..52a86872d0 100644 --- a/docs/google-docs/providers/google/spanner/instance_config_operations/index.md +++ b/docs/google-docs/providers/google/spanner/instance_config_operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `done` | `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. | -| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/spanner/instance_configs/index.md b/docs/google-docs/providers/google/spanner/instance_configs/index.md index 9e97bd8c4f..9900ed3a5a 100644 --- a/docs/google-docs/providers/google/spanner/instance_configs/index.md +++ b/docs/google-docs/providers/google/spanner/instance_configs/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. | -| `state` | `string` | Output only. The current instance config state. Applicable only for USER_MANAGED configs. | | `baseConfig` | `string` | Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration. | -| `freeInstanceAvailability` | `string` | Output only. Describes whether free instances are available to be created in this instance config. | | `displayName` | `string` | The name of this instance configuration as it appears in UIs. | | `leaderOptions` | `array` | Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. | +| `freeInstanceAvailability` | `string` | Output only. Describes whether free instances are available to be created in this instance config. | +| `optionalReplicas` | `array` | Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. | | `replicas` | `array` | The geographic placement of nodes in this instance configuration and their replication properties. | -| `configType` | `string` | Output only. Whether this instance config is a Google or User Managed Configuration. | | `reconciling` | `boolean` | Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. | +| `state` | `string` | Output only. The current instance config state. Applicable only for USER_MANAGED configs. | | `labels` | `object` | Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. Therefore, you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. | +| `configType` | `string` | Output only. Whether this instance config is a Google or User Managed Configuration. | | `etag` | `string` | etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. | -| `optionalReplicas` | `array` | Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/instances/index.md b/docs/google-docs/providers/google/spanner/instances/index.md index 3c53d806e8..77e932c177 100644 --- a/docs/google-docs/providers/google/spanner/instances/index.md +++ b/docs/google-docs/providers/google/spanner/instances/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. A unique identifier for the instance, which cannot be changed after the instance is created. Values are of the form `projects//instances/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. | +| `nodeCount` | `integer` | The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. | +| `state` | `string` | Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. | | `createTime` | `string` | Output only. The time at which the instance was created. | +| `processingUnits` | `integer` | The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. | | `endpointUris` | `array` | Deprecated. This field is not populated. | -| `freeInstanceMetadata` | `object` | Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes. | -| `config` | `string` | Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. | | `displayName` | `string` | Required. The descriptive name for this instance as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. | +| `freeInstanceMetadata` | `object` | Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes. | | `instanceType` | `string` | The `InstanceType` of the current instance. | | `updateTime` | `string` | Output only. The time at which the instance was most recently updated. | -| `state` | `string` | Output only. The current instance state. For CreateInstance, the state must be either omitted or set to `CREATING`. For UpdateInstance, the state must be either omitted or set to `READY`. | +| `config` | `string` | Required. The name of the instance's configuration. Values are of the form `projects//instanceConfigs/`. See also InstanceConfig and ListInstanceConfigs. | | `labels` | `object` | Cloud Labels are a flexible and lightweight mechanism for organizing cloud resources into groups that reflect a customer's organizational needs and deployment strategies. Cloud Labels can be used to filter collections of resources. They can be used to control how resource metrics are aggregated. And they can be used as arguments to policy management rules (e.g. route, firewall, load balancing, etc.). * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `a-z{0,62}`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `[a-z0-9_-]{0,63}`. * No more than 64 labels can be associated with a given resource. See https://goo.gl/xmQnxf for more information on and examples of labels. If you plan to use labels in your own code, please note that additional characters may be allowed in the future. And so you are advised to use an internal label representation, such as JSON, which doesn't rely upon specific characters being disallowed. For example, representing labels as the string: name + "_" + value would prove problematic if we were to allow "_" in a future release. | -| `nodeCount` | `integer` | The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. | -| `processingUnits` | `integer` | The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/instances_iam_bindings/index.md b/docs/google-docs/providers/google/spanner/instances_iam_bindings/index.md deleted file mode 100644 index fbdc8b8712..0000000000 --- a/docs/google-docs/providers/google/spanner/instances_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: instances_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - instances_iam_bindings - - spanner - - 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 ---- - - - -## Overview - - - - -
Nameinstances_iam_bindings
TypeResource
Idgoogle.spanner.instances_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_getIamPolicy` | `SELECT` | `instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md b/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md index 04655a39db..0135a5c170 100644 --- a/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/spanner/instances_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/operations/index.md b/docs/google-docs/providers/google/spanner/operations/index.md index f0d46a4c47..ddcc5eb955 100644 --- a/docs/google-docs/providers/google/spanner/operations/index.md +++ b/docs/google-docs/providers/google/spanner/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | +| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/session_info/index.md b/docs/google-docs/providers/google/spanner/session_info/index.md deleted file mode 100644 index 2d9576c1a9..0000000000 --- a/docs/google-docs/providers/google/spanner/session_info/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: session_info -hide_title: false -hide_table_of_contents: false -keywords: - - session_info - - spanner - - 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 ---- - - - -## Overview - - - - -
Namesession_info
TypeResource
Idgoogle.spanner.session_info
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `stats` | `object` | Additional statistics about a ResultSet or PartialResultSet. | -| `metadata` | `object` | Metadata about a ResultSet or PartialResultSet. | -| `rows` | `array` | Each element in `rows` is a row whose format is defined by metadata.row_type. The ith element in each row matches the ith field in metadata.row_type. Elements are encoded based on type as described here. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_databases_sessions_read` | `SELECT` | `databasesId, instancesId, projectsId, sessionsId` | diff --git a/docs/google-docs/providers/google/spanner/sessions/index.md b/docs/google-docs/providers/google/spanner/sessions/index.md index 6ca8e57d64..1d2acf90f0 100644 --- a/docs/google-docs/providers/google/spanner/sessions/index.md +++ b/docs/google-docs/providers/google/spanner/sessions/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the session. This is always system-assigned. | -| `approximateLastUseTime` | `string` | Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. | | `createTime` | `string` | Output only. The timestamp when the session is created. | | `creatorRole` | `string` | The database role which created this session. | | `labels` | `object` | The labels for the session. * Label keys must be between 1 and 63 characters long and must conform to the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`. * Label values must be between 0 and 63 characters long and must conform to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`. * No more than 64 labels can be associated with a given session. See https://goo.gl/xmQnxf for more information on and examples of labels. | +| `approximateLastUseTime` | `string` | Output only. The approximate timestamp when the session is last used. It is typically earlier than the actual last use time. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/sessions_batch/index.md b/docs/google-docs/providers/google/spanner/sessions_batch/index.md deleted file mode 100644 index ef6e0702af..0000000000 --- a/docs/google-docs/providers/google/spanner/sessions_batch/index.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -title: sessions_batch -hide_title: false -hide_table_of_contents: false -keywords: - - sessions_batch - - spanner - - 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 ---- - - - -## Overview - - - - -
Namesessions_batch
TypeResource
Idgoogle.spanner.sessions_batch
- -## 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 -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_instances_databases_sessions_batchCreate` | `INSERT` | `databasesId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/speech/custom_classes/index.md b/docs/google-docs/providers/google/speech/custom_classes/index.md index a814737de5..50308c0f63 100644 --- a/docs/google-docs/providers/google/speech/custom_classes/index.md +++ b/docs/google-docs/providers/google/speech/custom_classes/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the custom class. | +| `customClassId` | `string` | If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive. | | `items` | `array` | A collection of class items. | | `kmsKeyName` | `string` | Output only. The [KMS key name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. | | `kmsKeyVersionName` | `string` | Output only. The [KMS key version name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which content of the ClassItem is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`. | -| `customClassId` | `string` | If this custom class is a resource, the custom_class_id is the resource id of the CustomClass. Case sensitive. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/speech/operations/index.md b/docs/google-docs/providers/google/speech/operations/index.md index 0abf40ea7d..27bd50b56b 100644 --- a/docs/google-docs/providers/google/speech/operations/index.md +++ b/docs/google-docs/providers/google/speech/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/backup_runs/index.md b/docs/google-docs/providers/google/sqladmin/backup_runs/index.md index f907619a24..64a8e3dcb1 100644 --- a/docs/google-docs/providers/google/sqladmin/backup_runs/index.md +++ b/docs/google-docs/providers/google/sqladmin/backup_runs/index.md @@ -29,21 +29,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | The identifier for this backup run. Unique only for a specific Cloud SQL instance. | | `description` | `string` | The description of this run, only applicable to on-demand backups. | -| `backupKind` | `string` | Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. | -| `type` | `string` | The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests. | +| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | +| `timeZone` | `string` | Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server. | | `startTime` | `string` | The time the backup operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `status` | `string` | The status of this run. | +| `backupKind` | `string` | Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. | +| `kind` | `string` | This is always `sql#backupRun`. | +| `instance` | `string` | Name of the database instance. | +| `selfLink` | `string` | The URI of this resource. | +| `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | | `windowStartTime` | `string` | The start time of the backup window during which this the backup was attempted in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `timeZone` | `string` | Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server. | | `error` | `object` | Database instance operation error. | | `enqueuedTime` | `string` | The time the run was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `kind` | `string` | This is always `sql#backupRun`. | | `location` | `string` | Location of the backups. | -| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | -| `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | | `endTime` | `string` | The time the backup operation completed in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `instance` | `string` | Name of the database instance. | -| `status` | `string` | The status of this run. | -| `selfLink` | `string` | The URI of this resource. | +| `type` | `string` | The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/connect/index.md b/docs/google-docs/providers/google/sqladmin/connect/index.md index f527891280..1b5cf700e6 100644 --- a/docs/google-docs/providers/google/sqladmin/connect/index.md +++ b/docs/google-docs/providers/google/sqladmin/connect/index.md @@ -27,14 +27,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `kind` | `string` | This is always `sql#connectSettings`. | -| `pscEnabled` | `boolean` | Whether PSC connectivity is enabled for this instance. | | `region` | `string` | The cloud region for the instance. For example, `us-central1`, `europe-west1`. The region cannot be changed after instance creation. | | `serverCaCert` | `object` | SslCerts Resource | | `backendType` | `string` | `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. | | `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. MySQL instances: `MYSQL_8_0`, `MYSQL_5_7` (default), or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11`, `POSTGRES_12` (default), `POSTGRES_13`, or `POSTGRES_14`. SQL Server instances: `SQLSERVER_2017_STANDARD` (default), `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. | | `dnsName` | `string` | The dns name of the instance. | | `ipAddresses` | `array` | The assigned IP addresses for the instance. | +| `kind` | `string` | This is always `sql#connectSettings`. | +| `pscEnabled` | `boolean` | Whether PSC connectivity is enabled for this instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/databases/index.md b/docs/google-docs/providers/google/sqladmin/databases/index.md index c234fec604..30be2135f2 100644 --- a/docs/google-docs/providers/google/sqladmin/databases/index.md +++ b/docs/google-docs/providers/google/sqladmin/databases/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the database in the Cloud SQL instance. This does not include the project ID or instance name. | -| `collation` | `string` | The Cloud SQL collation value. | +| `etag` | `string` | This field is deprecated and will be removed from a future version of the API. | | `kind` | `string` | This is always `sql#database`. | -| `project` | `string` | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. | | `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. | -| `sqlserverDatabaseDetails` | `object` | Represents a Sql Server database on the Cloud SQL instance. | -| `etag` | `string` | This field is deprecated and will be removed from a future version of the API. | | `selfLink` | `string` | The URI of this resource. | +| `project` | `string` | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. | | `charset` | `string` | The Cloud SQL charset value. | +| `collation` | `string` | The Cloud SQL collation value. | +| `sqlserverDatabaseDetails` | `object` | Represents a Sql Server database on the Cloud SQL instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/flags/index.md b/docs/google-docs/providers/google/sqladmin/flags/index.md index bd2a540554..4aa014b5d4 100644 --- a/docs/google-docs/providers/google/sqladmin/flags/index.md +++ b/docs/google-docs/providers/google/sqladmin/flags/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | This is the name of the flag. Flag names always use underscores, not hyphens, for example: `max_allowed_packet` | +| `minValue` | `string` | For `INTEGER` flags, the minimum allowed value. | +| `allowedIntValues` | `array` | Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values. | +| `inBeta` | `boolean` | Whether or not the flag is considered in beta. | +| `requiresRestart` | `boolean` | Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. | | `appliesTo` | `array` | The database version this flag applies to. Can be MySQL instances: `MYSQL_8_0`, `MYSQL_8_0_18`, `MYSQL_8_0_26`, `MYSQL_5_7`, or `MYSQL_5_6`. PostgreSQL instances: `POSTGRES_9_6`, `POSTGRES_10`, `POSTGRES_11` or `POSTGRES_12`. SQL Server instances: `SQLSERVER_2017_STANDARD`, `SQLSERVER_2017_ENTERPRISE`, `SQLSERVER_2017_EXPRESS`, `SQLSERVER_2017_WEB`, `SQLSERVER_2019_STANDARD`, `SQLSERVER_2019_ENTERPRISE`, `SQLSERVER_2019_EXPRESS`, or `SQLSERVER_2019_WEB`. See [the complete list](/sql/docs/mysql/admin-api/rest/v1/SqlDatabaseVersion). | | `kind` | `string` | This is always `sql#flag`. | -| `inBeta` | `boolean` | Whether or not the flag is considered in beta. | +| `allowedStringValues` | `array` | For `STRING` flags, a list of strings that the value can be set to. | | `maxValue` | `string` | For `INTEGER` flags, the maximum allowed value. | | `type` | `string` | The type of the flag. Flags are typed to being `BOOLEAN`, `STRING`, `INTEGER` or `NONE`. `NONE` is used for flags that do not take a value, such as `skip_grant_tables`. | -| `allowedIntValues` | `array` | Use this field if only certain integers are accepted. Can be combined with min_value and max_value to add additional values. | -| `requiresRestart` | `boolean` | Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. | -| `allowedStringValues` | `array` | For `STRING` flags, a list of strings that the value can be set to. | -| `minValue` | `string` | For `INTEGER` flags, the minimum allowed value. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/instances/index.md b/docs/google-docs/providers/google/sqladmin/instances/index.md index 22ae3c1a7d..dcea6057a8 100644 --- a/docs/google-docs/providers/google/sqladmin/instances/index.md +++ b/docs/google-docs/providers/google/sqladmin/instances/index.md @@ -28,43 +28,43 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Name of the Cloud SQL instance. This does not include the project ID. | -| `instanceType` | `string` | The instance type. | -| `secondaryGceZone` | `string` | The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. | -| `failoverReplica` | `object` | The name and status of the failover replica. | -| `rootPassword` | `string` | Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. | -| `replicaConfiguration` | `object` | Read-replica configuration for connecting to the primary instance. | -| `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. | -| `region` | `string` | The geographical region. Can be: * `us-central` (`FIRST_GEN` instances only) * `us-central1` (`SECOND_GEN` instances only) * `asia-east1` or `europe-west1`. Defaults to `us-central` or `us-central1` depending on the instance type. The region cannot be changed after instance creation. | -| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | +| `databaseInstalledVersion` | `string` | Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. | | `pscServiceAttachmentLink` | `string` | Output only. The link to service attachment of PSC instance. | -| `onPremisesConfiguration` | `object` | On-premises instance configuration. | -| `ipv6Address` | `string` | The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. | -| `satisfiesPzs` | `boolean` | The status indicating if instance satisfiesPzs. Reserved for future use. | -| `scheduledMaintenance` | `object` | Any scheduled maintenance for this instance. | -| `availableMaintenanceVersions` | `array` | Output only. List all maintenance versions applicable on the instance | -| `backendType` | `string` | The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. | -| `kind` | `string` | This is always `sql#instance`. | -| `serverCaCert` | `object` | SslCerts Resource | -| `maintenanceVersion` | `string` | The current software version on the instance. | -| `currentDiskSize` | `string` | The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. | -| `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | -| `selfLink` | `string` | The URI of this resource. | +| `state` | `string` | The current serving state of the Cloud SQL instance. | +| `dnsName` | `string` | Output only. The dns name of the instance. | +| `settings` | `object` | Database instance settings. | +| `rootPassword` | `string` | Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. | +| `project` | `string` | The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. | | `createTime` | `string` | Output only. The time when the instance was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `maintenanceVersion` | `string` | The current software version on the instance. | | `etag` | `string` | This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. | -| `maxDiskSize` | `string` | The maximum disk size of the instance in bytes. | -| `dnsName` | `string` | Output only. The dns name of the instance. | -| `serviceAccountEmailAddress` | `string` | The service account email address assigned to the instance.\This property is read-only. | -| `state` | `string` | The current serving state of the Cloud SQL instance. | -| `masterInstanceName` | `string` | The name of the instance which will act as primary in the replication setup. | +| `failoverReplica` | `object` | The name and status of the failover replica. | +| `instanceType` | `string` | The instance type. | +| `outOfDiskReport` | `object` | This message wraps up the information written by out-of-disk detection job. | +| `scheduledMaintenance` | `object` | Any scheduled maintenance for this instance. | +| `onPremisesConfiguration` | `object` | On-premises instance configuration. | | `connectionName` | `string` | Connection name of the Cloud SQL instance used in connection strings. | +| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | +| `serviceAccountEmailAddress` | `string` | The service account email address assigned to the instance.\This property is read-only. | +| `selfLink` | `string` | The URI of this resource. | +| `backendType` | `string` | The backend type. `SECOND_GEN`: Cloud SQL database instance. `EXTERNAL`: A database server that is not managed by Google. This property is read-only; use the `tier` property in the `settings` object to determine the database type. | | `gceZone` | `string` | The Compute Engine zone that the instance is currently serving from. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary zone. WARNING: Changing this might restart the instance. | -| `replicaNames` | `array` | The replicas of the instance. | -| `project` | `string` | The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. | | `suspensionReason` | `array` | If the instance state is SUSPENDED, the reason for the suspension. | -| `databaseInstalledVersion` | `string` | Output only. Stores the current database version running on the instance including minor version such as `MYSQL_8_0_18`. | +| `ipv6Address` | `string` | The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. | | `ipAddresses` | `array` | The assigned IP addresses for the instance. | -| `outOfDiskReport` | `object` | This message wraps up the information written by out-of-disk detection job. | -| `settings` | `object` | Database instance settings. | +| `kind` | `string` | This is always `sql#instance`. | +| `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | +| `replicaNames` | `array` | The replicas of the instance. | +| `satisfiesPzs` | `boolean` | The status indicating if instance satisfiesPzs. Reserved for future use. | +| `region` | `string` | The geographical region. Can be: * `us-central` (`FIRST_GEN` instances only) * `us-central1` (`SECOND_GEN` instances only) * `asia-east1` or `europe-west1`. Defaults to `us-central` or `us-central1` depending on the instance type. The region cannot be changed after instance creation. | +| `currentDiskSize` | `string` | The current disk usage of the instance in bytes. This property has been deprecated. Use the "cloudsql.googleapis.com/database/disk/bytes_used" metric in Cloud Monitoring API instead. Please see [this announcement](https://groups.google.com/d/msg/google-cloud-sql-announce/I_7-F9EBhT0/BtvFtdFeAgAJ) for details. | +| `replicaConfiguration` | `object` | Read-replica configuration for connecting to the primary instance. | +| `masterInstanceName` | `string` | The name of the instance which will act as primary in the replication setup. | +| `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. | +| `availableMaintenanceVersions` | `array` | Output only. List all maintenance versions applicable on the instance | +| `secondaryGceZone` | `string` | The Compute Engine zone that the failover instance is currently serving from for a regional instance. This value could be different from the zone that was specified when the instance was created if the instance has failed over to its secondary/failover zone. | +| `maxDiskSize` | `string` | The maximum disk size of the instance in bytes. | +| `serverCaCert` | `object` | SslCerts Resource | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md b/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md index 5ee0855b89..e1ba5b3ddb 100644 --- a/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md +++ b/docs/google-docs/providers/google/sqladmin/instances_disk_shrink_config/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `message` | `string` | Additional message to customers. | | `minimalTargetSizeGb` | `string` | The minimum size to which a disk can be shrunk in GigaBytes. | | `kind` | `string` | This is always `sql#getDiskShrinkConfig`. | +| `message` | `string` | Additional message to customers. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/operations/index.md b/docs/google-docs/providers/google/sqladmin/operations/index.md index bf560d2eef..fe1045b074 100644 --- a/docs/google-docs/providers/google/sqladmin/operations/index.md +++ b/docs/google-docs/providers/google/sqladmin/operations/index.md @@ -28,21 +28,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation. | -| `kind` | `string` | This is always `sql#operation`. | -| `startTime` | `string` | The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `backupContext` | `object` | Backup context. | -| `operationType` | `string` | The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` | -| `targetLink` | `string` | | -| `targetId` | `string` | Name of the database instance related to this operation. | | `status` | `string` | The status of an operation. | -| `targetProject` | `string` | The project ID of the target instance related to this operation. | -| `insertTime` | `string` | The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | -| `selfLink` | `string` | The URI of this resource. | -| `endTime` | `string` | The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | | `importContext` | `object` | Database instance import context. | | `exportContext` | `object` | Database instance export context. | +| `endTime` | `string` | The time this operation finished in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `operationType` | `string` | The type of the operation. Valid values are: * `CREATE` * `DELETE` * `UPDATE` * `RESTART` * `IMPORT` * `EXPORT` * `BACKUP_VOLUME` * `RESTORE_VOLUME` * `CREATE_USER` * `DELETE_USER` * `CREATE_DATABASE` * `DELETE_DATABASE` | +| `backupContext` | `object` | Backup context. | | `error` | `object` | Database instance operation errors list wrapper. | +| `insertTime` | `string` | The time this operation was enqueued in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `targetId` | `string` | Name of the database instance related to this operation. | +| `kind` | `string` | This is always `sql#operation`. | +| `startTime` | `string` | The time this operation actually started in UTC timezone in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `targetProject` | `string` | The project ID of the target instance related to this operation. | +| `selfLink` | `string` | The URI of this resource. | | `user` | `string` | The email address of the user who initiated this operation. | +| `targetLink` | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md b/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md index e793b1d882..1eef229439 100644 --- a/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md +++ b/docs/google-docs/providers/google/sqladmin/ssl_certs/index.md @@ -27,15 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `selfLink` | `string` | The URI of this resource. | -| `cert` | `string` | PEM representation. | -| `certSerialNumber` | `string` | Serial number, as extracted from the certificate. | -| `sha1Fingerprint` | `string` | Sha1 Fingerprint. | -| `commonName` | `string` | User supplied name. Constrained to [a-zA-Z.-_ ]+. | | `kind` | `string` | This is always `sql#sslCert`. | | `instance` | `string` | Name of the database instance. | -| `expirationTime` | `string` | The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `certSerialNumber` | `string` | Serial number, as extracted from the certificate. | | `createTime` | `string` | The time when the certificate was created in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z` | +| `expirationTime` | `string` | The time when the certificate expires in [RFC 3339](https://tools.ietf.org/html/rfc3339) format, for example `2012-11-15T16:19:00.094Z`. | +| `commonName` | `string` | User supplied name. Constrained to [a-zA-Z.-_ ]+. | +| `selfLink` | `string` | The URI of this resource. | +| `cert` | `string` | PEM representation. | +| `sha1Fingerprint` | `string` | Sha1 Fingerprint. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/tiers/index.md b/docs/google-docs/providers/google/sqladmin/tiers/index.md index e1f20790dd..c365dbb7d0 100644 --- a/docs/google-docs/providers/google/sqladmin/tiers/index.md +++ b/docs/google-docs/providers/google/sqladmin/tiers/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `DiskQuota` | `string` | The maximum disk size of this tier in bytes. | | `RAM` | `string` | The maximum RAM usage of this tier in bytes. | | `kind` | `string` | This is always `sql#tier`. | | `region` | `array` | The applicable regions for this tier. | | `tier` | `string` | An identifier for the machine type, for example, `db-custom-1-3840`. For related information, see [Pricing](/sql/pricing). | -| `DiskQuota` | `string` | The maximum disk size of this tier in bytes. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/users/index.md b/docs/google-docs/providers/google/sqladmin/users/index.md index 3ecf5d9062..32c04bfc79 100644 --- a/docs/google-docs/providers/google/sqladmin/users/index.md +++ b/docs/google-docs/providers/google/sqladmin/users/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of the user in the Cloud SQL instance. Can be omitted for `update` because it is already specified in the URL. | -| `kind` | `string` | This is always `sql#user`. | -| `project` | `string` | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. | | `dualPasswordType` | `string` | Dual password status for the user. | | `sqlserverUserDetails` | `object` | Represents a Sql Server user on the Cloud SQL instance. | +| `kind` | `string` | This is always `sql#user`. | +| `type` | `string` | The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. | | `etag` | `string` | This field is deprecated and will be removed from a future version of the API. | -| `host` | `string` | Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. | | `passwordPolicy` | `object` | User level password validation policy. | -| `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL. | | `password` | `string` | The password for the user. | -| `type` | `string` | The user type. It determines the method to authenticate the user during login. The default is the database's built-in user type. | +| `host` | `string` | Optional. The host from which the user can connect. For `insert` operations, host defaults to an empty string. For `update` operations, host is specified as part of the request URL. The host name cannot be updated after insertion. For a MySQL instance, it's required; for a PostgreSQL or SQL Server instance, it's optional. | +| `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. Can be omitted for `update` because it is already specified on the URL. | +| `project` | `string` | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. Can be omitted for `update` because it is already specified on the URL. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/bucket_access_controls/index.md b/docs/google-docs/providers/google/storage/bucket_access_controls/index.md index 318e812fab..623bcbdf09 100644 --- a/docs/google-docs/providers/google/storage/bucket_access_controls/index.md +++ b/docs/google-docs/providers/google/storage/bucket_access_controls/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the access-control entry. | -| `selfLink` | `string` | The link to this access-control entry. | -| `role` | `string` | The access permission for the entity. | -| `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | -| `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | -| `email` | `string` | The email address associated with the entity, if any. | | `kind` | `string` | The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. | -| `bucket` | `string` | The name of the bucket. | +| `email` | `string` | The email address associated with the entity, if any. | | `entityId` | `string` | The ID for the entity, if any. | +| `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | +| `role` | `string` | The access permission for the entity. | +| `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | | `projectTeam` | `object` | The project team associated with the entity, if any. | +| `bucket` | `string` | The name of the bucket. | +| `selfLink` | `string` | The link to this access-control entry. | | `domain` | `string` | The domain associated with the entity, if any. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/storage/buckets/index.md b/docs/google-docs/providers/google/storage/buckets/index.md index 795d455f40..17cb35fdb7 100644 --- a/docs/google-docs/providers/google/storage/buckets/index.md +++ b/docs/google-docs/providers/google/storage/buckets/index.md @@ -29,34 +29,34 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | The ID of the bucket. For buckets, the id and name properties are the same. | | `name` | `string` | The name of the bucket. | -| `autoclass` | `object` | The bucket's Autoclass configuration. | -| `owner` | `object` | The owner of the bucket. This is always the project team's owner group. | -| `satisfiesPZS` | `boolean` | Reserved for future use. | -| `defaultEventBasedHold` | `boolean` | The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed. | +| `etag` | `string` | HTTP 1.1 Entity tag for the bucket. | | `customPlacementConfig` | `object` | The bucket's custom placement configuration for Custom Dual Regions. | -| `versioning` | `object` | The bucket's versioning configuration. | | `metageneration` | `string` | The metadata generation of this bucket. | -| `retentionPolicy` | `object` | The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error. | -| `timeCreated` | `string` | The creation time of the bucket in RFC 3339 format. | +| `lifecycle` | `object` | The bucket's lifecycle configuration. See lifecycle management for more information. | +| `defaultObjectAcl` | `array` | Default access controls to apply to new objects when no ACL is provided. | +| `locationType` | `string` | The type of the bucket location. | | `updated` | `string` | The modification time of the bucket in RFC 3339 format. | | `iamConfiguration` | `object` | The bucket's IAM configuration. | +| `acl` | `array` | Access controls on the bucket. | | `rpo` | `string` | The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket. | +| `encryption` | `object` | Encryption configuration for a bucket. | | `website` | `object` | The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information. | -| `kind` | `string` | The kind of item this is. For buckets, this is always storage#bucket. | -| `logging` | `object` | The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. | -| `labels` | `object` | User-provided labels, in key/value pairs. | -| `billing` | `object` | The bucket's billing configuration. | -| `acl` | `array` | Access controls on the bucket. | | `storageClass` | `string` | The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes. | +| `retentionPolicy` | `object` | The bucket's retention policy. The retention policy enforces a minimum retention time for all objects contained in the bucket, based on their creation time. Any attempt to overwrite or delete objects younger than the retention period will result in a PERMISSION_DENIED error. An unlocked retention policy can be modified or removed from the bucket via a storage.buckets.update operation. A locked retention policy cannot be removed or shortened in duration for the lifetime of the bucket. Attempting to remove or decrease period of a locked retention policy will result in a PERMISSION_DENIED error. | +| `owner` | `object` | The owner of the bucket. This is always the project team's owner group. | +| `autoclass` | `object` | The bucket's Autoclass configuration. | +| `defaultEventBasedHold` | `boolean` | The default value for event-based hold on newly created objects in this bucket. Event-based hold is a way to retain objects indefinitely until an event occurs, signified by the hold's release. After being released, such objects will be subject to bucket-level retention (if any). One sample use case of this flag is for banks to hold loan documents for at least 3 years after loan is paid in full. Here, bucket-level retention is 3 years and the event is loan being paid in full. In this example, these objects will be held intact for any number of years until the event has occurred (event-based hold on the object is released) and then 3 more years after that. That means retention duration of the objects begins from the moment event-based hold transitioned from true to false. Objects under event-based hold cannot be deleted, overwritten or archived until the hold is removed. | | `location` | `string` | The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list. | -| `lifecycle` | `object` | The bucket's lifecycle configuration. See lifecycle management for more information. | -| `selfLink` | `string` | The URI of this bucket. | -| `defaultObjectAcl` | `array` | Default access controls to apply to new objects when no ACL is provided. | +| `kind` | `string` | The kind of item this is. For buckets, this is always storage#bucket. | | `projectNumber` | `string` | The project number of the project the bucket belongs to. | +| `billing` | `object` | The bucket's billing configuration. | +| `satisfiesPZS` | `boolean` | Reserved for future use. | +| `timeCreated` | `string` | The creation time of the bucket in RFC 3339 format. | +| `logging` | `object` | The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. | +| `labels` | `object` | User-provided labels, in key/value pairs. | | `cors` | `array` | The bucket's Cross-Origin Resource Sharing (CORS) configuration. | -| `etag` | `string` | HTTP 1.1 Entity tag for the bucket. | -| `encryption` | `object` | Encryption configuration for a bucket. | -| `locationType` | `string` | The type of the bucket location. | +| `versioning` | `object` | The bucket's versioning configuration. | +| `selfLink` | `string` | The URI of this bucket. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/buckets_iam_bindings/index.md b/docs/google-docs/providers/google/storage/buckets_iam_bindings/index.md deleted file mode 100644 index 6f880dc6f4..0000000000 --- a/docs/google-docs/providers/google/storage/buckets_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: buckets_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - buckets_iam_bindings - - storage - - 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 ---- - - - -## Overview - - - - -
Namebuckets_iam_bindings
TypeResource
Idgoogle.storage.buckets_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `condition` | `object` | Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" | -| `members` | `array` | A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
- allUsers — A special identifier that represents anyone 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.
- user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com.
- serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
- group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
- domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
- projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
- projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
- projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project | -| `role` | `string` | The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
The new IAM roles are:
- roles/storage.admin — Full control of Google Cloud Storage resources.
- roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
- roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
- roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
- roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
- roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
- roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
- roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
- roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `buckets_getIamPolicy` | `SELECT` | `bucket` | diff --git a/docs/google-docs/providers/google/storage/default_object_access_controls/index.md b/docs/google-docs/providers/google/storage/default_object_access_controls/index.md index f429ebfe22..baf5218f80 100644 --- a/docs/google-docs/providers/google/storage/default_object_access_controls/index.md +++ b/docs/google-docs/providers/google/storage/default_object_access_controls/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the access-control entry. | +| `projectTeam` | `object` | The project team associated with the entity, if any. | | `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | -| `selfLink` | `string` | The link to this access-control entry. | -| `bucket` | `string` | The name of the bucket. | +| `object` | `string` | The name of the object, if applied to an object. | +| `role` | `string` | The access permission for the entity. | +| `kind` | `string` | The kind of item this is. For object access control entries, this is always storage#objectAccessControl. | | `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | +| `generation` | `string` | The content generation of the object, if applied to an object. | +| `bucket` | `string` | The name of the bucket. | +| `selfLink` | `string` | The link to this access-control entry. | | `email` | `string` | The email address associated with the entity, if any. | | `entityId` | `string` | The ID for the entity, if any. | -| `projectTeam` | `object` | The project team associated with the entity, if any. | -| `role` | `string` | The access permission for the entity. | | `domain` | `string` | The domain associated with the entity, if any. | -| `object` | `string` | The name of the object, if applied to an object. | -| `generation` | `string` | The content generation of the object, if applied to an object. | -| `kind` | `string` | The kind of item this is. For object access control entries, this is always storage#objectAccessControl. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/hmac_keys/index.md b/docs/google-docs/providers/google/storage/hmac_keys/index.md index 00434b2b21..fc6fc3fa3a 100644 --- a/docs/google-docs/providers/google/storage/hmac_keys/index.md +++ b/docs/google-docs/providers/google/storage/hmac_keys/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the HMAC key, including the Project ID and the Access ID. | -| `projectId` | `string` | Project ID owning the service account to which the key authenticates. | -| `etag` | `string` | HTTP 1.1 Entity tag for the HMAC key. | -| `timeCreated` | `string` | The creation time of the HMAC key in RFC 3339 format. | +| `state` | `string` | The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED. | | `updated` | `string` | The last modification time of the HMAC key metadata in RFC 3339 format. | +| `etag` | `string` | HTTP 1.1 Entity tag for the HMAC key. | | `selfLink` | `string` | The link to this resource. | -| `serviceAccountEmail` | `string` | The email address of the key's associated service account. | -| `state` | `string` | The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED. | +| `projectId` | `string` | Project ID owning the service account to which the key authenticates. | +| `timeCreated` | `string` | The creation time of the HMAC key in RFC 3339 format. | | `accessId` | `string` | The ID of the HMAC Key. | | `kind` | `string` | The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata. | +| `serviceAccountEmail` | `string` | The email address of the key's associated service account. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/notifications/index.md b/docs/google-docs/providers/google/storage/notifications/index.md index 12a82e5124..08c7c40a25 100644 --- a/docs/google-docs/providers/google/storage/notifications/index.md +++ b/docs/google-docs/providers/google/storage/notifications/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of the notification. | -| `topic` | `string` | The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' | -| `object_name_prefix` | `string` | If present, only apply this notification configuration to object names that begin with this prefix. | | `custom_attributes` | `object` | An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription. | -| `etag` | `string` | HTTP 1.1 Entity tag for this subscription notification. | -| `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | | `selfLink` | `string` | The canonical URL of this notification. | | `event_types` | `array` | If present, only send notifications about listed event types. If empty, sent notifications for all event types. | | `payload_format` | `string` | The desired content of the Payload. | +| `topic` | `string` | The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' | +| `etag` | `string` | HTTP 1.1 Entity tag for this subscription notification. | +| `object_name_prefix` | `string` | If present, only apply this notification configuration to object names that begin with this prefix. | +| `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/object_access_controls/index.md b/docs/google-docs/providers/google/storage/object_access_controls/index.md index fcd921e058..3e06dd6744 100644 --- a/docs/google-docs/providers/google/storage/object_access_controls/index.md +++ b/docs/google-docs/providers/google/storage/object_access_controls/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | The ID of the access-control entry. | | `bucket` | `string` | The name of the bucket. | -| `role` | `string` | The access permission for the entity. | -| `selfLink` | `string` | The link to this access-control entry. | -| `entityId` | `string` | The ID for the entity, if any. | -| `object` | `string` | The name of the object, if applied to an object. | | `kind` | `string` | The kind of item this is. For object access control entries, this is always storage#objectAccessControl. | +| `domain` | `string` | The domain associated with the entity, if any. | +| `entityId` | `string` | The ID for the entity, if any. | | `email` | `string` | The email address associated with the entity, if any. | +| `object` | `string` | The name of the object, if applied to an object. | +| `role` | `string` | The access permission for the entity. | | `generation` | `string` | The content generation of the object, if applied to an object. | -| `domain` | `string` | The domain associated with the entity, if any. | -| `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | +| `selfLink` | `string` | The link to this access-control entry. | | `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | +| `entity` | `string` | The entity holding the permission, in one of the following forms:
- user-userId
- user-email
- group-groupId
- group-email
- domain-domain
- project-team-projectId
- allUsers
- allAuthenticatedUsers Examples:
- The user liz@example.com would be user-liz@example.com.
- The group example@googlegroups.com would be group-example@googlegroups.com.
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com. | | `projectTeam` | `object` | The project team associated with the entity, if any. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/storage/objects_iam_bindings/index.md b/docs/google-docs/providers/google/storage/objects_iam_bindings/index.md deleted file mode 100644 index 79776ec3af..0000000000 --- a/docs/google-docs/providers/google/storage/objects_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: objects_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - objects_iam_bindings - - storage - - 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 ---- - - - -## Overview - - - - -
Nameobjects_iam_bindings
TypeResource
Idgoogle.storage.objects_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `members` | `array` | A collection of identifiers for members who may assume the provided role. Recognized identifiers are as follows:
- allUsers — A special identifier that represents anyone 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.
- user:emailid — An email address that represents a specific account. For example, user:alice@gmail.com or user:joe@example.com.
- serviceAccount:emailid — An email address that represents a service account. For example, serviceAccount:my-other-app@appspot.gserviceaccount.com .
- group:emailid — An email address that represents a Google group. For example, group:admins@example.com.
- domain:domain — A Google Apps domain name that represents all the users of that domain. For example, domain:google.com or domain:example.com.
- projectOwner:projectid — Owners of the given project. For example, projectOwner:my-example-project
- projectEditor:projectid — Editors of the given project. For example, projectEditor:my-example-project
- projectViewer:projectid — Viewers of the given project. For example, projectViewer:my-example-project | -| `role` | `string` | The role to which members belong. Two types of roles are supported: new IAM roles, which grant permissions that do not map directly to those provided by ACLs, and legacy IAM roles, which do map directly to ACL permissions. All roles are of the format roles/storage.specificRole.
The new IAM roles are:
- roles/storage.admin — Full control of Google Cloud Storage resources.
- roles/storage.objectViewer — Read-Only access to Google Cloud Storage objects.
- roles/storage.objectCreator — Access to create objects in Google Cloud Storage.
- roles/storage.objectAdmin — Full control of Google Cloud Storage objects. The legacy IAM roles are:
- roles/storage.legacyObjectReader — Read-only access to objects without listing. Equivalent to an ACL entry on an object with the READER role.
- roles/storage.legacyObjectOwner — Read/write access to existing objects without listing. Equivalent to an ACL entry on an object with the OWNER role.
- roles/storage.legacyBucketReader — Read access to buckets with object listing. Equivalent to an ACL entry on a bucket with the READER role.
- roles/storage.legacyBucketWriter — Read access to buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the WRITER role.
- roles/storage.legacyBucketOwner — Read and write access to existing buckets with object listing/creation/deletion. Equivalent to an ACL entry on a bucket with the OWNER role. | -| `condition` | `object` | Represents an expression text. Example: title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `objects_getIamPolicy` | `SELECT` | `bucket, object` | diff --git a/docs/google-docs/providers/google/storage/objects_iam_policies/index.md b/docs/google-docs/providers/google/storage/objects_iam_policies/index.md index 9217184fc2..4e802fbbd4 100644 --- a/docs/google-docs/providers/google/storage/objects_iam_policies/index.md +++ b/docs/google-docs/providers/google/storage/objects_iam_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `etag` | `string` | HTTP 1.1 Entity tag for the policy. | +| `kind` | `string` | The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. | | `resourceId` | `string` | The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input. | | `version` | `integer` | The IAM policy format version. | | `bindings` | `array` | An association between a role, which comes with a set of permissions, and members who may assume that role. | -| `etag` | `string` | HTTP 1.1 Entity tag for the policy. | -| `kind` | `string` | The kind of item this is. For policies, this is always storage#policy. This field is ignored on input. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/service_account/index.md b/docs/google-docs/providers/google/storage/service_account/index.md index cca3f08866..25e7621fda 100644 --- a/docs/google-docs/providers/google/storage/service_account/index.md +++ b/docs/google-docs/providers/google/storage/service_account/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `email_address` | `string` | The ID of the notification. | | `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | +| `email_address` | `string` | The ID of the notification. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md b/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md index ba72deab6d..a9eed1056c 100644 --- a/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md +++ b/docs/google-docs/providers/google/storagetransfer/agent_pools/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Specifies a unique string that identifies the agent pool. Format: `projects/{project_id}/agentPools/{agent_pool_id}` | -| `displayName` | `string` | Specifies the client-specified AgentPool description. | | `state` | `string` | Output only. Specifies the state of the AgentPool. | | `bandwidthLimit` | `object` | Specifies a bandwidth limit for an agent pool. | +| `displayName` | `string` | Specifies the client-specified AgentPool description. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md b/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md index 71663e2e4b..407baad580 100644 --- a/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md +++ b/docs/google-docs/providers/google/storagetransfer/transfer_jobs/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | A unique name (within the transfer project) assigned when the job is created. If this field is empty in a CreateTransferJobRequest, Storage Transfer Service assigns a unique name. Otherwise, the specified name is used as the unique name for this job. If the specified name is in use by a job, the creation request fails with an ALREADY_EXISTS error. This name must start with `"transferJobs/"` prefix and end with a letter or a number, and should be no more than 128 characters. For transfers involving PosixFilesystem, this name must start with `transferJobs/OPI` specifically. For all other transfer types, this name must not start with `transferJobs/OPI`. Non-PosixFilesystem example: `"transferJobs/^(?!OPI)[A-Za-z0-9-._~]*[A-Za-z0-9]$"` PosixFilesystem example: `"transferJobs/OPI^[A-Za-z0-9-._~]*[A-Za-z0-9]$"` Applications must not rely on the enforcement of naming requirements involving OPI. Invalid job names fail with an INVALID_ARGUMENT error. | | `description` | `string` | A description provided by the user for the job. Its max length is 1024 bytes when Unicode-encoded. | -| `deletionTime` | `string` | Output only. The time that the transfer job was deleted. | -| `eventStream` | `object` | Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files. | -| `loggingConfig` | `object` | Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. | | `projectId` | `string` | The ID of the Google Cloud project that owns the job. | -| `status` | `string` | Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation. | +| `schedule` | `object` | Transfers can be scheduled to recur or to run just once. | | `latestOperationName` | `string` | The name of the most recently started TransferOperation of this JobConfig. Present if a TransferOperation has been created for this JobConfig. | -| `notificationConfig` | `object` | Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a TransferOperation resource formatted according to the specified `PayloadFormat`. | -| `creationTime` | `string` | Output only. The time that the transfer job was created. | +| `loggingConfig` | `object` | Specifies the logging behavior for transfer operations. For cloud-to-cloud transfers, logs are sent to Cloud Logging. See [Read transfer logs](https://cloud.google.com/storage-transfer/docs/read-transfer-logs) for details. For transfers to or from a POSIX file system, logs are stored in the Cloud Storage bucket that is the source or sink of the transfer. See [Managing Transfer for on-premises jobs] (https://cloud.google.com/storage-transfer/docs/managing-on-prem-jobs#viewing-logs) for details. | | `lastModificationTime` | `string` | Output only. The time that the transfer job was last modified. | -| `schedule` | `object` | Transfers can be scheduled to recur or to run just once. | +| `notificationConfig` | `object` | Specification to configure notifications published to Pub/Sub. Notifications are published to the customer-provided topic using the following `PubsubMessage.attributes`: * `"eventType"`: one of the EventType values * `"payloadFormat"`: one of the PayloadFormat values * `"projectId"`: the project_id of the `TransferOperation` * `"transferJobName"`: the transfer_job_name of the `TransferOperation` * `"transferOperationName"`: the name of the `TransferOperation` The `PubsubMessage.data` contains a TransferOperation resource formatted according to the specified `PayloadFormat`. | | `transferSpec` | `object` | Configuration for running a transfer. | +| `eventStream` | `object` | Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files. | +| `creationTime` | `string` | Output only. The time that the transfer job was created. | +| `status` | `string` | Status of the job. This value MUST be specified for `CreateTransferJobRequests`. **Note:** The effect of the new job status takes place during a subsequent job run. For example, if you change the job status from ENABLED to DISABLED, and an operation spawned by the transfer is running, the status change would not affect the current operation. | +| `deletionTime` | `string` | Output only. The time that the transfer job was deleted. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md b/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md index 2f7356b86c..53f4ca84f6 100644 --- a/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md +++ b/docs/google-docs/providers/google/storagetransfer/transfer_operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned unique name. The format of `name` is `transferOperations/some/unique/name`. | +| `metadata` | `object` | Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get. | | `response` | `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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `object` | Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sts/index.md b/docs/google-docs/providers/google/sts/index.md deleted file mode 100644 index 8fa3a97484..0000000000 --- a/docs/google-docs/providers/google/sts/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -title: sts -hide_title: false -hide_table_of_contents: false -keywords: - - sts - - 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 ---- -The Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources. - -:::info Service Summary - -
-
-total resources: 1
-total selectable resources: 0
-total methods: 3
-
-
- -::: - -## Overview - - - - - - -
Namegoogle.sts
TypeService
TitleSecurity Token Service API
DescriptionThe Security Token Service exchanges Google or third-party credentials for a short-lived access token to Google Cloud resources.
Idsts:v23.05.00145
- -## Resources -
-
-sts
-
-
-
-
diff --git a/docs/google-docs/providers/google/sts/sts/index.md b/docs/google-docs/providers/google/sts/sts/index.md deleted file mode 100644 index 55169c7b01..0000000000 --- a/docs/google-docs/providers/google/sts/sts/index.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: sts -hide_title: false -hide_table_of_contents: false -keywords: - - sts - - sts - - 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 ---- - - - -## Overview - - - - -
Namests
TypeResource
Idgoogle.sts.sts
- -## 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 -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `introspect` | `EXEC` | | Gets information about a Google OAuth 2.0 access token issued by the Google Cloud [Security Token Service API](https://cloud.google.com/iam/docs/reference/sts/rest). | -| `oauthtoken` | `EXEC` | | Exchanges a credential that represents the resource owner's authorization for a Google-generated [OAuth 2.0 access token] (https://www.rfc-editor.org/rfc/rfc6749#section-5) or [refreshes an accesstoken] (https://www.rfc-editor.org/rfc/rfc6749#section-6) following [the OAuth 2.0 authorization framework] (https://tools.ietf.org/html/rfc8693) The credential can be one of the following: - An authorization code issued by the workforce identity federation authorization endpoint - A [refresh token](https://www.rfc-editor.org/rfc/rfc6749#section-10.4) issued by this endpoint This endpoint is only meant to be called by the Google Cloud CLI. Also note that this API only accepts the authorization code issued for workforce pools. | -| `token` | `EXEC` | | Exchanges a credential for a Google OAuth 2.0 access token. The token asserts an external identity within an identity pool, or it applies a Credential Access Boundary to a Google access token. Note that workforce pools do not support Credential Access Boundaries. When you call this method, do not send the `Authorization` HTTP header in the request. This method does not require the `Authorization` header, and using the header can cause the request to fail. | diff --git a/docs/google-docs/providers/google/testing/test_environment_catalog/index.md b/docs/google-docs/providers/google/testing/test_environment_catalog/index.md index 1ab94a334b..c6da20be7a 100644 --- a/docs/google-docs/providers/google/testing/test_environment_catalog/index.md +++ b/docs/google-docs/providers/google/testing/test_environment_catalog/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `deviceIpBlockCatalog` | `object` | List of IP blocks used by the Firebase Test Lab | | `iosDeviceCatalog` | `object` | The currently supported iOS devices. | | `networkConfigurationCatalog` | `object` | | | `softwareCatalog` | `object` | The currently provided software environment on the devices under test. | | `androidDeviceCatalog` | `object` | The currently supported Android devices. | -| `deviceIpBlockCatalog` | `object` | List of IP blocks used by the Firebase Test Lab | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/testing/test_matrices/index.md b/docs/google-docs/providers/google/testing/test_matrices/index.md index e78530b661..c1e30a0566 100644 --- a/docs/google-docs/providers/google/testing/test_matrices/index.md +++ b/docs/google-docs/providers/google/testing/test_matrices/index.md @@ -27,19 +27,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `environmentMatrix` | `object` | The matrix of environments in which the test is to be executed. | | `state` | `string` | Output only. Indicates the current progress of the test matrix. | -| `failFast` | `boolean` | If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation. | +| `resultStorage` | `object` | Locations where the results of running the test are stored. | | `testExecutions` | `array` | Output only. The list of test executions that the service creates for this matrix. | -| `testSpecification` | `object` | A description of how to run the test. | -| `invalidMatrixDetails` | `string` | Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. | +| `failFast` | `boolean` | If true, only a single attempt at most will be made to run each execution/shard in the matrix. Flaky test attempts are not affected. Normally, 2 or more attempts are made if a potential infrastructure issue is detected. This feature is for latency sensitive workloads. The incidence of execution failures may be significantly greater for fail-fast matrices and support is more limited because of that expectation. | +| `clientInfo` | `object` | Information about the client which invoked the test. | | `testMatrixId` | `string` | Output only. Unique id set by the service. | | `timestamp` | `string` | Output only. The time this test matrix was initially created. | +| `environmentMatrix` | `object` | The matrix of environments in which the test is to be executed. | | `outcomeSummary` | `string` | Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. | +| `testSpecification` | `object` | A description of how to run the test. | | `flakyTestAttempts` | `integer` | The number of times a TestExecution should be re-attempted if one or more of its test cases fail for any reason. The maximum number of reruns allowed is 10. Default is 0, which implies no reruns. | +| `invalidMatrixDetails` | `string` | Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. | | `projectId` | `string` | The cloud project that owns the test matrix. | -| `resultStorage` | `object` | Locations where the results of running the test are stored. | -| `clientInfo` | `object` | Information about the client which invoked the test. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/texttospeech/operations/index.md b/docs/google-docs/providers/google/texttospeech/operations/index.md index 762d8c2c14..5cd51eb4fe 100644 --- a/docs/google-docs/providers/google/texttospeech/operations/index.md +++ b/docs/google-docs/providers/google/texttospeech/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | +| `metadata` | `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. | | `response` | `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`. | | `done` | `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. | | `error` | `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). | -| `metadata` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/tpu/accelerator_types/index.md b/docs/google-docs/providers/google/tpu/accelerator_types/index.md index 224b6901e3..73fe9a2b6d 100644 --- a/docs/google-docs/providers/google/tpu/accelerator_types/index.md +++ b/docs/google-docs/providers/google/tpu/accelerator_types/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name. | -| `acceleratorConfigs` | `array` | The accelerator config. | | `type` | `string` | The accelerator type. | +| `acceleratorConfigs` | `array` | The accelerator config. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/tpu/locations/index.md b/docs/google-docs/providers/google/tpu/locations/index.md index 54e885bd44..8cfed5b0ef 100644 --- a/docs/google-docs/providers/google/tpu/locations/index.md +++ b/docs/google-docs/providers/google/tpu/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | +| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | -| `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/tpu/nodes/index.md b/docs/google-docs/providers/google/tpu/nodes/index.md index 8c3ebde4a4..629b80b85a 100644 --- a/docs/google-docs/providers/google/tpu/nodes/index.md +++ b/docs/google-docs/providers/google/tpu/nodes/index.md @@ -30,27 +30,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `id` | `string` | Output only. The unique identifier for the TPU Node. | | `name` | `string` | Output only. Immutable. The name of the TPU. | | `description` | `string` | The user-supplied description of the TPU. Maximum of 512 characters. | -| `serviceAccount` | `object` | A service account. | -| `createTime` | `string` | Output only. The time when the node was created. | +| `networkConfig` | `object` | Network related configurations. | +| `dataDisks` | `array` | The additional data disks for the Node. | +| `labels` | `object` | Resource labels to represent user-provided metadata. | | `state` | `string` | Output only. The current state for the TPU Node. | -| `symptoms` | `array` | Output only. The Symptoms that have occurred to the TPU Node. | -| `health` | `string` | The health status of the TPU node. | -| `networkEndpoints` | `array` | Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first. | -| `healthDescription` | `string` | Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. | | `metadata` | `object` | Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script | -| `multisliceNode` | `boolean` | Output only. Whether the Node belongs to a Multislice group. | -| `acceleratorConfig` | `object` | A TPU accelerator configuration. | -| `dataDisks` | `array` | The additional data disks for the Node. | +| `createTime` | `string` | Output only. The time when the node was created. | +| `cidrBlock` | `string` | The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. | | `apiVersion` | `string` | Output only. The API version that created this Node. | -| `runtimeVersion` | `string` | Required. The runtime version running in the Node. | +| `healthDescription` | `string` | Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. | | `tags` | `array` | Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls. | -| `networkConfig` | `object` | Network related configurations. | +| `queuedResource` | `string` | Output only. The qualified name of the QueuedResource that requested this Node. | +| `acceleratorType` | `string` | Optional. The type of hardware accelerators associated with this node. | +| `networkEndpoints` | `array` | Output only. The network endpoints where TPU workers can be accessed and sent work. It is recommended that runtime clients of the node reach out to the 0th entry in this map first. | +| `serviceAccount` | `object` | A service account. | +| `symptoms` | `array` | Output only. The Symptoms that have occurred to the TPU Node. | | `schedulingConfig` | `object` | Sets the scheduling options for this node. | +| `acceleratorConfig` | `object` | A TPU accelerator configuration. | +| `multisliceNode` | `boolean` | Output only. Whether the Node belongs to a Multislice group. | +| `runtimeVersion` | `string` | Required. The runtime version running in the Node. | +| `health` | `string` | The health status of the TPU node. | | `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | -| `acceleratorType` | `string` | Optional. The type of hardware accelerators associated with this node. | -| `labels` | `object` | Resource labels to represent user-provided metadata. | -| `cidrBlock` | `string` | The CIDR block that the TPU node will use when selecting an IP address. This CIDR block must be a /29 block; the Compute Engine networks API forbids a smaller block, and using a larger block would be wasteful (a node can only consume one IP address). Errors will occur if the CIDR block has already been used for a currently existing TPU node, the CIDR block conflicts with any subnetworks in the user's provided network, or the provided network is peered with another network that is using that CIDR block. | -| `queuedResource` | `string` | Output only. The qualified name of the QueuedResource that requested this Node. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/tpu/operations/index.md b/docs/google-docs/providers/google/tpu/operations/index.md index 3aa1d04978..620aef8c3f 100644 --- a/docs/google-docs/providers/google/tpu/operations/index.md +++ b/docs/google-docs/providers/google/tpu/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/transcoder/job_templates/index.md b/docs/google-docs/providers/google/transcoder/job_templates/index.md index 97fc74a5ef..1c635b152a 100644 --- a/docs/google-docs/providers/google/transcoder/job_templates/index.md +++ b/docs/google-docs/providers/google/transcoder/job_templates/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the job template. Format: `projects/{project_number}/locations/{location}/jobTemplates/{job_template}` | -| `labels` | `object` | The labels associated with this job template. You can use these to organize and group your job templates. | | `config` | `object` | Job configuration | +| `labels` | `object` | The labels associated with this job template. You can use these to organize and group your job templates. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/transcoder/jobs/index.md b/docs/google-docs/providers/google/transcoder/jobs/index.md index b32119e6e1..8e4c5134be 100644 --- a/docs/google-docs/providers/google/transcoder/jobs/index.md +++ b/docs/google-docs/providers/google/transcoder/jobs/index.md @@ -28,20 +28,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the job. Format: `projects/{project_number}/locations/{location}/jobs/{job}` | +| `outputUri` | `string` | Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). | +| `optimization` | `string` | Optional. The optimization strategy of the job. The default is `AUTODETECT`. | +| `endTime` | `string` | Output only. The time the transcoding finished. | +| `mode` | `string` | The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`. | | `inputUri` | `string` | Input only. Specify the `input_uri` to populate empty `uri` fields in each element of `Job.config.inputs` or `JobTemplate.config.inputs` when using template. URI of the media. Input files must be at least 5 seconds in duration and stored in Cloud Storage (for example, `gs://bucket/inputs/file.mp4`). See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). | -| `labels` | `object` | The labels associated with this job. You can use these to organize and group your jobs. | -| `error` | `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). | +| `createTime` | `string` | Output only. The time the job was created. | | `startTime` | `string` | Output only. The time the transcoding started. | -| `endTime` | `string` | Output only. The time the transcoding finished. | | `templateId` | `string` | Input only. Specify the `template_id` to use for populating `Job.config`. The default is `preset/web-hd`, which is the only supported preset. User defined JobTemplate: `{job_template_id}` | -| `createTime` | `string` | Output only. The time the job was created. | -| `state` | `string` | Output only. The current state of the job. | -| `config` | `object` | Job configuration | | `ttlAfterCompletionDays` | `integer` | Job time to live value in days, which will be effective after job completion. Job should be deleted automatically after the given TTL. Enter a value between 1 and 90. The default is 30. | -| `optimization` | `string` | Optional. The optimization strategy of the job. The default is `AUTODETECT`. | -| `mode` | `string` | The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`. | +| `state` | `string` | Output only. The current state of the job. | +| `labels` | `object` | The labels associated with this job. You can use these to organize and group your jobs. | | `batchModePriority` | `integer` | The processing priority of a batch job. This field can only be set for batch mode jobs. The default value is 0. This value cannot be negative. Higher values correspond to higher priorities for the job. | -| `outputUri` | `string` | Input only. Specify the `output_uri` to populate an empty `Job.config.output.uri` or `JobTemplate.config.output.uri` when using template. URI for the output file(s). For example, `gs://my-bucket/outputs/`. See [Supported input and output formats](https://cloud.google.com/transcoder/docs/concepts/supported-input-and-output-formats). | +| `error` | `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). | +| `config` | `object` | Job configuration | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/datasets/index.md b/docs/google-docs/providers/google/translate/datasets/index.md index cb34f4be70..28ef2b247f 100644 --- a/docs/google-docs/providers/google/translate/datasets/index.md +++ b/docs/google-docs/providers/google/translate/datasets/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the dataset, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}` | -| `updateTime` | `string` | Output only. Timestamp when this dataset was last updated. | | `displayName` | `string` | The name of the dataset to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. | -| `targetLanguageCode` | `string` | The BCP-47 language code of the target language. | -| `createTime` | `string` | Output only. Timestamp when this dataset was created. | +| `testExampleCount` | `integer` | Output only. Number of test examples (sentence pairs). | | `sourceLanguageCode` | `string` | The BCP-47 language code of the source language. | -| `trainExampleCount` | `integer` | Output only. Number of training examples (sentence pairs). | +| `createTime` | `string` | Output only. Timestamp when this dataset was created. | | `exampleCount` | `integer` | Output only. The number of examples in the dataset. | +| `updateTime` | `string` | Output only. Timestamp when this dataset was last updated. | | `validateExampleCount` | `integer` | Output only. Number of validation examples (sentence pairs). | -| `testExampleCount` | `integer` | Output only. Number of test examples (sentence pairs). | +| `targetLanguageCode` | `string` | The BCP-47 language code of the target language. | +| `trainExampleCount` | `integer` | Output only. Number of training examples (sentence pairs). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/examples/index.md b/docs/google-docs/providers/google/translate/examples/index.md index 022ed7eef7..8a2c691665 100644 --- a/docs/google-docs/providers/google/translate/examples/index.md +++ b/docs/google-docs/providers/google/translate/examples/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the example, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}/examples/{example_id}' | -| `usage` | `string` | Output only. Usage of the sentence pair. Options are TRAIN\|VALIDATION\|TEST. | | `sourceText` | `string` | Sentence in source language. | | `targetText` | `string` | Sentence in target language. | +| `usage` | `string` | Output only. Usage of the sentence pair. Options are TRAIN\|VALIDATION\|TEST. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/translate/glossaries/index.md b/docs/google-docs/providers/google/translate/glossaries/index.md index 6738210fd0..aa634e62fe 100644 --- a/docs/google-docs/providers/google/translate/glossaries/index.md +++ b/docs/google-docs/providers/google/translate/glossaries/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the glossary. Glossary names have the form `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}`. | -| `displayName` | `string` | Optional. The display name of the glossary. | -| `endTime` | `string` | Output only. When the glossary creation was finished. | -| `entryCount` | `integer` | Output only. The number of entries defined in the glossary. | | `inputConfig` | `object` | Input configuration for glossaries. | | `languageCodesSet` | `object` | Used with equivalent term set glossaries. | | `languagePair` | `object` | Used with unidirectional glossaries. | | `submitTime` | `string` | Output only. When CreateGlossary was called. | +| `displayName` | `string` | Optional. The display name of the glossary. | +| `endTime` | `string` | Output only. When the glossary creation was finished. | +| `entryCount` | `integer` | Output only. The number of entries defined in the glossary. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/locations/index.md b/docs/google-docs/providers/google/translate/locations/index.md index 631b4a3ff8..c4b4a82b87 100644 --- a/docs/google-docs/providers/google/translate/locations/index.md +++ b/docs/google-docs/providers/google/translate/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | -| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | | `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | +| `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | +| `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/locations_supported_languages/index.md b/docs/google-docs/providers/google/translate/locations_supported_languages/index.md deleted file mode 100644 index d5b8f200a4..0000000000 --- a/docs/google-docs/providers/google/translate/locations_supported_languages/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: locations_supported_languages -hide_title: false -hide_table_of_contents: false -keywords: - - locations_supported_languages - - translate - - 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 ---- - - - -## Overview - - - - -
Namelocations_supported_languages
TypeResource
Idgoogle.translate.locations_supported_languages
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_getSupportedLanguages` | `SELECT` | `locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/translate/models/index.md b/docs/google-docs/providers/google/translate/models/index.md index a998ee1411..30aaa81db9 100644 --- a/docs/google-docs/providers/google/translate/models/index.md +++ b/docs/google-docs/providers/google/translate/models/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the model, in form of `projects/{project-number-or-id}/locations/{location_id}/models/{model_id}` | +| `sourceLanguageCode` | `string` | Output only. The BCP-47 language code of the source language. | +| `testExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to test the model. | | `trainExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to train the model. | | `validateExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to validate the model. | +| `createTime` | `string` | Output only. Timestamp when the model resource was created, which is also when the training started. | +| `targetLanguageCode` | `string` | Output only. The BCP-47 language code of the target language. | | `dataset` | `string` | The dataset from which the model is trained, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}` | -| `displayName` | `string` | The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. | | `updateTime` | `string` | Output only. Timestamp when this model was last updated. | -| `targetLanguageCode` | `string` | Output only. The BCP-47 language code of the target language. | -| `testExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to test the model. | -| `createTime` | `string` | Output only. Timestamp when the model resource was created, which is also when the training started. | -| `sourceLanguageCode` | `string` | Output only. The BCP-47 language code of the source language. | +| `displayName` | `string` | The name of the model to show in the interface. The name can be up to 32 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscores (_), and ASCII digits 0-9. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/operations/index.md b/docs/google-docs/providers/google/translate/operations/index.md index 74c40812ab..7252a0cfd6 100644 --- a/docs/google-docs/providers/google/translate/operations/index.md +++ b/docs/google-docs/providers/google/translate/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `done` | `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. | -| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/projects_supported_languages/index.md b/docs/google-docs/providers/google/translate/projects_supported_languages/index.md deleted file mode 100644 index 670499a5df..0000000000 --- a/docs/google-docs/providers/google/translate/projects_supported_languages/index.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: projects_supported_languages -hide_title: false -hide_table_of_contents: false -keywords: - - projects_supported_languages - - translate - - 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 ---- - - - -## Overview - - - - -
Nameprojects_supported_languages
TypeResource
Idgoogle.translate.projects_supported_languages
- -## Fields -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_getSupportedLanguages` | `SELECT` | `projectsId` | diff --git a/docs/google-docs/providers/google/vision/operations/index.md b/docs/google-docs/providers/google/vision/operations/index.md index af61a7e6ea..a0a8fc70aa 100644 --- a/docs/google-docs/providers/google/vision/operations/index.md +++ b/docs/google-docs/providers/google/vision/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `done` | `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. | -| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | +| `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vision/products/index.md b/docs/google-docs/providers/google/vision/products/index.md index daac9fa432..35bef9b1a0 100644 --- a/docs/google-docs/providers/google/vision/products/index.md +++ b/docs/google-docs/providers/google/vision/products/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the product. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID`. This field is ignored when creating a product. | | `description` | `string` | User-provided metadata to be stored with this product. Must be at most 4096 characters long. | +| `displayName` | `string` | The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. | | `productCategory` | `string` | Immutable. The category for the product identified by the reference image. This should be one of "homegoods-v2", "apparel-v2", "toys-v2", "packagedgoods-v1" or "general-v1". The legacy categories "homegoods", "apparel", and "toys" are still supported, but these should not be used for new products. | | `productLabels` | `array` | Key-value pairs that can be attached to a product. At query time, constraints can be specified based on the product_labels. Note that integer values can be provided as strings, e.g. "1199". Only strings with integer values can match a range-based restriction which is to be supported soon. Multiple values can be assigned to the same key. One product may have up to 500 product_labels. Notice that the total number of distinct product_labels over all products in one ProductSet cannot exceed 1M, otherwise the product search pipeline will refuse to work for that ProductSet. | -| `displayName` | `string` | The user-provided name for this Product. Must not be empty. Must be at most 4096 characters long. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vision/reference_images/index.md b/docs/google-docs/providers/google/vision/reference_images/index.md index 193579914e..c8ab04e4b0 100644 --- a/docs/google-docs/providers/google/vision/reference_images/index.md +++ b/docs/google-docs/providers/google/vision/reference_images/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the reference image. Format is: `projects/PROJECT_ID/locations/LOC_ID/products/PRODUCT_ID/referenceImages/IMAGE_ID`. This field is ignored when creating a reference image. | -| `boundingPolys` | `array` | Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). | | `uri` | `string` | Required. The Google Cloud Storage URI of the reference image. The URI must start with `gs://`. | +| `boundingPolys` | `array` | Optional. Bounding polygons around the areas of interest in the reference image. If this field is empty, the system will try to detect regions of interest. At most 10 bounding polygons will be used. The provided shape is converted into a non-rotated rectangle. Once converted, the small edge of the rectangle must be greater than or equal to 300 pixels. The aspect ratio must be 1:4 or less (i.e. 1:3 is ok; 1:5 is not). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md b/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md index ff85da7c66..e8e65be7cb 100644 --- a/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md +++ b/docs/google-docs/providers/google/vmmigration/clone_jobs/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the clone. | +| `state` | `string` | Output only. State of the clone job. | | `stateTime` | `string` | Output only. The time the state was last updated. | | `steps` | `array` | Output only. The clone steps list representing its progress. | -| `computeEngineDisksTargetDetails` | `object` | ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. | -| `computeEngineTargetDetails` | `object` | ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. | -| `endTime` | `string` | Output only. The time the clone job was ended. | -| `state` | `string` | Output only. State of the clone job. | | `createTime` | `string` | Output only. The time the clone job was created (as an API call, not when it was actually created in the target). | | `error` | `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). | +| `computeEngineTargetDetails` | `object` | ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. | +| `endTime` | `string` | Output only. The time the clone job was ended. | +| `computeEngineDisksTargetDetails` | `object` | ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md b/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md index 79e60f5f5f..908c2008ec 100644 --- a/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md +++ b/docs/google-docs/providers/google/vmmigration/cutover_jobs/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the cutover job. | +| `stateTime` | `string` | Output only. The time the state was last updated. | +| `computeEngineDisksTargetDetails` | `object` | ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. | +| `computeEngineTargetDetails` | `object` | ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. | | `createTime` | `string` | Output only. The time the cutover job was created (as an API call, not when it was actually created in the target). | -| `progressPercent` | `integer` | Output only. The current progress in percentage of the cutover job. | +| `endTime` | `string` | Output only. The time the cutover job had finished. | | `state` | `string` | Output only. State of the cutover job. | | `steps` | `array` | Output only. The cutover steps list representing its progress. | -| `stateTime` | `string` | Output only. The time the state was last updated. | -| `endTime` | `string` | Output only. The time the cutover job had finished. | -| `error` | `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). | -| `computeEngineDisksTargetDetails` | `object` | ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. | | `stateMessage` | `string` | Output only. A message providing possible extra details about the current state. | -| `computeEngineTargetDetails` | `object` | ComputeEngineTargetDetails is a collection of details for creating a VM in a target Compute Engine project. | +| `progressPercent` | `integer` | Output only. The current progress in percentage of the cutover job. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md b/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md index feb030fc51..43d9ecdce1 100644 --- a/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md +++ b/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md @@ -28,19 +28,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The connector's name. | -| `state` | `string` | Output only. State of the DatacenterConnector, as determined by the health checks. | -| `version` | `string` | The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified. | -| `serviceAccount` | `string` | The service account to use in the connector when communicating with the cloud. | -| `upgradeStatus` | `object` | UpgradeStatus contains information about upgradeAppliance operation. | +| `createTime` | `string` | Output only. The time the connector was created (as an API call, not when it was actually installed). | | `registrationId` | `string` | Immutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified. | -| `updateTime` | `string` | Output only. The last time the connector was updated with an API call. | +| `applianceSoftwareVersion` | `string` | Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. | | `availableVersions` | `object` | Holds informatiom about the available versions for upgrade. | | `error` | `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). | | `stateTime` | `string` | Output only. The time the state was last set. | -| `applianceInfrastructureVersion` | `string` | Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. | -| `applianceSoftwareVersion` | `string` | Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. | +| `updateTime` | `string` | Output only. The last time the connector was updated with an API call. | +| `version` | `string` | The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified. | +| `state` | `string` | Output only. State of the DatacenterConnector, as determined by the health checks. | +| `upgradeStatus` | `object` | UpgradeStatus contains information about upgradeAppliance operation. | | `bucket` | `string` | Output only. The communication channel between the datacenter connector and Google Cloud. | -| `createTime` | `string` | Output only. The time the connector was created (as an API call, not when it was actually installed). | +| `serviceAccount` | `string` | The service account to use in the connector when communicating with the cloud. | +| `applianceInfrastructureVersion` | `string` | Output only. Appliance OVA version. This is the OVA which is manually installed by the user and contains the infrastructure for the automatically updatable components on the appliance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/groups/index.md b/docs/google-docs/providers/google/vmmigration/groups/index.md index 3fd8c0b22c..e96ecd552a 100644 --- a/docs/google-docs/providers/google/vmmigration/groups/index.md +++ b/docs/google-docs/providers/google/vmmigration/groups/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The Group name. | | `description` | `string` | User-provided description of the group. | -| `displayName` | `string` | Display name is a user defined name for this group which can be updated. | -| `migrationTargetType` | `string` | Immutable. The target type of this group. | | `updateTime` | `string` | Output only. The update time timestamp. | | `createTime` | `string` | Output only. The create time timestamp. | +| `displayName` | `string` | Display name is a user defined name for this group which can be updated. | +| `migrationTargetType` | `string` | Immutable. The target type of this group. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md b/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md index 4be85e59c3..81c7050b67 100644 --- a/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md +++ b/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md @@ -29,25 +29,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The identifier of the MigratingVm. | | `description` | `string` | The description attached to the migrating VM by the user. | -| `computeEngineTargetDefaults` | `object` | ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. | -| `cutoverForecast` | `object` | CutoverForecast holds information about future CutoverJobs of a MigratingVm. | -| `displayName` | `string` | The display name attached to the MigratingVm by the user. | | `group` | `string` | Output only. The group this migrating vm is included in, if any. The group is represented by the full path of the appropriate Group resource. | +| `computeEngineTargetDefaults` | `object` | ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. | +| `updateTime` | `string` | Output only. The last time the migrating VM resource was updated. | | `computeEngineDisksTargetDefaults` | `object` | ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project. | -| `labels` | `object` | The labels of the migrating VM. | -| `recentCutoverJobs` | `array` | Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. | -| `stateTime` | `string` | Output only. The last time the migrating VM state was updated. | -| `createTime` | `string` | Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). | -| `awsSourceVmDetails` | `object` | Represent the source AWS VM details. | | `lastReplicationCycle` | `object` | ReplicationCycle contains information about the current replication cycle status. | | `recentCloneJobs` | `array` | Output only. The recent clone jobs performed on the migrating VM. This field holds the vm's last completed clone job and the vm's running clone job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. | +| `lastSync` | `object` | ReplicationSync contain information about the last replica sync to the cloud. | +| `error` | `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). | +| `displayName` | `string` | The display name attached to the MigratingVm by the user. | +| `createTime` | `string` | Output only. The time the migrating VM was created (this refers to this resource and not to the time it was installed in the source). | | `state` | `string` | Output only. State of the MigratingVm. | -| `updateTime` | `string` | Output only. The last time the migrating VM resource was updated. | +| `stateTime` | `string` | Output only. The last time the migrating VM state was updated. | +| `recentCutoverJobs` | `array` | Output only. The recent cutover jobs performed on the migrating VM. This field holds the vm's last completed cutover job and the vm's running cutover job, if one exists. Note: To have this field populated you need to explicitly request it via the "view" parameter of the Get/List request. | +| `awsSourceVmDetails` | `object` | Represent the source AWS VM details. | | `currentSyncInfo` | `object` | ReplicationCycle contains information about the current replication cycle status. | -| `lastSync` | `object` | ReplicationSync contain information about the last replica sync to the cloud. | -| `sourceVmId` | `string` | The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. | | `policy` | `object` | A policy for scheduling replications. | -| `error` | `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). | +| `sourceVmId` | `string` | The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. | +| `labels` | `object` | The labels of the migrating VM. | +| `cutoverForecast` | `object` | CutoverForecast holds information about future CutoverJobs of a MigratingVm. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md b/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md index 6248375351..75265b74ec 100644 --- a/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md +++ b/docs/google-docs/providers/google/vmmigration/replication_cycles/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The identifier of the ReplicationCycle. | -| `progressPercent` | `integer` | The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately. | -| `totalPauseDuration` | `string` | The accumulated duration the replication cycle was paused. | +| `steps` | `array` | The cycle's steps list representing its progress. | | `error` | `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). | -| `cycleNumber` | `integer` | The cycle's ordinal number. | | `state` | `string` | State of the ReplicationCycle. | -| `steps` | `array` | The cycle's steps list representing its progress. | +| `progressPercent` | `integer` | The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately. | | `endTime` | `string` | The time the replication cycle has ended. | -| `startTime` | `string` | The time the replication cycle has started. | | `warnings` | `array` | Output only. Warnings that occurred during the cycle. | +| `totalPauseDuration` | `string` | The accumulated duration the replication cycle was paused. | +| `cycleNumber` | `integer` | The cycle's ordinal number. | +| `startTime` | `string` | The time the replication cycle has started. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md b/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md index af140237af..c75c6c59c2 100644 --- a/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md +++ b/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md @@ -28,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The report unique name. | -| `state` | `string` | Output only. Current state of the report. | -| `frameEndTime` | `string` | Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14. | -| `stateTime` | `string` | Output only. The time the state was last set. | -| `timeFrame` | `string` | Time frame of the report. | -| `vms` | `array` | List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored. | | `createTime` | `string` | Output only. The time the report was created (this refers to the time of the request, not the time the report creation completed). | -| `vmCount` | `integer` | Output only. Total number of VMs included in the report. | +| `timeFrame` | `string` | Time frame of the report. | | `displayName` | `string` | The report display name, as assigned by the user. | +| `stateTime` | `string` | Output only. The time the state was last set. | | `error` | `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). | +| `state` | `string` | Output only. Current state of the report. | +| `vmCount` | `integer` | Output only. Total number of VMs included in the report. | +| `vms` | `array` | List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored. | +| `frameEndTime` | `string` | Output only. The point in time when the time frame ends. Notice that the time frame is counted backwards. For instance if the "frame_end_time" value is 2021/01/20 and the time frame is WEEK then the report covers the week between 2021/01/20 and 2021/01/14. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vpcaccess/connectors/index.md b/docs/google-docs/providers/google/vpcaccess/connectors/index.md index 57e2c71118..91bf5858ec 100644 --- a/docs/google-docs/providers/google/vpcaccess/connectors/index.md +++ b/docs/google-docs/providers/google/vpcaccess/connectors/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name in the format `projects/*/locations/*/connectors/*`. | -| `machineType` | `string` | Machine type of VM Instance underlying connector. Default is e2-micro | | `maxThroughput` | `integer` | Maximum throughput of the connector in Mbps. Default is 300, max is 1000. | -| `minThroughput` | `integer` | Minimum throughput of the connector in Mbps. Default and min is 200. | -| `network` | `string` | Name of a VPC network. | -| `subnet` | `object` | The subnet in which to house the connector | -| `connectedProjects` | `array` | Output only. List of projects using the connector. | | `minInstances` | `integer` | Minimum value of instances in autoscaling group underlying the connector. | | `state` | `string` | Output only. State of the VPC access connector. | -| `ipCidrRange` | `string` | The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. | +| `network` | `string` | Name of a VPC network. | | `maxInstances` | `integer` | Maximum value of instances in autoscaling group underlying the connector. | +| `connectedProjects` | `array` | Output only. List of projects using the connector. | +| `minThroughput` | `integer` | Minimum throughput of the connector in Mbps. Default and min is 200. | +| `ipCidrRange` | `string` | The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. | +| `subnet` | `object` | The subnet in which to house the connector | +| `machineType` | `string` | Machine type of VM Instance underlying connector. Default is e2-micro | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vpcaccess/operations/index.md b/docs/google-docs/providers/google/vpcaccess/operations/index.md index cce181b563..7aa388aea7 100644 --- a/docs/google-docs/providers/google/vpcaccess/operations/index.md +++ b/docs/google-docs/providers/google/vpcaccess/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/webrisk/operations/index.md b/docs/google-docs/providers/google/webrisk/operations/index.md index f79383e2fe..db9b378094 100644 --- a/docs/google-docs/providers/google/webrisk/operations/index.md +++ b/docs/google-docs/providers/google/webrisk/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Matches the `/v1/{project-name}/operations/{operation-id}` pattern. | -| `done` | `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. | | `error` | `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). | | `metadata` | `object` | Contains a `SubmitUriMetadata` object. | | `response` | `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`. | +| `done` | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md b/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md index f1ae409db7..488f81a4ee 100644 --- a/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/crawled_urls/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `url` | `string` | Output only. The URL that was crawled. | | `body` | `string` | Output only. The body of the request that was used to visit the URL. | | `httpMethod` | `string` | Output only. The http method of the request that was used to visit the URL, in uppercase. | -| `url` | `string` | Output only. The URL that was crawled. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/websecurityscanner/findings/index.md b/docs/google-docs/providers/google/websecurityscanner/findings/index.md index 4a43d66d7d..32aab1d07f 100644 --- a/docs/google-docs/providers/google/websecurityscanner/findings/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/findings/index.md @@ -29,22 +29,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the Finding. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanruns/{scanRunId}/findings/{findingId}'. The finding IDs are generated by the system. | | `description` | `string` | Output only. The description of the vulnerability. | -| `vulnerableHeaders` | `object` | Information about vulnerable or missing HTTP Headers. | -| `severity` | `string` | Output only. The severity level of the reported vulnerability. | -| `form` | `object` | ! Information about a vulnerability with an HTML. | -| `body` | `string` | Output only. The body of the request that triggered the vulnerability. | | `xss` | `object` | Information reported for an XSS. | -| `outdatedLibrary` | `object` | Information reported for an outdated library. | -| `httpMethod` | `string` | Output only. The http method of the request that triggered the vulnerability, in uppercase. | -| `violatingResource` | `object` | Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. | -| `frameUrl` | `string` | Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. | +| `findingType` | `string` | Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings | | `finalUrl` | `string` | Output only. The URL where the browser lands when the vulnerability is detected. | -| `reproductionUrl` | `string` | Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. | +| `xxe` | `object` | Information reported for an XXE. | +| `frameUrl` | `string` | Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. | | `vulnerableParameters` | `object` | Information about vulnerable request parameters. | | `trackingId` | `string` | Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. | -| `findingType` | `string` | Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings | -| `xxe` | `object` | Information reported for an XXE. | +| `vulnerableHeaders` | `object` | Information about vulnerable or missing HTTP Headers. | +| `outdatedLibrary` | `object` | Information reported for an outdated library. | +| `httpMethod` | `string` | Output only. The http method of the request that triggered the vulnerability, in uppercase. | +| `violatingResource` | `object` | Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. | +| `severity` | `string` | Output only. The severity level of the reported vulnerability. | | `fuzzedUrl` | `string` | Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. | +| `form` | `object` | ! Information about a vulnerability with an HTML. | +| `body` | `string` | Output only. The body of the request that triggered the vulnerability. | +| `reproductionUrl` | `string` | Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md b/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md index 3075b42e22..35c03e5919 100644 --- a/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/scan_configs/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system. | +| `managedScan` | `boolean` | Whether the scan config is managed by Web Security Scanner, output only. | +| `maxQps` | `integer` | The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. | +| `exportToSecurityCommandCenter` | `string` | Controls export of scan configurations and results to Security Command Center. | +| `riskLevel` | `string` | The risk level selected for the scan | +| `authentication` | `object` | Scan authentication configuration. | | `ignoreHttpStatusErrors` | `boolean` | Whether to keep scanning even if most requests return HTTP error codes. | | `schedule` | `object` | Scan schedule configuration. | | `startingUrls` | `array` | Required. The starting URLs from which the scanner finds site pages. | +| `displayName` | `string` | Required. The user provided display name of the ScanConfig. | | `blacklistPatterns` | `array` | The excluded URL patterns as described in https://cloud.google.com/security-command-center/docs/how-to-use-web-security-scanner#excluding_urls | -| `exportToSecurityCommandCenter` | `string` | Controls export of scan configurations and results to Security Command Center. | | `userAgent` | `string` | The user agent used during scanning. | -| `managedScan` | `boolean` | Whether the scan config is managed by Web Security Scanner, output only. | | `staticIpScan` | `boolean` | Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. | -| `authentication` | `object` | Scan authentication configuration. | -| `maxQps` | `integer` | The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error. | -| `displayName` | `string` | Required. The user provided display name of the ScanConfig. | -| `riskLevel` | `string` | The risk level selected for the scan | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md b/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md index 651763e31b..61df03bdff 100644 --- a/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/scan_runs/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system. | -| `hasVulnerabilities` | `boolean` | Output only. Whether the scan run has found any vulnerabilities. | -| `resultState` | `string` | Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". | -| `executionState` | `string` | Output only. The execution state of the ScanRun. | | `warningTraces` | `array` | Output only. A list of warnings, if such are encountered during this scan run. | -| `progressPercent` | `integer` | Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. | +| `resultState` | `string` | Output only. The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED". | | `errorTrace` | `object` | Output only. Defines an error trace message for a ScanRun. | -| `urlsTestedCount` | `string` | Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. | +| `urlsCrawledCount` | `string` | Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. | | `endTime` | `string` | Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. | +| `hasVulnerabilities` | `boolean` | Output only. Whether the scan run has found any vulnerabilities. | | `startTime` | `string` | Output only. The time at which the ScanRun started. | -| `urlsCrawledCount` | `string` | Output only. The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now. | +| `urlsTestedCount` | `string` | Output only. The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads. | +| `executionState` | `string` | Output only. The execution state of the ScanRun. | +| `progressPercent` | `integer` | Output only. The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workflowexecutions/executions/index.md b/docs/google-docs/providers/google/workflowexecutions/executions/index.md index 35aaf03972..7a2724b369 100644 --- a/docs/google-docs/providers/google/workflowexecutions/executions/index.md +++ b/docs/google-docs/providers/google/workflowexecutions/executions/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} | -| `status` | `object` | Represents the current status of this execution. | -| `workflowRevisionId` | `string` | Output only. Revision of the workflow this execution is using. | -| `labels` | `object` | Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. | -| `state` | `string` | Output only. Current state of the execution. | -| `callLogLevel` | `string` | The call logging level associated to this execution. | -| `startTime` | `string` | Output only. Marks the beginning of execution. | | `error` | `object` | Error describes why the execution was abnormally terminated. | -| `argument` | `string` | Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON string value of `argument`. Example: `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'` | -| `duration` | `string` | Output only. Measures the duration of the execution. | | `stateError` | `object` | Describes an error related to the current state of the Execution resource. | -| `endTime` | `string` | Output only. Marks the end of execution, successful or not. | +| `startTime` | `string` | Output only. Marks the beginning of execution. | +| `labels` | `object` | Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. | +| `argument` | `string` | Input parameters of the execution represented as a JSON string. The size limit is 32KB. *Note*: If you are using the REST API directly to run your workflow, you must escape any JSON string value of `argument`. Example: `'{"argument":"{\"firstName\":\"FIRST\",\"lastName\":\"LAST\"}"}'` | | `result` | `string` | Output only. Output of the execution represented as a JSON string. The value can only be present if the execution's state is `SUCCEEDED`. | +| `endTime` | `string` | Output only. Marks the end of execution, successful or not. | +| `workflowRevisionId` | `string` | Output only. Revision of the workflow this execution is using. | +| `status` | `object` | Represents the current status of this execution. | +| `duration` | `string` | Output only. Measures the duration of the execution. | +| `state` | `string` | Output only. Current state of the execution. | +| `callLogLevel` | `string` | The call logging level associated to this execution. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workflows/workflows/index.md b/docs/google-docs/providers/google/workflows/workflows/index.md index 6d67c72a5e..7e16ffcd98 100644 --- a/docs/google-docs/providers/google/workflows/workflows/index.md +++ b/docs/google-docs/providers/google/workflows/workflows/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the workflow. Format: projects/{project}/locations/{location}/workflows/{workflow} | | `description` | `string` | Description of the workflow provided by the user. Must be at most 1000 unicode characters long. | -| `sourceContents` | `string` | Workflow code to be executed. The size limit is 128KB. | -| `stateError` | `object` | Describes an error related to the current state of the workflow. | | `updateTime` | `string` | Output only. The timestamp for when the workflow was last updated. | +| `sourceContents` | `string` | Workflow code to be executed. The size limit is 128KB. | +| `labels` | `object` | Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. | +| `revisionId` | `string` | Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters. | +| `createTime` | `string` | Output only. The timestamp for when the workflow was created. | | `state` | `string` | Output only. State of the workflow deployment. | +| `serviceAccount` | `string` | The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision. | | `userEnvVars` | `object` | Optional. User-defined environment variables associated with this workflow revision. This map has a maximum length of 20. Each string can take up to 40KiB. Keys cannot be empty strings and cannot start with “GOOGLE” or “WORKFLOWS". | +| `stateError` | `object` | Describes an error related to the current state of the workflow. | +| `callLogLevel` | `string` | Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence. | | `cryptoKeyName` | `string` | Optional. The resource name of a KMS crypto key used to encrypt or decrypt the data associated with the workflow. Format: projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{cryptoKey} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. If not provided, data associated with the workflow will not be CMEK-encrypted. | -| `revisionId` | `string` | Output only. The revision of the workflow. A new revision of a workflow is created as a result of updating the following properties of a workflow: - Service account - Workflow code to be executed The format is "000001-a4d", where the first six characters define the zero-padded revision ordinal number. They are followed by a hyphen and three hexadecimal random characters. | | `revisionCreateTime` | `string` | Output only. The timestamp for the latest revision of the workflow's creation. | -| `labels` | `object` | Labels associated with this workflow. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. | -| `serviceAccount` | `string` | The service account associated with the latest workflow version. This service account represents the identity of the workflow and determines what permissions the workflow has. Format: projects/{project}/serviceAccounts/{account} or {account} Using `-` as a wildcard for the `{project}` or not providing one at all will infer the project from the account. The `{account}` value can be the `email` address or the `unique_id` of the service account. If not provided, workflow will use the project's default service account. Modifying this field for an existing workflow results in a new workflow revision. | -| `callLogLevel` | `string` | Optional. Describes the level of platform logging to apply to calls and call responses during executions of this workflow. If both the workflow and the execution specify a logging level, the execution level takes precedence. | -| `createTime` | `string` | Output only. The timestamp for when the workflow was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workloadmanager/evaluations/index.md b/docs/google-docs/providers/google/workloadmanager/evaluations/index.md index 4894e7e532..08ef587e33 100644 --- a/docs/google-docs/providers/google/workloadmanager/evaluations/index.md +++ b/docs/google-docs/providers/google/workloadmanager/evaluations/index.md @@ -29,15 +29,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | name of resource names have the form 'projects/{project_id}/locations/{location_id}/evaluations/{evaluation_id}' | | `description` | `string` | Description of the Evaluation | -| `ruleVersions` | `array` | Output only. [Output only] The updated rule ids if exist. | -| `customRulesBucket` | `string` | The Cloud Storage bucket name for custom rules. | | `updateTime` | `string` | Output only. [Output only] Update time stamp | +| `resourceFilter` | `object` | Message describing resource filters | +| `ruleNames` | `array` | the name of the rule | | `createTime` | `string` | Output only. [Output only] Create time stamp | +| `customRulesBucket` | `string` | The Cloud Storage bucket name for custom rules. | +| `resourceStatus` | `object` | Message describing resource status | | `schedule` | `string` | crontab format schedule for scheduled evaluation, currently only support the following schedule: "0 */1 * * *", "0 */6 * * *", "0 */12 * * *", "0 0 */1 * *", "0 0 */7 * *", | +| `ruleVersions` | `array` | Output only. [Output only] The updated rule ids if exist. | | `labels` | `object` | Labels as key value pairs | -| `resourceFilter` | `object` | Message describing resource filters | -| `resourceStatus` | `object` | Message describing resource status | -| `ruleNames` | `array` | the name of the rule | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workloadmanager/locations/index.md b/docs/google-docs/providers/google/workloadmanager/locations/index.md index 6337857c15..70ff38f06d 100644 --- a/docs/google-docs/providers/google/workloadmanager/locations/index.md +++ b/docs/google-docs/providers/google/workloadmanager/locations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` | -| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | | `locationId` | `string` | The canonical id for this location. For example: `"us-east1"`. | | `metadata` | `object` | Service-specific metadata. For example the available capacity at the given location. | | `displayName` | `string` | The friendly name for this location, typically a nearby city name. For example, "Tokyo". | +| `labels` | `object` | Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workloadmanager/operations/index.md b/docs/google-docs/providers/google/workloadmanager/operations/index.md index f5f1250db6..4cec70c015 100644 --- a/docs/google-docs/providers/google/workloadmanager/operations/index.md +++ b/docs/google-docs/providers/google/workloadmanager/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `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}`. | -| `error` | `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). | | `metadata` | `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. | | `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | +| `error` | `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). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workloadmanager/results/index.md b/docs/google-docs/providers/google/workloadmanager/results/index.md index e40bf31bf7..ec8ecc32bc 100644 --- a/docs/google-docs/providers/google/workloadmanager/results/index.md +++ b/docs/google-docs/providers/google/workloadmanager/results/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `severity` | `string` | severity of violation | | `violationDetails` | `object` | Message describing the violdation in execution result | | `violationMessage` | `string` | the violation message of an execution | | `documentationUrl` | `string` | the document url of the rule | | `resource` | `object` | Message represent resource in execution result | | `rule` | `string` | the rule which violate in execution | +| `severity` | `string` | severity of violation | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/workloadmanager/rules/index.md b/docs/google-docs/providers/google/workloadmanager/rules/index.md index d70a9bd306..083e3f971f 100644 --- a/docs/google-docs/providers/google/workloadmanager/rules/index.md +++ b/docs/google-docs/providers/google/workloadmanager/rules/index.md @@ -29,14 +29,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | rule name | | `description` | `string` | descrite rule in plain language | -| `errorMessage` | `string` | the message template for rule | | `secondaryCategory` | `string` | the secondary category | +| `revisionId` | `string` | Output only. the version of the rule | | `uri` | `string` | the docuement url for the rule | +| `errorMessage` | `string` | the message template for rule | | `primaryCategory` | `string` | the primary category | | `severity` | `string` | the severity of the rule | | `displayName` | `string` | the name display in UI | | `remediation` | `string` | the remediation for the rule | -| `revisionId` | `string` | Output only. the version of the rule | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/workstations/iam_policies/index.md b/docs/google-docs/providers/google/workstations/iam_policies/index.md deleted file mode 100644 index 319773fe38..0000000000 --- a/docs/google-docs/providers/google/workstations/iam_policies/index.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: iam_policies -hide_title: false -hide_table_of_contents: false -keywords: - - iam_policies - - workstations - - 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 ---- - - - -## Overview - - - - -
Nameiam_policies
TypeResource
Idgoogle.workstations.iam_policies
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | -| `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | -| `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `projects_locations_workstationClusters_workstationConfigs_workstations_getIamPolicy` | `SELECT` | `locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId` | Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. | -| `projects_locations_workstationClusters_workstationConfigs_workstations_setIamPolicy` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId` | Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. | -| `projects_locations_workstationClusters_workstationConfigs_workstations_testIamPermissions` | `EXEC` | `locationsId, projectsId, workstationClustersId, workstationConfigsId, workstationsId` | Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning. | diff --git a/docs/google-docs/providers/google/workstations/operations/index.md b/docs/google-docs/providers/google/workstations/operations/index.md index 9be93c4690..43a0163f98 100644 --- a/docs/google-docs/providers/google/workstations/operations/index.md +++ b/docs/google-docs/providers/google/workstations/operations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. | +| `response` | `object` | The normal response of the operation in case of success. 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`. | | `done` | `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. | | `error` | `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). | | `metadata` | `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. | -| `response` | `object` | The normal response of the operation in case of success. 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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workstations/usable/index.md b/docs/google-docs/providers/google/workstations/usable/index.md deleted file mode 100644 index 467a13841b..0000000000 --- a/docs/google-docs/providers/google/workstations/usable/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: usable -hide_title: false -hide_table_of_contents: false -keywords: - - usable - - workstations - - 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 ---- - - - -## Overview - - - - -
Nameusable
TypeResource
Idgoogle.workstations.usable
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `nextPageToken` | `string` | Token to retrieve the next page of results, or empty if there are no more results in the list. | -| `unreachable` | `array` | Unreachable resources. | -| `workstations` | `array` | The requested workstations. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_workstationClusters_workstationConfigs_workstations_listUsable` | `SELECT` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | diff --git a/docs/google-docs/providers/google/workstations/workstation_clusters/index.md b/docs/google-docs/providers/google/workstations/workstation_clusters/index.md index eab021c410..c9aca970f5 100644 --- a/docs/google-docs/providers/google/workstations/workstation_clusters/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_clusters/index.md @@ -28,21 +28,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of this resource. | -| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | -| `displayName` | `string` | Human-readable name for this resource. | -| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | -| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | -| `network` | `string` | Immutable. Name of the Compute Engine network in which instances associated with this cluster will be created. | -| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | -| `controlPlaneIp` | `string` | Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. | | `annotations` | `object` | Client-specified annotations. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `network` | `string` | Immutable. Name of the Compute Engine network in which instances associated with this cluster will be created. | | `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | +| `conditions` | `array` | Output only. Status conditions describing the current resource state. | | `subnetwork` | `string` | Immutable. Name of the Compute Engine subnetwork in which instances associated with this cluster will be created. Must be part of the subnetwork specified for this cluster. | +| `displayName` | `string` | Human-readable name for this resource. | +| `privateClusterConfig` | `object` | Configuration options for private clusters. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | | `createTime` | `string` | Output only. Time when this resource was created. | | `degraded` | `boolean` | Output only. Whether this resource is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in the `conditions` field. | -| `conditions` | `array` | Output only. Status conditions describing the current resource state. | -| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | -| `privateClusterConfig` | `object` | Configuration options for private clusters. | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `controlPlaneIp` | `string` | Output only. The private IP address of the control plane for this cluster. Workstation VMs need access to this IP address to work with the service, so make sure that your firewall rules allow egress from the workstation VMs to this address. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workstations/workstation_configs/index.md b/docs/google-docs/providers/google/workstations/workstation_configs/index.md index 62036462e8..e92e9fc550 100644 --- a/docs/google-docs/providers/google/workstations/workstation_configs/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_configs/index.md @@ -28,25 +28,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of this resource. | -| `createTime` | `string` | Output only. Time when this resource was created. | -| `runningTimeout` | `string` | Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The `idleTimeout` and `runningTimeout` parameters are independent of each other. Note that the `runningTimeout` parameter shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A value of `0` indicates that workstations using this configuration should never time out. If `encryption_key` is set, it must be greater than `0` and less than `86400s` (24 hours). Warning: A value of `0s` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. | -| `idleTimeout` | `string` | Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `0s` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `7200s` (2 hours). The default is `1200s` (20 minutes). | -| `persistentDirectories` | `array` | Directories to persist across workstation sessions. | -| `enableAuditAgent` | `boolean` | Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). | +| `degraded` | `boolean` | Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the `conditions` field. | | `readinessChecks` | `array` | Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. | -| `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | -| `host` | `object` | Runtime host for a workstation. | +| `runningTimeout` | `string` | Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The `idleTimeout` and `runningTimeout` parameters are independent of each other. Note that the `runningTimeout` parameter shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A value of `0` indicates that workstations using this configuration should never time out. If `encryption_key` is set, it must be greater than `0` and less than `86400s` (24 hours). Warning: A value of `0s` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `createTime` | `string` | Output only. Time when this resource was created. | | `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | -| `container` | `object` | A Docker container. | -| `degraded` | `boolean` | Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the `conditions` field. | | `annotations` | `object` | Client-specified annotations. | +| `container` | `object` | A Docker container. | | `displayName` | `string` | Human-readable name for this resource. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `enableAuditAgent` | `boolean` | Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). | +| `persistentDirectories` | `array` | Directories to persist across workstation sessions. | | `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | | `conditions` | `array` | Output only. Status conditions describing the current resource state. | -| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | | `encryptionKey` | `object` | A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). | +| `idleTimeout` | `string` | Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `0s` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `7200s` (2 hours). The default is `1200s` (20 minutes). | +| `host` | `object` | Runtime host for a workstation. | | `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | -| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workstations/workstation_configs_iam_audit_configs/index.md b/docs/google-docs/providers/google/workstations/workstation_configs_iam_audit_configs/index.md deleted file mode 100644 index 3589c89a43..0000000000 --- a/docs/google-docs/providers/google/workstations/workstation_configs_iam_audit_configs/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: workstation_configs_iam_audit_configs -hide_title: false -hide_table_of_contents: false -keywords: - - workstation_configs_iam_audit_configs - - workstations - - 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 ---- - - - -## Overview - - - - -
Nameworkstation_configs_iam_audit_configs
TypeResource
Idgoogle.workstations.workstation_configs_iam_audit_configs
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `service` | `string` | Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services. | -| `auditLogConfigs` | `array` | The configuration for logging of each type of permission. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_workstationClusters_workstationConfigs_getIamPolicy` | `SELECT` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | diff --git a/docs/google-docs/providers/google/workstations/workstation_configs_iam_bindings/index.md b/docs/google-docs/providers/google/workstations/workstation_configs_iam_bindings/index.md deleted file mode 100644 index c6256a3bba..0000000000 --- a/docs/google-docs/providers/google/workstations/workstation_configs_iam_bindings/index.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: workstation_configs_iam_bindings -hide_title: false -hide_table_of_contents: false -keywords: - - workstation_configs_iam_bindings - - workstations - - 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 ---- - - - -## Overview - - - - -
Nameworkstation_configs_iam_bindings
TypeResource
Idgoogle.workstations.workstation_configs_iam_bindings
- -## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `role` | `string` | Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. | -| `condition` | `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. | -| `members` | `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`. * `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. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. | -## Methods -| Name | Accessible by | Required Params | -|:-----|:--------------|:----------------| -| `projects_locations_workstationClusters_workstationConfigs_getIamPolicy` | `SELECT` | `locationsId, projectsId, workstationClustersId, workstationConfigsId` | diff --git a/docs/google-docs/providers/google/workstations/workstation_configs_iam_policies/index.md b/docs/google-docs/providers/google/workstations/workstation_configs_iam_policies/index.md index abfc72411f..23651bd0c2 100644 --- a/docs/google-docs/providers/google/workstations/workstation_configs_iam_policies/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_configs_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | +| `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md b/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md index c81c4744d3..0d4ab9a695 100644 --- a/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_configs_usable/index.md @@ -28,25 +28,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of this resource. | -| `degraded` | `boolean` | Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the `conditions` field. | -| `encryptionKey` | `object` | A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). | -| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | -| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | -| `conditions` | `array` | Output only. Status conditions describing the current resource state. | -| `enableAuditAgent` | `boolean` | Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). | -| `idleTimeout` | `string` | Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `0s` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `7200s` (2 hours). The default is `1200s` (20 minutes). | -| `host` | `object` | Runtime host for a workstation. | -| `persistentDirectories` | `array` | Directories to persist across workstation sessions. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | | `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | | `displayName` | `string` | Human-readable name for this resource. | -| `container` | `object` | A Docker container. | +| `host` | `object` | Runtime host for a workstation. | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `runningTimeout` | `string` | Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The `idleTimeout` and `runningTimeout` parameters are independent of each other. Note that the `runningTimeout` parameter shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A value of `0` indicates that workstations using this configuration should never time out. If `encryption_key` is set, it must be greater than `0` and less than `86400s` (24 hours). Warning: A value of `0s` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `persistentDirectories` | `array` | Directories to persist across workstation sessions. | +| `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | | `readinessChecks` | `array` | Readiness checks to perform when starting a workstation using this workstation configuration. Mark a workstation as running only after all specified readiness checks return 200 status codes. | -| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `idleTimeout` | `string` | Number of seconds to wait before automatically stopping a workstation after it last received user traffic. A value of `0s` indicates that Cloud Workstations VMs created with this configuration should never time out due to idleness. Provide [duration](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#duration) terminated by `s` for seconds—for example, `7200s` (2 hours). The default is `1200s` (20 minutes). | | `createTime` | `string` | Output only. Time when this resource was created. | | `annotations` | `object` | Client-specified annotations. | -| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | -| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | -| `runningTimeout` | `string` | Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The `idleTimeout` and `runningTimeout` parameters are independent of each other. Note that the `runningTimeout` parameter shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `54000s` (15 hours). Defaults to `43200s` (12 hours). A value of `0` indicates that workstations using this configuration should never time out. If `encryption_key` is set, it must be greater than `0` and less than `86400s` (24 hours). Warning: A value of `0s` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. | +| `encryptionKey` | `object` | A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). | +| `conditions` | `array` | Output only. Status conditions describing the current resource state. | +| `container` | `object` | A Docker container. | +| `degraded` | `boolean` | Output only. Whether this resource is degraded, in which case it may require user action to restore full functionality. See also the `conditions` field. | +| `enableAuditAgent` | `boolean` | Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/workstations/workstations/index.md b/docs/google-docs/providers/google/workstations/workstations/index.md index 77d95fd795..3be6247ac9 100644 --- a/docs/google-docs/providers/google/workstations/workstations/index.md +++ b/docs/google-docs/providers/google/workstations/workstations/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of this resource. | -| `createTime` | `string` | Output only. Time when this resource was created. | -| `host` | `string` | Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. | | `annotations` | `object` | Client-specified annotations. | -| `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | | `displayName` | `string` | Human-readable name for this resource. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `createTime` | `string` | Output only. Time when this resource was created. | | `env` | `object` | Environment variables passed to the workstation container's entrypoint. | +| `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | | `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | -| `state` | `string` | Output only. Current state of the workstation. | | `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | -| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | -| `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `host` | `string` | Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. | | `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `state` | `string` | Output only. Current state of the workstation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md b/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md index 26df41e508..149cd9c71a 100644 --- a/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md +++ b/docs/google-docs/providers/google/workstations/workstations_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | | `etag` | `string` | `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. | | `version` | `integer` | Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). | | `auditConfigs` | `array` | Specifies cloud audit logging configuration for this policy. | -| `bindings` | `array` | Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workstations/workstations_usable/index.md b/docs/google-docs/providers/google/workstations/workstations_usable/index.md index 5d1ad4b4e0..2ad25faf69 100644 --- a/docs/google-docs/providers/google/workstations/workstations_usable/index.md +++ b/docs/google-docs/providers/google/workstations/workstations_usable/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of this resource. | +| `displayName` | `string` | Human-readable name for this resource. | +| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | +| `state` | `string` | Output only. Current state of the workstation. | | `host` | `string` | Output only. Host to which clients can send HTTPS traffic that will be received by the workstation. Authorized traffic will be received to the workstation as HTTP on port 80. To send traffic to a different port, clients may prefix the host with the destination port in the format `{port}-{host}`. | | `reconciling` | `boolean` | Output only. Indicates whether this resource is currently being updated to match its intended state. | -| `annotations` | `object` | Client-specified annotations. | -| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | -| `env` | `object` | Environment variables passed to the workstation container's entrypoint. | -| `labels` | `object` | Client-specified labels that are applied to the resource and that are also propagated to the underlying Compute Engine resources. | -| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | | `createTime` | `string` | Output only. Time when this resource was created. | -| `displayName` | `string` | Human-readable name for this resource. | -| `state` | `string` | Output only. Current state of the workstation. | -| `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | +| `deleteTime` | `string` | Output only. Time when this resource was soft-deleted. | | `updateTime` | `string` | Output only. Time when this resource was most recently updated. | +| `etag` | `string` | Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this resource. | +| `annotations` | `object` | Client-specified annotations. | +| `env` | `object` | Environment variables passed to the workstation container's entrypoint. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------|