Skip to content

Commit

Permalink
Merge pull request #88 from stackql/feature/provider-doc-updates
Browse files Browse the repository at this point in the history
google updates
  • Loading branch information
jeffreyaven authored Aug 10, 2023
2 parents 0925db6 + 0c7bed6 commit da59c89
Show file tree
Hide file tree
Showing 1,232 changed files with 10,992 additions and 3,539 deletions.
15 changes: 8 additions & 7 deletions docs/google-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ slug: /providers/google
---
Cloud computing services offered by Google.

:::info Provider Summary (v23.08.00155)
:::info Provider Summary (v23.08.00157)

<div class="row">
<div class="providerDocColumn">
<span>total services:&nbsp;<b>149</b></span><br />
<span>total methods:&nbsp;<b>5754</b></span><br />
<span>total services:&nbsp;<b>150</b></span><br />
<span>total methods:&nbsp;<b>7015</b></span><br />
</div>
<div class="providerDocColumn">
<span>total resources:&nbsp;<b>1418</b></span><br />
<span>total selectable resources:&nbsp;<b>1101</b></span><br />
<span>total resources:&nbsp;<b>1469</b></span><br />
<span>total selectable resources:&nbsp;<b>1181</b></span><br />
</div>
</div>

Expand Down Expand Up @@ -103,6 +103,7 @@ stackql.exe shell --auth=$Auth
<a href="/providers/google/accessapproval/">accessapproval</a><br />
<a href="/providers/google/accesscontextmanager/">accesscontextmanager</a><br />
<a href="/providers/google/advisorynotifications/">advisorynotifications</a><br />
<a href="/providers/google/aiplatform/">aiplatform</a><br />
<a href="/providers/google/analyticshub/">analyticshub</a><br />
<a href="/providers/google/apigateway/">apigateway</a><br />
<a href="/providers/google/apigee/">apigee</a><br />
Expand Down Expand Up @@ -174,9 +175,9 @@ stackql.exe shell --auth=$Auth
<a href="/providers/google/gkehub/">gkehub</a><br />
<a href="/providers/google/gkeonprem/">gkeonprem</a><br />
<a href="/providers/google/healthcare/">healthcare</a><br />
<a href="/providers/google/iam/">iam</a><br />
</div>
<div class="providerDocColumn">
<a href="/providers/google/iam/">iam</a><br />
<a href="/providers/google/iamcredentials/">iamcredentials</a><br />
<a href="/providers/google/iap/">iap</a><br />
<a href="/providers/google/identitytoolkit/">identitytoolkit</a><br />
Expand Down Expand Up @@ -252,4 +253,4 @@ stackql.exe shell --auth=$Auth
<a href="/providers/google/workloadmanager/">workloadmanager</a><br />
<a href="/providers/google/workstations/">workstations</a><br />
</div>
</div>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ 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/&#123;project&#125;/accessApprovalSettings" * "folders/&#123;folder&#125;/accessApprovalSettings" * "organizations/&#123;organization&#125;/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). |
| `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. |
| `preferNoBroadApprovalRequests` | `boolean` | This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. |
| `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. |
| `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. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 "&#123;projects\|folders\|organizations&#125;/&#123;id&#125;/approvalRequests/&#123;approval_request&#125;". |
| `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. |
| `approve` | `object` | A decision that has been made to approve access to a resource. |
| `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. |
| `dismiss` | `object` | A decision that has been made to dismiss an approval 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. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
Expand All @@ -45,6 +45,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
| `organizations_approval_requests_list` | `SELECT` | `organizationsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
| `projects_approval_requests_get` | `SELECT` | `approvalRequestsId, projectsId` | Gets an approval request. Returns NOT_FOUND if the request does not exist. |
| `projects_approval_requests_list` | `SELECT` | `projectsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
| `_folders_approval_requests_list` | `EXEC` | `foldersId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
| `_organizations_approval_requests_list` | `EXEC` | `organizationsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
| `_projects_approval_requests_list` | `EXEC` | `projectsId` | Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological. |
| `folders_approval_requests_approve` | `EXEC` | `approvalRequestsId, foldersId` | Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. |
| `folders_approval_requests_dismiss` | `EXEC` | `approvalRequestsId, foldersId` | Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. |
| `folders_approval_requests_invalidate` | `EXEC` | `approvalRequestsId, foldersId` | Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval. Returns FAILED_PRECONDITION if the request exists but is not in an approved state. |
Expand Down
4 changes: 2 additions & 2 deletions docs/google-docs/providers/google/accessapproval/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ An API For Controlling Access To Data By Google Personnel.
<div class="providerDocColumn">
<span>total resources:&nbsp;<b>3</b></span><br />
<span>total selectable resources:&nbsp;<b>3</b></span><br />
<span>total methods:&nbsp;<b>27</b></span><br />
<span>total methods:&nbsp;<b>30</b></span><br />
</div>
</div>

Expand All @@ -33,7 +33,7 @@ An API For Controlling Access To Data By Google Personnel.
<tr><td><b>Type</b></td><td>Service</td></tr>
<tr><td><b>Title</b></td><td>Access Approval API</td></tr>
<tr><td><b>Description</b></td><td>An API For Controlling Access To Data By Google Personnel.</td></tr>
<tr><td><b>Id</b></td><td><code>accessapproval:v23.08.00155</code></td></tr>
<tr><td><b>Id</b></td><td><code>accessapproval:v23.08.00157</code></td></tr>
</tbody></table>

## Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
|:-----|:---------|:------------|
| `name` | `string` | Resource name for the `AccessLevel`. Format: `accessPolicies/&#123;access_policy&#125;/accessLevels/&#123;access_level&#125;`. The `access_level` component must begin with a letter, followed by alphanumeric characters or `_`. Its maximum length is 50 characters. After you create an `AccessLevel`, you cannot change its `name`. |
| `description` | `string` | Description of the `AccessLevel` and its use. Does not affect behavior. |
| `title` | `string` | Human readable title. Must be unique within the Policy. |
| `basic` | `object` | `BasicLevel` is an `AccessLevel` using a set of recommended features. |
| `custom` | `object` | `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec |
| `title` | `string` | Human readable title. Must be unique within the Policy. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get` | `SELECT` | `accessLevelsId, accessPoliciesId` | Gets an access level based on the resource name. |
| `list` | `SELECT` | `accessPoliciesId` | Lists all access levels for an access policy. |
| `create` | `INSERT` | `accessPoliciesId` | Creates an access level. The long-running operation from this RPC has a successful status after the access level propagates to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered. |
| `delete` | `DELETE` | `accessLevelsId, accessPoliciesId` | Deletes an access level based on the resource name. The long-running operation from this RPC has a successful status after the access level has been removed from long-lasting storage. |
| `_list` | `EXEC` | `accessPoliciesId` | Lists all access levels for an access policy. |
| `patch` | `EXEC` | `accessLevelsId, accessPoliciesId` | Updates an access level. The long-running operation from this RPC has a successful status after the changes to the access level propagate to long-lasting storage. If access levels contain errors, an error response is returned for the first error encountered. |
| `replace_all` | `EXEC` | `accessPoliciesId` | Replaces all existing access levels in an access policy with the access levels provided. This is done atomically. The long-running operation from this RPC has a successful status after all replacements propagate to long-lasting storage. If the replacement contains errors, an error response is returned for the first error encountered. Upon error, the replacement is cancelled, and existing access levels are not affected. The Operation.response field contains ReplaceAccessLevelsResponse. Removing access levels contained in existing service perimeters result in an error. |
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `name` | `string` | Output only. Resource name of the `AccessPolicy`. Format: `accessPolicies/&#123;access_policy&#125;` |
| `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. |
| `parent` | `string` | Required. The parent of this `AccessPolicy` in the Cloud Resource Hierarchy. Currently immutable once created. Format: `organizations/&#123;organization_id&#125;` |
| `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/&#123;folder_number&#125;` or `projects/&#123;project_number&#125;` |
| `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 |
|:-----|:--------------|:----------------|:------------|
| `get` | `SELECT` | `accessPoliciesId` | Returns an access policy based on the name. |
| `list` | `SELECT` | | Lists all access policies in an organization. |
| `create` | `INSERT` | | Creates an access policy. This method fails if the organization already has an access policy. The long-running operation has a successful status after the access policy propagates to long-lasting storage. Syntactic and basic semantic errors are returned in `metadata` as a BadRequest proto. |
| `delete` | `DELETE` | `accessPoliciesId` | Deletes an access policy based on the resource name. The long-running operation has a successful status after the access policy is removed from long-lasting storage. |
| `_list` | `EXEC` | | Lists all access policies in an organization. |
| `patch` | `EXEC` | `accessPoliciesId` | Updates an access policy. The long-running operation from this RPC has a successful status after the changes to the access policy propagate to long-lasting storage. |
Loading

0 comments on commit da59c89

Please sign in to comment.