Skip to content

Commit

Permalink
Merge pull request #91 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 22, 2023
2 parents 2de17be + e5e1731 commit 0d8aaf2
Show file tree
Hide file tree
Showing 1,110 changed files with 5,369 additions and 4,589 deletions.
8 changes: 4 additions & 4 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.00161)
:::info Provider Summary (v23.08.00163)

<div class="row">
<div class="providerDocColumn">
<span>total services:&nbsp;<b>149</b></span><br />
<span>total methods:&nbsp;<b>7201</b></span><br />
<span>total methods:&nbsp;<b>7176</b></span><br />
</div>
<div class="providerDocColumn">
<span>total resources:&nbsp;<b>1471</b></span><br />
<span>total selectable resources:&nbsp;<b>1183</b></span><br />
<span>total resources:&nbsp;<b>1476</b></span><br />
<span>total selectable resources:&nbsp;<b>1227</b></span><br />
</div>
</div>

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 settings. Format is one of: * "projects/&#123;project&#125;/accessApprovalSettings" * "folders/&#123;folder&#125;/accessApprovalSettings" * "organizations/&#123;organization&#125;/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. |
| `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. |
| `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. |
| `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. |
| `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). |
| `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. |
| `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. |
| `preferNoBroadApprovalRequests` | `boolean` | This preference is communicated to Google personnel when sending an approval request but can be overridden if necessary. |
## 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;". |
| `dismiss` | `object` | A decision that has been made to dismiss an approval request. |
| `requestedLocations` | `object` | Home office and physical location of the principal. |
| `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. |
| `approve` | `object` | A decision that has been made to approve access to a resource. |
| `requestTime` | `string` | The time at which approval was requested. |
| `requestedReason` | `object` | |
| `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. |
| `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. |
| `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. |
| `requestedReason` | `object` | |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
Expand Down
2 changes: 1 addition & 1 deletion docs/google-docs/providers/google/accessapproval/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.00161</code></td></tr>
<tr><td><b>Id</b></td><td><code>accessapproval:v23.08.00163</code></td></tr>
</tbody></table>

## Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ 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 |
|:-----|:--------------|:----------------|:------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/&#123;access_policy&#125;/authorizedOrgsDescs/&#123;authorized_orgs_desc&#125;`. 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`. |
| `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`. |
| `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`. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `name` | `string` | Immutable. Assigned by the server during creation. The last segment has an arbitrary length and has only URI unreserved characters (as defined by [RFC 3986 Section 2.3](https://tools.ietf.org/html/rfc3986#section-2.3)). Should not be specified by the client during creation. Example: "organizations/256/gcpUserAccessBindings/b3-BhcX_Ud5N" |
| `dryRunAccessLevels` | `array` | Optional. Dry run access level that will be evaluated but will not be enforced. The access denial based on dry run policy will be logged. Only one access level is supported, not multiple. This list must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" |
| `groupKey` | `string` | Required. Immutable. Google Group id whose members are subject to this binding's restrictions. See "id" in the [G Suite Directory API's Groups resource] (https://developers.google.com/admin-sdk/directory/v1/reference/groups#resource). If a group's email address/alias is changed, this resource will continue to point at the changed group. This field does not accept group email addresses or aliases. Example: "01d520gv4vjcrht" |
| `accessLevels` | `array` | Optional. Access level that a user must have to be granted access. Only one access level is supported, not multiple. This repeated field must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" |
| `dryRunAccessLevels` | `array` | Optional. Dry run access level that will be evaluated but will not be enforced. The access denial based on dry run policy will be logged. Only one access level is supported, not multiple. This list must have exactly one element. Example: "accessPolicies/9522/accessLevels/device_trusted" |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ An API For Setting Attribute Based Access Control To Requests To Google Cloud Se
<tr><td><b>Type</b></td><td>Service</td></tr>
<tr><td><b>Title</b></td><td>Access Context Manager API</td></tr>
<tr><td><b>Description</b></td><td>An API For Setting Attribute Based Access Control To Requests To Google Cloud Services.</td></tr>
<tr><td><b>Id</b></td><td><code>accesscontextmanager:v23.08.00161</code></td></tr>
<tr><td><b>Id</b></td><td><code>accesscontextmanager:v23.08.00163</code></td></tr>
</tbody></table>

## Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/&#123;unique_id&#125;`. |
| `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 |
|:-----|:--------------|:----------------|:------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ An API For Accessing Advisory Notifications In Google Cloud
<tr><td><b>Type</b></td><td>Service</td></tr>
<tr><td><b>Title</b></td><td>Advisory Notifications API</td></tr>
<tr><td><b>Description</b></td><td>An API For Accessing Advisory Notifications In Google Cloud</td></tr>
<tr><td><b>Id</b></td><td><code>advisorynotifications:v23.08.00161</code></td></tr>
<tr><td><b>Id</b></td><td><code>advisorynotifications:v23.08.00163</code></td></tr>
</tbody></table>

## Resources
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/&#123;organization&#125;/locations/&#123;location&#125;/notifications/&#123;notification&#125;. |
| `subject` | `object` | A subject line of a 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. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
| `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. |
| `etag` | `string` | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
## Methods
| Name | Accessible by | Required Params |
|:-----|:--------------|:----------------|
Expand Down
Loading

0 comments on commit 0d8aaf2

Please sign in to comment.