diff --git a/docs/google-docs/index.md b/docs/google-docs/index.md index f1b5284f9e..3d6f36ea9d 100644 --- a/docs/google-docs/index.md +++ b/docs/google-docs/index.md @@ -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)
total services: 149
-total methods: 7201
+total methods: 7176
-total resources: 1471
-total selectable resources: 1183
+total resources: 1476
+total selectable resources: 1227
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 f4c099d444..198e6411b3 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,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/{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. | -| `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 | |:-----|:--------------|:----------------|:------------| 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 4a91ca7d71..6fba676fe1 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. | -| `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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/accessapproval/index.md b/docs/google-docs/providers/google/accessapproval/index.md index 09b7381950..2ca030a0b1 100644 --- a/docs/google-docs/providers/google/accessapproval/index.md +++ b/docs/google-docs/providers/google/accessapproval/index.md @@ -33,7 +33,7 @@ An API For Controlling Access To Data By Google Personnel. TypeService TitleAccess Approval API DescriptionAn API For Controlling Access To Data By Google Personnel. -Idaccessapproval:v23.08.00161 +Idaccessapproval:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md b/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md index aabee351f0..b87d9500aa 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/access_levels/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name for the `AccessLevel`. Format: `accessPolicies/{access_policy}/accessLevels/{access_level}`. The `access_level` component must begin with a letter, followed by alphanumeric characters or `_`. Its maximum length is 50 characters. After you create an `AccessLevel`, you cannot change its `name`. | | `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 | |:-----|:--------------|:----------------|:------------| 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..504af7b858 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`. | +| `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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md b/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md index 5c37112a28..a632d86c0b 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/gcp_user_access_bindings/index.md @@ -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 | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/accesscontextmanager/index.md b/docs/google-docs/providers/google/accesscontextmanager/index.md index 083efa2f30..b90c038f52 100644 --- a/docs/google-docs/providers/google/accesscontextmanager/index.md +++ b/docs/google-docs/providers/google/accesscontextmanager/index.md @@ -33,7 +33,7 @@ An API For Setting Attribute Based Access Control To Requests To Google Cloud Se TypeService TitleAccess Context Manager API DescriptionAn API For Setting Attribute Based Access Control To Requests To Google Cloud Services. -Idaccesscontextmanager:v23.08.00161 +Idaccesscontextmanager:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/accesscontextmanager/operations/index.md b/docs/google-docs/providers/google/accesscontextmanager/operations/index.md index c8cbf26f5e..844df0c96b 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}`. | -| `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/advisorynotifications/index.md b/docs/google-docs/providers/google/advisorynotifications/index.md index f95a37a4e0..9b92e2ba9f 100644 --- a/docs/google-docs/providers/google/advisorynotifications/index.md +++ b/docs/google-docs/providers/google/advisorynotifications/index.md @@ -33,7 +33,7 @@ An API For Accessing Advisory Notifications In Google Cloud TypeService TitleAdvisory Notifications API DescriptionAn API For Accessing Advisory Notifications In Google Cloud -Idadvisorynotifications:v23.08.00161 +Idadvisorynotifications:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/advisorynotifications/notifications/index.md b/docs/google-docs/providers/google/advisorynotifications/notifications/index.md index 1d96048c6e..74eecd1a6f 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}. | +| `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 | |:-----|:--------------|:----------------|:------------| 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 9381752a64..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. | +| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/aiplatform/annotations/index.md b/docs/google-docs/providers/google/aiplatform/annotations/index.md index 899655a23a..39a6a7238f 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. | +| `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. | -| `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. | ## 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 d7e100a8ae..ba7379a925 100644 --- a/docs/google-docs/providers/google/aiplatform/artifacts/index.md +++ b/docs/google-docs/providers/google/aiplatform/artifacts/index.md @@ -30,15 +30,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Output only. The resource name of the Artifact. | | `description` | `string` | Description of the Artifact | | `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. | -| `createTime` | `string` | Output only. Timestamp when this Artifact was created. | -| `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. | -| `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. | -| `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). | | `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. | +| `displayName` | `string` | User provided display name of the Artifact. May be up to 128 Unicode characters. | +| `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. | | `updateTime` | `string` | Output only. Timestamp when this Artifact was last updated. | +| `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | | `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. | -| `displayName` | `string` | User provided display name of the Artifact. May be up to 128 Unicode characters. | +| `createTime` | `string` | Output only. Timestamp when this Artifact was created. | +| `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 7d098cc1dd..45117f1712 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 @@ -28,32 +28,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the BatchPredictionJob. | +| `createTime` | `string` | Output only. Time when the BatchPredictionJob was created. | +| `dedicatedResources` | `object` | A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. | +| `endTime` | `string` | Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | | `unmanagedContainerModel` | `object` | Contains model information necessary to perform batch prediction without requiring a full model import. | -| `outputInfo` | `object` | Further describes this job's output. Supplements output_config. | -| `resourcesConsumed` | `object` | Statistics information about resource consumption. | -| `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. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `updateTime` | `string` | Output only. Time when the BatchPredictionJob was most recently updated. | | `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}` | -| `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. | -| `modelVersionId` | `string` | Output only. The version ID of the Model that produces the predictions via this job. | -| `completionStats` | `object` | Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. | -| `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. | | `startTime` | `string` | Output only. Time when the BatchPredictionJob for the first time entered the `JOB_STATE_RUNNING` state. | -| `state` | `string` | Output only. The detailed state of the job. | -| `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. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `displayName` | `string` | Required. The user-defined name of this BatchPredictionJob. | -| `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. | -| `createTime` | `string` | Output only. Time when the BatchPredictionJob was created. | +| `resourcesConsumed` | `object` | Statistics information about resource consumption. | | `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. | -| `endTime` | `string` | Output only. Time when the BatchPredictionJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | | `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. | -| `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. | -| `dedicatedResources` | `object` | A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. | -| `updateTime` | `string` | Output only. Time when the BatchPredictionJob was most recently updated. | -| `explanationSpec` | `object` | Specification of Model explanation. | +| `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. | +| `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. | +| `state` | `string` | Output only. The detailed state of the job. | | `instanceConfig` | `object` | Configuration defining how to transform batch prediction input instances to the instances that the Model accepts. | +| `explanationSpec` | `object` | Specification of Model explanation. | +| `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. | +| `completionStats` | `object` | Success and error statistics of processing multiple entities (for example, DataItems or structured data rows) in batch. | +| `outputInfo` | `object` | Further describes this job's output. Supplements output_config. | +| `modelVersionId` | `string` | Output only. The version ID of the Model that produces the predictions via this job. | +| `displayName` | `string` | Required. The user-defined name of this BatchPredictionJob. | +| `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. | | `manualBatchTuningParameters` | `object` | Manual batch tuning parameters. | | `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 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. | +| `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. | ## 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 49b99a2dda..60035fefe0 100644 --- a/docs/google-docs/providers/google/aiplatform/contexts/index.md +++ b/docs/google-docs/providers/google/aiplatform/contexts/index.md @@ -29,15 +29,15 @@ 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 | -| `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. | -| `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. | +| `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. | | `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. | +| `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). | | `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. | -| `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. | | `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). | +| `displayName` | `string` | User provided display name of the Context. May be up to 128 Unicode characters. | +| `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. | ## 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 5b502ffa50..2fea8dd6ba 100644 --- a/docs/google-docs/providers/google/aiplatform/custom_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/custom_jobs/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 a CustomJob. | -| `startTime` | `string` | Output only. Time when the CustomJob for the first time entered the `JOB_STATE_RUNNING` state. | -| `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` | Required. The display name of the CustomJob. 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. | -| `updateTime` | `string` | Output only. Time when the CustomJob was most recently updated. | | `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. | | `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. | +| `createTime` | `string` | Output only. Time when the CustomJob was created. | +| `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. | +| `state` | `string` | Output only. The detailed state of the job. | +| `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. | -| `createTime` | `string` | Output only. Time when the CustomJob was created. | +| `updateTime` | `string` | Output only. Time when the CustomJob was most recently updated. | | `endTime` | `string` | Output only. Time when the CustomJob 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/data_labeling_jobs/index.md b/docs/google-docs/providers/google/aiplatform/data_labeling_jobs/index.md index c4e357db91..4da6c86669 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. | -| `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. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `inputs` | `any` | Required. Input config parameters for 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}` | | `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. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `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. | | `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. | -| `state` | `string` | Output only. The detailed state of the job. | -| `createTime` | `string` | Output only. Timestamp when this DataLabelingJob was created. | +| `updateTime` | `string` | Output only. Timestamp when this DataLabelingJob was updated most recently. | | `specialistPools` | `array` | The SpecialistPools' resource names associated with this job. | +| `labelerCount` | `integer` | Required. Number of labelers to work on each DataItem. | | `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` | 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. | -| `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. | | `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. | -| `updateTime` | `string` | Output only. Timestamp when this DataLabelingJob was updated most recently. | -| `labelerCount` | `integer` | Required. Number of labelers to work on each DataItem. | -| `labelingProgress` | `integer` | Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished. | | `currentSpend` | `object` | Represents an amount of money with its currency type. | +| `createTime` | `string` | Output only. Timestamp when this DataLabelingJob was created. | +| `inputs` | `any` | Required. Input config parameters for 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. | +| `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. | +| `state` | `string` | Output only. The detailed state of the job. | +| `labelingProgress` | `integer` | Output only. Current labeling job progress percentage scaled in interval [0, 100], indicating the percentage of DataItems that has been finished. | ## 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 7e1befe4ea..61df3a1398 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. | -| `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. | -| `metadata` | `any` | Required. Additional information about the Dataset. | -| `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. | | `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/. | -| `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. | | `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `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. | | `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}`. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `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. | | `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. | +| `updateTime` | `string` | Output only. Timestamp when this Dataset was last updated. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `createTime` | `string` | Output only. Timestamp when this Dataset was created. | +| `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. | +| `metadata` | `any` | Required. Additional information about the 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 b84d1ca152..9c63eb7a7e 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. | +| `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. | +| `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. | +| `updateTime` | `string` | Output only. Timestamp when this Endpoint was last updated. | | `createTime` | `string` | Output only. Timestamp when this Endpoint was created. | -| `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. | | `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. | | `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. | | `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}` | -| `predictRequestResponseLoggingConfig` | `object` | Configuration for logging request-response to a BigQuery table. | +| `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. | -| `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. | -| `etag` | `string` | Used to perform 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. | -| `updateTime` | `string` | Output only. Timestamp when this Endpoint was last updated. | -| `deployedModels` | `array` | Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. | ## 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 65218ff835..8f73e0edd9 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. | +| `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. | ## 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 543f5b4b26..430ce0f052 100644 --- a/docs/google-docs/providers/google/aiplatform/evaluations/index.md +++ b/docs/google-docs/providers/google/aiplatform/evaluations/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 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". | -| `displayName` | `string` | The display name of the ModelEvaluation. | -| `explanationSpecs` | `array` | Describes the values of ExplanationSpec that are used for explaining the predicted values on the evaluated data. | | `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). | -| `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. | -| `metrics` | `any` | Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri | +| `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. | +| `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. | +| `displayName` | `string` | The display name of the ModelEvaluation. | +| `createTime` | `string` | Output only. Timestamp when this ModelEvaluation was created. | | `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 = `. | | `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. | +| `metrics` | `any` | Evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri | ## 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 e5d6bca656..ed08368c29 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 | -| `displayName` | `string` | User provided display name of the Execution. May be up to 128 Unicode characters. | -| `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. | | `updateTime` | `string` | Output only. Timestamp when this Execution was last updated. | -| `createTime` | `string` | Output only. Timestamp when this Execution was created. | | `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). | -| `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. | | `etag` | `string` | An eTag used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `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. | +| `displayName` | `string` | User provided display name of the Execution. May be up to 128 Unicode characters. | +| `createTime` | `string` | Output only. Timestamp when this Execution was created. | | `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. | | `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_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. | ## 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 0532c3b2da..c1e7a6412e 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. | -| `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. | | `updateTime` | `string` | Output only. Timestamp when this TensorboardExperiment was last updated. | +| `createTime` | `string` | Output only. Timestamp when this TensorboardExperiment was created. | ## 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 cab094e58a..42f7687fff 100644 --- a/docs/google-docs/providers/google/aiplatform/features/index.md +++ b/docs/google-docs/providers/google/aiplatform/features/index.md @@ -29,14 +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. | -| `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. | -| `updateTime` | `string` | Output only. Timestamp when this EntityType was most recently updated. | | `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. | +| `updateTime` | `string` | Output only. Timestamp when this EntityType was most recently updated. | | `createTime` | `string` | Output only. Timestamp when this EntityType was created. | +| `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. | | `etag` | `string` | 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 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. | ## 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 7e318acba3..9e5d2dc411 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}` | -| `state` | `string` | Output only. State of the featurestore. | | `updateTime` | `string` | Output only. Timestamp when this Featurestore was last updated. | -| `onlineServingConfig` | `object` | OnlineServingConfig specifies the details for provisioning online serving resources. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `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 | | `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. | | `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. | -| `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 | +| `onlineServingConfig` | `object` | OnlineServingConfig specifies the details for provisioning online serving resources. | +| `state` | `string` | Output only. State of the featurestore. | +| `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/hyperparameter_tuning_jobs/index.md b/docs/google-docs/providers/google/aiplatform/hyperparameter_tuning_jobs/index.md index 5ee705226f..c73ef5674b 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. | +| `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. | -| `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. | -| `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. | -| `trials` | `array` | Output only. Trials of the HyperparameterTuningJob. | -| `studySpec` | `object` | Represents specification of a Study. | | `trialJobSpec` | `object` | Represents the spec of a CustomJob. | -| `state` | `string` | Output only. The detailed state of the job. | -| `startTime` | `string` | Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. | -| `updateTime` | `string` | Output only. Time when the HyperparameterTuningJob was most recently updated. | +| `createTime` | `string` | Output only. Time when the HyperparameterTuningJob was created. | | `endTime` | `string` | Output only. Time when the HyperparameterTuningJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | | `maxTrialCount` | `integer` | Required. The desired total number of Trials. | -| `createTime` | `string` | Output only. Time when the HyperparameterTuningJob was created. | -| `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. Time when the HyperparameterTuningJob was most recently updated. | | `parallelTrialCount` | `integer` | Required. The desired number of Trials to run in parallel. | +| `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. | +| `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. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `startTime` | `string` | Output only. Time when the HyperparameterTuningJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `studySpec` | `object` | Represents specification of a Study. | +| `trials` | `array` | Output only. Trials of the HyperparameterTuningJob. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/index.md b/docs/google-docs/providers/google/aiplatform/index.md index dda5b7199f..3ca01b62cd 100644 --- a/docs/google-docs/providers/google/aiplatform/index.md +++ b/docs/google-docs/providers/google/aiplatform/index.md @@ -33,7 +33,7 @@ Train High-Quality Custom Machine Learning Models With Minimal Machine Learning TypeService TitleVertex AI API DescriptionTrain High-Quality Custom Machine Learning Models With Minimal Machine Learning Expertise And Effort. -Idaiplatform:v23.08.00161 +Idaiplatform:v23.08.00163 ## Resources 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 c45c5d0b4f..a15086b70a 100644 --- a/docs/google-docs/providers/google/aiplatform/index_endpoints/index.md +++ b/docs/google-docs/providers/google/aiplatform/index_endpoints/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 IndexEndpoint. | | `description` | `string` | The description of the IndexEndpoint. | -| `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. | -| `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. | -| `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. | -| `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. | -| `deployedIndexes` | `array` | Output only. The indexes deployed in this endpoint. | | `createTime` | `string` | Output only. Timestamp when this IndexEndpoint was created. | +| `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. | -| `privateServiceConnectConfig` | `object` | Represents configuration for private service connect. | +| `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. | +| `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. | | `publicEndpointEnabled` | `boolean` | Optional. If true, the deployed index will be accessible through public endpoint. | +| `privateServiceConnectConfig` | `object` | Represents configuration for private service connect. | +| `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. | +| `deployedIndexes` | `array` | Output only. The indexes deployed in this endpoint. | +| `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. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | ## 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 b860704275..53101ca460 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. | -| `metadata` | `any` | An additional information about the Index; the schema of the metadata can be found in metadata_schema. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `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. | +| `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. | | `indexStats` | `object` | Stats of the Index. | | `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. | -| `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. | | `indexUpdateMethod` | `string` | Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. | +| `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. | | `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. | -| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `createTime` | `string` | Output only. Timestamp when this Index was created. | -| `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. | -| `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. | ## 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..65a3c83d6a 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 | +| `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) | | `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. | ## 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 9fcae7d830..ca8aa6f735 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. | -| `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. | -| `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. | -| `modelDeploymentMonitoringScheduleConfig` | `object` | The config for scheduling monitoring job. | -| `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 | | `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. | -| `updateTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. | +| `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 | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `statsAnomaliesBaseDirectory` | `object` | The Google Cloud Storage location where the output is to be written to. | -| `modelDeploymentMonitoringObjectiveConfigs` | `array` | Required. The config for monitoring objectives. This is a per DeployedModel config. Each DeployedModel needs to be configured separately. | -| `nextScheduleTime` | `string` | Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. | -| `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. | -| `modelMonitoringAlertConfig` | `object` | | -| `loggingSamplingStrategy` | `object` | Sampling Strategy for logging, can be for both training and prediction dataset. | | `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. | | `scheduleState` | `string` | Output only. Schedule state when the monitoring job is in Running state. | +| `modelMonitoringAlertConfig` | `object` | | +| `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. | +| `createTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was created. | +| `endpoint` | `string` | Required. Endpoint resource name. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` | +| `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. | | `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). | +| `modelDeploymentMonitoringScheduleConfig` | `object` | The config for scheduling monitoring job. | +| `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. | | `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. | +| `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. | +| `nextScheduleTime` | `string` | Output only. Timestamp when this monitoring pipeline will be scheduled to run for the next round. | | `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'. | -| `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. | -| `createTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was created. | | `latestMonitoringPipelineMetadata` | `object` | All metadata of most recent monitoring pipelines. | +| `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. | +| `updateTime` | `string` | Output only. Timestamp when this ModelDeploymentMonitoringJob was updated most recently. | ## 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 2b048e0dca..412b03c3a1 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. | -| `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. | -| `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. | -| `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. | -| `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. | -| `modelSourceInfo` | `object` | Detail description of the source information of the model. | -| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | -| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | -| `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 Model. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. | | `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. | -| `explanationSpec` | `object` | Specification of Model explanation. | | `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. | -| `supportedExportFormats` | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. | -| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | +| `explanationSpec` | `object` | Specification of Model explanation. | +| `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | +| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | +| `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. | | `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. | -| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | +| `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | +| `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). | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | | `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. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | -| `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. | +| `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | +| `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}`. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `modelSourceInfo` | `object` | Detail description of the source information of the model. | | `updateTime` | `string` | Output only. Timestamp when this Model was most recently updated. | -| `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. | | `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | -| `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). | +| `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. | +| `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. | +| `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. | +| `supportedExportFormats` | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. | +| `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. | +| `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | +| `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. | +| `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. | ## 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 f320aa1355..13ee811b57 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. | -| `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. | -| `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. | -| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `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. | -| `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. | -| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | +| `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). | | `versionCreateTime` | `string` | Output only. Timestamp when this version was created. | -| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | | `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. | -| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | -| `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). | +| `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}`. | +| `updateTime` | `string` | Output only. Timestamp when this Model was most recently updated. | +| `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. | +| `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. | | `modelSourceInfo` | `object` | Detail description of the source information of the model. | | `versionUpdateTime` | `string` | Output only. Timestamp when this version was most recently updated. | -| `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. | -| `explanationSpec` | `object` | Specification of Model explanation. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `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. | +| `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. | | `createTime` | `string` | Output only. Timestamp when this Model was uploaded into Vertex AI. | -| `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}`. | -| `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. | -| `updateTime` | `string` | Output only. Timestamp when this Model was most recently updated. | -| `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. | -| `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. | +| `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. | | `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. | | `predictSchemata` | `object` | Contains the schemata used in Model's predictions and explanations via PredictionService.Predict, PredictionService.Explain and BatchPredictionJob. | +| `pipelineJob` | `string` | Optional. This field is populated if the model is produced by a pipeline job. | +| `etag` | `string` | Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `originalModelInfo` | `object` | Contains information about the original Model if this Model is a copy. | +| `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. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `trainingPipeline` | `string` | Output only. The resource name of the TrainingPipeline that uploaded this Model, if any. | +| `supportedExportFormats` | `array` | Output only. The formats in which this Model may be exported. If empty, this Model is not available for export. | +| `versionDescription` | `string` | The description of this version. | +| `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. | +| `explanationSpec` | `object` | Specification of Model explanation. | | `deployedModels` | `array` | Output only. The pointers to DeployedModels created from this Model. Note that Model could have been deployed to Endpoints in different Locations. | +| `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. | ## 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 d5c2d93eb2..f77bf9b8fd 100644 --- a/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/nas_jobs/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the NasJob. | -| `nasJobSpec` | `object` | Represents the spec of a NasJob. | | `updateTime` | `string` | Output only. Time when the NasJob was most recently updated. | | `createTime` | `string` | Output only. Time when the NasJob was created. | -| `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. | +| `startTime` | `string` | Output only. Time when the NasJob for the first time entered the `JOB_STATE_RUNNING` state. | +| `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. | | `nasJobOutput` | `object` | Represents a uCAIP NasJob output. | -| `endTime` | `string` | Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | | `enableRestrictedImageTraining` | `boolean` | Optional. Enable a separation of Custom model training and restricted image training for tenant project. | -| `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. | -| `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. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `nasJobSpec` | `object` | Represents the spec of a NasJob. | +| `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). | +| `endTime` | `string` | Output only. Time when the NasJob entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/operations/index.md b/docs/google-docs/providers/google/aiplatform/operations/index.md index bcf8d19605..731ad6ad17 100644 --- a/docs/google-docs/providers/google/aiplatform/operations/index.md +++ b/docs/google-docs/providers/google/aiplatform/operations/index.md @@ -35,9 +35,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `deploymentResourcePoolsId, locationsId, 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. | -| `list` | `SELECT` | `deploymentResourcePoolsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `delete` | `DELETE` | `deploymentResourcePoolsId, locationsId, operationsId, projectsId` | 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`. | -| `_list` | `EXEC` | `deploymentResourcePoolsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `cancel` | `EXEC` | `deploymentResourcePoolsId, locationsId, 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. 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`. | -| `wait` | `EXEC` | `deploymentResourcePoolsId, locationsId, operationsId, projectsId` | Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. | +| `get` | `SELECT` | `locationsId, 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. | +| `list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | +| `_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `cancel` | `EXEC` | `locationsId, 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. 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`. | +| `wait` | `EXEC` | `locationsId, operationsId, projectsId` | Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. | 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 402138070d..16bd598a75 100644 --- a/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md +++ b/docs/google-docs/providers/google/aiplatform/pipeline_jobs/index.md @@ -28,24 +28,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the PipelineJob. | -| `pipelineSpec` | `object` | The spec of the pipeline. | -| `createTime` | `string` | Output only. Pipeline creation time. | -| `startTime` | `string` | Output only. Pipeline start time. | -| `scheduleName` | `string` | Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. | -| `templateUri` | `string` | A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. | -| `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']. | -| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `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. | -| `state` | `string` | Output only. The detailed state of the job. | -| `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. | +| `templateUri` | `string` | A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. | | `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). | -| `endTime` | `string` | Output only. Pipeline end time. | +| `state` | `string` | Output only. The detailed state of the job. | | `updateTime` | `string` | Output only. Timestamp when this PipelineJob was most recently updated. | -| `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. | +| `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | | `jobDetail` | `object` | The runtime detail of PipelineJob. | -| `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. | +| `createTime` | `string` | Output only. Pipeline creation time. | | `templateMetadata` | `object` | Pipeline template metadata if PipelineJob.template_uri is from supported template registry. Currently, the only supported registry is Artifact Registry. | +| `scheduleName` | `string` | Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. | +| `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. | +| `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. | +| `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']. | +| `pipelineSpec` | `object` | The spec of the pipeline. | +| `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. | +| `endTime` | `string` | Output only. Pipeline end time. | ## 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..e8b0089afd 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. | ## 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 59389a16c3..44d23ec418 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. | -| `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. | | `metadata` | `any` | Some additional information about 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 | +| `supportAutomlTraining` | `boolean` | Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training. | | `updateTime` | `string` | Output only. Timestamp when SavedQuery was last updated. | -| `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. | | `etag` | `string` | Used to perform a consistent read-modify-write update. If not set, a blind "overwrite" update happens. | -| `supportAutomlTraining` | `boolean` | Output only. If the Annotations belonging to the SavedQuery can be used for AutoML training. | -| `createTime` | `string` | Output only. Timestamp when this SavedQuery was created. | -| `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 | +| `annotationFilter` | `string` | Output only. Filters on the Annotations in the dataset. | +| `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. | ## 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 cebd08c054..1e6f86b792 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. | -| `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. | -| `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. | -| `updateTime` | `string` | Output only. Timestamp when this Schedule was updated. | -| `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. | | `startTime` | `string` | Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified. | -| `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. | -| `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). | -| `startedRunCount` | `string` | Output only. The number of runs started by this 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. | -| `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 * * * *". | -| `createTime` | `string` | Output only. Timestamp when this Schedule was created. | -| `state` | `string` | Output only. The state of this Schedule. | | `lastScheduledRunResponse` | `object` | Status of a scheduled run. | +| `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. | | `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. | +| `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 * * * *". | +| `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. | +| `startedRunCount` | `string` | Output only. The number of runs started by this schedule. | +| `createPipelineJobRequest` | `object` | Request message for PipelineService.CreatePipelineJob. | +| `updateTime` | `string` | Output only. Timestamp when this Schedule was updated. | | `lastResumeTime` | `string` | Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause. | +| `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. | +| `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. | +| `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. | | `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. | +| `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). | +| `state` | `string` | Output only. The state of this Schedule. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/aiplatform/slices/index.md b/docs/google-docs/providers/google/aiplatform/slices/index.md index 1326a75f1e..9c137a7304 100644 --- a/docs/google-docs/providers/google/aiplatform/slices/index.md +++ b/docs/google-docs/providers/google/aiplatform/slices/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 ModelEvaluationSlice. | -| `metrics` | `any` | Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri | -| `metricsSchemaUri` | `string` | Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). | | `modelExplanation` | `object` | Aggregated explanation metrics for a Model over a set of instances. | | `slice` | `object` | Definition of a slice. | | `createTime` | `string` | Output only. Timestamp when this ModelEvaluationSlice was created. | +| `metrics` | `any` | Output only. Sliced evaluation metrics of the Model. The schema of the metrics is stored in metrics_schema_uri | +| `metricsSchemaUri` | `string` | Output only. Points to a YAML file stored on Google Cloud Storage describing the metrics of this ModelEvaluationSlice. The schema is defined as an OpenAPI 3.0.2 [Schema Object](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). | ## 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 70a0a43118..e44b2af606 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. | -| `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. | | `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. | ## 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 712e726fc0..eefa44c0c2 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 6b362b9616..30e50e6c2b 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. | +| `displayName` | `string` | Required. User provided name of this Tensorboard. | +| `runCount` | `integer` | Output only. The number of Runs stored in 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 '/'. | | `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. | | `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | -| `createTime` | `string` | Output only. Timestamp when this Tensorboard was created. | -| `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. | | `updateTime` | `string` | Output only. Timestamp when this Tensorboard was last updated. | -| `displayName` | `string` | Required. User provided name of this Tensorboard. | -| `runCount` | `integer` | Output only. The number of Runs stored in this Tensorboard. | | `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 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. | +| `createTime` | `string` | Output only. Timestamp when this Tensorboard was created. | ## 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 7df6bb8d10..4f9248fc59 100644 --- a/docs/google-docs/providers/google/aiplatform/time_series/index.md +++ b/docs/google-docs/providers/google/aiplatform/time_series/index.md @@ -30,12 +30,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Output only. Name of the TensorboardTimeSeries. | | `description` | `string` | Description of this TensorboardTimeSeries. | | `metadata` | `object` | Describes metadata for a TensorboardTimeSeries. | -| `pluginData` | `string` | Data of the current plugin, with the size limited to 65KB. | -| `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 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). | | `pluginName` | `string` | Immutable. Name of the plugin this time series pertain to. Such as Scalar, Tensor, Blob | | `updateTime` | `string` | Output only. Timestamp when this TensorboardTimeSeries was last updated. | +| `etag` | `string` | Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. | +| `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). | +| `pluginData` | `string` | Data of the current plugin, with the size limited to 65KB. | +| `valueType` | `string` | Required. Immutable. Type of TensorboardTimeSeries value. | | `createTime` | `string` | Output only. Timestamp when this TensorboardTimeSeries was created. | ## 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 9c884caa1b..47a2aecb46 100644 --- a/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md +++ b/docs/google-docs/providers/google/aiplatform/training_pipelines/index.md @@ -28,22 +28,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of the TrainingPipeline. | +| `trainingTaskInputs` | `any` | Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`. | +| `createTime` | `string` | Output only. Time when the TrainingPipeline was created. | +| `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. | | `state` | `string` | Output only. The detailed state of the pipeline. | -| `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). | | `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. | -| `modelToUpload` | `object` | A trained machine learning Model. | -| `trainingTaskInputs` | `any` | Required. The training task's parameter(s), as specified in the training_task_definition's `inputs`. | -| `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. | -| `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`. | -| `startTime` | `string` | Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state. | -| `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. | -| `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. | | `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. | +| `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). | | `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. | -| `updateTime` | `string` | Output only. Time when the TrainingPipeline was most recently updated. | +| `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. | +| `startTime` | `string` | Output only. Time when the TrainingPipeline for the first time entered the `PIPELINE_STATE_RUNNING` state. | | `encryptionSpec` | `object` | Represents a customer-managed encryption key spec that can be applied to a top-level resource. | +| `updateTime` | `string` | Output only. Time when the TrainingPipeline was most recently updated. | +| `endTime` | `string` | Output only. Time when the TrainingPipeline entered any of the following states: `PIPELINE_STATE_SUCCEEDED`, `PIPELINE_STATE_FAILED`, `PIPELINE_STATE_CANCELLED`. | +| `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`. | ## 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 0211127312..db5eb8e820 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. | -| `finalMeasurement` | `object` | A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. | -| `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. | -| `state` | `string` | Output only. The detailed state of the 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`. | -| `endTime` | `string` | Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`. | +| `parameters` | `array` | Output only. The parameters 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. | | `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. | | `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. | +| `finalMeasurement` | `object` | A message representing a Measurement of a Trial. A Measurement contains the Metrics got by executing a Trial using suggested hyperparameter values. | +| `state` | `string` | Output only. The detailed state of the Trial. | +| `customJob` | `string` | Output only. The CustomJob name linked to the Trial. It's set for a HyperparameterTuningJob's Trial. | +| `endTime` | `string` | Output only. Time when the Trial's status changed to `SUCCEEDED` or `INFEASIBLE`. | ## 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 ca20548da0..79f1c388d7 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. | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 36c7dea069..03e518b67b 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 3923ec2eea..fc876052f5 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`. | -| `state` | `string` | Output only. Current state of the subscription. | -| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | -| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | -| `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. | +| `subscriberContact` | `string` | Output only. Email of the subscriber. | | `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. | +| `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 | +| `state` | `string` | Output only. Current state of the subscription. | +| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/analyticshub/index.md b/docs/google-docs/providers/google/analyticshub/index.md index ec87908819..36ba08d6d5 100644 --- a/docs/google-docs/providers/google/analyticshub/index.md +++ b/docs/google-docs/providers/google/analyticshub/index.md @@ -33,7 +33,7 @@ Exchange Data And Analytics Assets Securely And Efficiently. TypeService TitleAnalytics Hub API DescriptionExchange Data And Analytics Assets Securely And Efficiently. -Idanalyticshub:v23.08.00161 +Idanalyticshub:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/analyticshub/listings/index.md b/docs/google-docs/providers/google/analyticshub/listings/index.md index 55ca403564..d9cbf54027 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. | +| `categories` | `array` | Optional. Categories of the listing. Up to two categories are allowed. | +| `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. | +| `documentation` | `string` | Optional. Documentation describing the listing. | | `restrictedExportConfig` | `object` | Restricted export config, used to configure restricted export on linked dataset. | -| `state` | `string` | Output only. Current state of the listing. | +| `dataProvider` | `object` | Contains details of the data provider. | | `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. | +| `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. | +| `state` | `string` | Output only. Current state of the listing. | | `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. | | `primaryContact` | `string` | Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes. | -| `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. | -| `categories` | `array` | Optional. Categories of the listing. Up to two categories are allowed. | -| `dataProvider` | `object` | Contains details of the data provider. | -| `documentation` | `string` | Optional. Documentation describing the listing. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md b/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md index 6da0f646cc..90aa58e9ef 100644 --- a/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md +++ b/docs/google-docs/providers/google/analyticshub/listings_iam_policies/index.md @@ -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/analyticshub/listings_subscriptions/index.md b/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md index 75ecc0d32e..a39d5f1e48 100644 --- a/docs/google-docs/providers/google/analyticshub/listings_subscriptions/index.md +++ b/docs/google-docs/providers/google/analyticshub/listings_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`. | -| `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. | -| `listing` | `string` | Output only. Resource name of the source Listing. e.g. projects/123/locations/US/dataExchanges/456/listings/789 | | `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. | +| `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. | | `creationTime` | `string` | Output only. Timestamp when the subscription was created. | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | | `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | -| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | +| `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 bfac95d9f1..0e20279b27 100644 --- a/docs/google-docs/providers/google/analyticshub/subscriptions/index.md +++ b/docs/google-docs/providers/google/analyticshub/subscriptions/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 of the subscription. e.g. `projects/myproject/locations/US/subscriptions/123`. | -| `organizationDisplayName` | `string` | Output only. Display name of the project of this subscription. | +| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | | `state` | `string` | Output only. Current state of the subscription. | -| `subscriberContact` | `string` | Output only. Email of the subscriber. | -| `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 | +| `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 | -| `lastModifyTime` | `string` | Output only. Timestamp when the subscription was last modified. | -| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | | `creationTime` | `string` | Output only. Timestamp when the subscription was created. | +| `organizationId` | `string` | Output only. Organization of the project this subscription belongs to. | +| `dataExchange` | `string` | Output only. Resource name of the source Data Exchange. e.g. projects/123/locations/US/dataExchanges/456 | +| `subscriberContact` | `string` | Output only. Email of the subscriber. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_subscriptions_get` | `SELECT` | `locationsId, projectsId, subscriptionsId` | Gets the details of a Subscription. | | `projects_locations_subscriptions_list` | `SELECT` | `locationsId, projectsId` | Lists all subscriptions in a given project and location. | | `projects_locations_subscriptions_delete` | `DELETE` | `locationsId, projectsId, subscriptionsId` | Deletes a subscription. | | `_projects_locations_subscriptions_list` | `EXEC` | `locationsId, projectsId` | Lists all subscriptions in a given project and location. | -| `projects_locations_subscriptions_get` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Gets the details of a Subscription. | | `projects_locations_subscriptions_refresh` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets. | | `projects_locations_subscriptions_revoke` | `EXEC` | `locationsId, projectsId, subscriptionsId` | Revokes a given subscription. | diff --git a/docs/google-docs/providers/google/apigateway/apis/index.md b/docs/google-docs/providers/google/apigateway/apis/index.md index c4988b4417..7b7b66c91e 100644 --- a/docs/google-docs/providers/google/apigateway/apis/index.md +++ b/docs/google-docs/providers/google/apigateway/apis/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 the API. Format: projects/{project}/locations/global/apis/{api} | +| `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 | +| `managedService` | `string` | Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API. | | `state` | `string` | Output only. State of the API. | | `updateTime` | `string` | Output only. Updated time. | | `createTime` | `string` | Output only. Created time. | | `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 | -| `managedService` | `string` | Optional. Immutable. The name of a Google Managed Service ( https://cloud.google.com/service-infrastructure/docs/glossary#managed). If not specified, a new Service will automatically be created in the same project as this API. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 593dedb8bf..da05547258 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/configs/index.md b/docs/google-docs/providers/google/apigateway/configs/index.md index 674e14f284..32fc4a8b11 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} | +| `grpcServices` | `array` | Optional. gRPC service definition files. If specified, openapi_documents must not be included. | +| `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 | +| `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. | +| `displayName` | `string` | Optional. Display name. | +| `openapiDocuments` | `array` | Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. | | `serviceConfigId` | `string` | Output only. The ID of the associated Service Config ( https://cloud.google.com/service-infrastructure/docs/glossary#config). | | `state` | `string` | Output only. State of the API 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. | | `updateTime` | `string` | Output only. Updated time. | | `createTime` | `string` | Output only. Created time. | -| `displayName` | `string` | Optional. Display name. | -| `openapiDocuments` | `array` | Optional. OpenAPI specification documents. If specified, grpc_services and managed_service_configs must not be included. | -| `grpcServices` | `array` | Optional. gRPC service definition files. If specified, openapi_documents must not be included. | | `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. | -| `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 | ## 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..068e834a30 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} | +| `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`. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md b/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md index 7392728098..6d3f6ac403 100644 --- a/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigateway/gateways_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigateway/index.md b/docs/google-docs/providers/google/apigateway/index.md index 80a7156a91..a17bfdea49 100644 --- a/docs/google-docs/providers/google/apigateway/index.md +++ b/docs/google-docs/providers/google/apigateway/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleAPI Gateway API Description -Idapigateway:v23.08.00161 +Idapigateway:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/apigee/admin_schemav2/index.md b/docs/google-docs/providers/google/apigee/admin_schemav2/index.md index d82c16450b..ff70bc4496 100644 --- a/docs/google-docs/providers/google/apigee/admin_schemav2/index.md +++ b/docs/google-docs/providers/google/apigee/admin_schemav2/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `dimensions` | `array` | List of schema fields grouped as dimensions. | | `meta` | `array` | Additional metadata associated with schema. This is a legacy field and usually consists of an empty array of strings. | | `metrics` | `array` | List of schema fields grouped as dimensions that can be used with an aggregate function such as `sum`, `avg`, `min`, and `max`. | -| `dimensions` | `array` | List of schema fields grouped as dimensions. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 0368e42158..e6939f879b 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 | |:-----|:---------|:------------| +| `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/apigee/apicategories/index.md b/docs/google-docs/providers/google/apigee/apicategories/index.md index f14e25d40f..58effbf0d4 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 | |:-----|:---------|:------------| +| `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. | | `status` | `string` | Status of the operation. | -| `data` | `array` | Details of categories. | -| `errorCode` | `string` | ID that can be used to find errors in the log files. | +| `data` | `object` | the Api category resource. | ## 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 8eb4ab73ba..5380303101 100644 --- a/docs/google-docs/providers/google/apigee/apiproducts/index.md +++ b/docs/google-docs/providers/google/apigee/apiproducts/index.md @@ -25,26 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `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. | -| `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. | -| `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. | -| `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. | -| `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`. | -| `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. | -| `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. | -| `lastModifiedAt` | `string` | Response only. Modified time of this environment as milliseconds since epoch. | -| `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. | -| `grpcOperationGroup` | `object` | List of gRPC operation configuration details associated with Apigee API proxies. | -| `quotaInterval` | `string` | Time interval over which the number of request messages is calculated. | -| `createdAt` | `string` | Response only. Creation time of this environment as milliseconds since epoch. | -| `displayName` | `string` | Name displayed in the UI or developer portal to developers registering for API access. | -| `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. | -| `quotaTimeUnit` | `string` | Time unit defined for the `quotaInterval`. Valid values include `minute`, `hour`, `day`, or `month`. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/apis/index.md b/docs/google-docs/providers/google/apigee/apis/index.md index 7118b1a12d..bf659227e0 100644 --- a/docs/google-docs/providers/google/apigee/apis/index.md +++ b/docs/google-docs/providers/google/apigee/apis/index.md @@ -25,11 +25,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. Name of the API proxy. | +| `metaData` | `object` | Metadata common to many entities in this API. | +| `readOnly` | `boolean` | Output only. Whether this proxy is read-only. A read-only proxy cannot have new revisions created through calls to CreateApiProxyRevision. A proxy is read-only if it was generated by an archive. | +| `revision` | `array` | Output only. List of revisions defined for the API proxy. | +| `apiProxyType` | `string` | Output only. The type of the API proxy. | +| `labels` | `object` | User labels applied to this API Proxy. | +| `latestRevisionId` | `string` | Output only. The id of the most recently created revision for this api proxy. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `organizations_apis_get` | `SELECT` | `apisId, organizationsId` | Gets an API proxy including a list of existing revisions. | | `organizations_apis_list` | `SELECT` | `organizationsId` | Lists the names of all API proxies in an organization. The names returned correspond to the names defined in the configuration files for each API proxy. | | `organizations_apis_create` | `INSERT` | `organizationsId` | Creates an API proxy. The API proxy created will not be accessible at runtime until it is deployed to an environment. Create a new API proxy by setting the `name` query parameter to the name of the API proxy. Import an API proxy configuration bundle stored in zip format on your local machine to your organization by doing the following: * Set the `name` query parameter to the name of the API proxy. * Set the `action` query parameter to `import`. * Set the `Content-Type` header to `multipart/form-data`. * Pass as a file the name of API proxy configuration bundle stored in zip format on your local machine using the `file` form field. **Note**: To validate the API proxy configuration bundle only without importing it, set the `action` query parameter to `validate`. When importing an API proxy configuration bundle, if the API proxy does not exist, it will be created. If the API proxy exists, then a new revision is created. Invalid API proxy configurations are rejected, and a list of validation errors is returned to the client. | | `organizations_apis_delete` | `DELETE` | `apisId, organizationsId` | Deletes an API proxy and all associated endpoints, policies, resources, and revisions. The API proxy must be undeployed before you can delete it. | -| `organizations_apis_get` | `EXEC` | `apisId, organizationsId` | Gets an API proxy including a list of existing revisions. | | `organizations_apis_patch` | `EXEC` | `apisId, organizationsId` | Updates an existing API proxy. | diff --git a/docs/google-docs/providers/google/apigee/appgroups/index.md b/docs/google-docs/providers/google/apigee/appgroups/index.md index 3d5bd683bd..fe62830c50 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._\-$ %. | -| `attributes` | `array` | A list of attributes | +| `appGroupId` | `string` | Output only. Internal identifier that cannot be edited | +| `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`. | | `createdAt` | `string` | Output only. Created time as milliseconds since epoch. | -| `channelId` | `string` | channel identifier identifies the owner maintaing this grouping. | -| `lastModifiedAt` | `string` | Output only. Modified time as milliseconds since epoch. | | `organization` | `string` | Immutable. the org the app group is created | | `channelUri` | `string` | A reference to the associated storefront/marketplace. | | `displayName` | `string` | app group name displayed in the UI | -| `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`. | -| `appGroupId` | `string` | Output only. Internal identifier that cannot be edited | +| `attributes` | `array` | A list of attributes | +| `lastModifiedAt` | `string` | Output only. Modified time as milliseconds since epoch. | +| `channelId` | `string` | channel identifier identifies the owner maintaing this grouping. | ## 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 9a7746c14e..1efee6a61a 100644 --- a/docs/google-docs/providers/google/apigee/apps/index.md +++ b/docs/google-docs/providers/google/apigee/apps/index.md @@ -25,6 +25,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*). | +| `callbackUrl` | `string` | Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps. | +| `scopes` | `array` | Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app. | +| `appGroup` | `string` | Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*). | +| `createdAt` | `string` | Output only. Time the AppGroup app was created in milliseconds since epoch. | +| `status` | `string` | Status of the App. Valid values include `approved` or `revoked`. | +| `appId` | `string` | Immutable. ID of the AppGroup app. | +| `attributes` | `array` | List of attributes for the AppGroup app. | +| `credentials` | `array` | Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products. | +| `apiProducts` | `array` | List of API products associated with the AppGroup app. | +| `keyExpiresIn` | `string` | Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. | +| `lastModifiedAt` | `string` | Output only. Time the AppGroup app was modified in milliseconds since epoch. | ## 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 fe1c237014..72555f96f5 100644 --- a/docs/google-docs/providers/google/apigee/archive_deployments/index.md +++ b/docs/google-docs/providers/google/apigee/archive_deployments/index.md @@ -28,19 +28,19 @@ 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. | -| `gcsUri` | `string` | Input only. The Google Cloud Storage signed URL returned from GenerateUploadUrl and used to upload the Archive zip file. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `organizations_environments_archive_deployments_get` | `SELECT` | `archiveDeploymentsId, environmentsId, organizationsId` | Gets the specified ArchiveDeployment. | | `organizations_environments_archive_deployments_list` | `SELECT` | `environmentsId, organizationsId` | Lists the ArchiveDeployments in the specified Environment. | | `organizations_environments_archive_deployments_create` | `INSERT` | `environmentsId, organizationsId` | Creates a new ArchiveDeployment. | | `organizations_environments_archive_deployments_delete` | `DELETE` | `archiveDeploymentsId, environmentsId, organizationsId` | Deletes an archive deployment. | | `_organizations_environments_archive_deployments_list` | `EXEC` | `environmentsId, organizationsId` | Lists the ArchiveDeployments in the specified Environment. | | `organizations_environments_archive_deployments_generate_download_url` | `EXEC` | `archiveDeploymentsId, environmentsId, organizationsId` | Generates a signed URL for downloading the original zip file used to create an Archive Deployment. The URL is only valid for a limited period and should be used within minutes after generation. Each call returns a new upload URL. | | `organizations_environments_archive_deployments_generate_upload_url` | `EXEC` | `environmentsId, organizationsId` | Generates a signed URL for uploading an Archive zip file to Google Cloud Storage. Once the upload is complete, the signed URL should be passed to CreateArchiveDeployment. When uploading to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 1GB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * `content-type: application/zip` * `x-goog-content-length-range: 0,1073741824` And this header SHOULD NOT be specified: * `Authorization: Bearer YOUR_TOKEN` | -| `organizations_environments_archive_deployments_get` | `EXEC` | `archiveDeploymentsId, environmentsId, organizationsId` | Gets the specified ArchiveDeployment. | | `organizations_environments_archive_deployments_patch` | `EXEC` | `archiveDeploymentsId, environmentsId, organizationsId` | Updates an existing ArchiveDeployment. Labels can modified but most of the other fields are not modifiable. | diff --git a/docs/google-docs/providers/google/apigee/attachments/index.md b/docs/google-docs/providers/google/apigee/attachments/index.md index f30daef069..b90b14836d 100644 --- a/docs/google-docs/providers/google/apigee/attachments/index.md +++ b/docs/google-docs/providers/google/apigee/attachments/index.md @@ -27,9 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | Output only. ID of the attachment. | -| `createdAt` | `string` | Output only. Time the attachment was created in milliseconds since epoch. | -| `environment` | `string` | ID of the attached environment. | +| `name` | `string` | ID of the environment group attachment. | +| `environmentGroupId` | `string` | Output only. ID of the environment group. | +| `createdAt` | `string` | Output only. The time at which the environment group attachment was created as milliseconds since epoch. | +| `environment` | `string` | Required. ID of the attached environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/attributes/index.md b/docs/google-docs/providers/google/apigee/attributes/index.md index 8dcacb6447..e762b853f0 100644 --- a/docs/google-docs/providers/google/apigee/attributes/index.md +++ b/docs/google-docs/providers/google/apigee/attributes/index.md @@ -25,10 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | API key of the attribute. | -| `value` | `string` | Value of the attribute. | ## 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 6919a9a7b9..a175791bbd 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. | +| `createTime` | `string` | Output only. Create time of the canary evaluation. | +| `startTime` | `string` | Required. Start time for the canary evaluation's analysis. | | `verdict` | `string` | Output only. The resulting verdict of the canary evaluations: NONE, PASS, or FAIL. | -| `endTime` | `string` | Required. End time for the evaluation's analysis. | -| `treatment` | `string` | Required. The newer version that is serving requests. | | `metricLabels` | `object` | Labels that can be used to filter Apigee metrics. | | `control` | `string` | Required. The stable version that is serving requests. | -| `createTime` | `string` | Output only. Create time of the canary evaluation. | +| `treatment` | `string` | Required. The newer version that is serving requests. | +| `endTime` | `string` | Required. End time for the evaluation's analysis. | | `state` | `string` | Output only. The current state of the canary evaluation. | -| `startTime` | `string` | Required. Start time for the canary 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 b7f962295f..8c003626d4 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 | |:-----|:---------|:------------| +| `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 | -| `self` | `string` | Output only. Resource link of Datastore. Example: `/organizations/{org}/analytics/datastores/{uuid}` | -| `targetType` | `string` | Destination storage type. Supported types `gcs` or `bigquery`. | ## 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 e03b018530..af8d26afda 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`. | -| `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. | | `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. | ## 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 1166ecbf79..a5a509485d 100644 --- a/docs/google-docs/providers/google/apigee/developers/index.md +++ b/docs/google-docs/providers/google/apigee/developers/index.md @@ -25,6 +25,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `appFamily` | `string` | Developer app family. | +| `status` | `string` | Output only. Status of the developer. Valid values are `active` and `inactive`. | +| `accessType` | `string` | Access type. | +| `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. | +| `lastName` | `string` | Required. Last name of the developer. | +| `userName` | `string` | Required. User name of the developer. Not used by Apigee hybrid. | +| `companies` | `array` | List of companies associated with the developer. | +| `attributes` | `array` | Optional. Developer attributes (name/value pairs). The custom attribute limit is 18. | +| `developerId` | `string` | ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time. | +| `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. | +| `organizationName` | `string` | Output only. Name of the Apigee organization in which the developer resides. | +| `firstName` | `string` | Required. First name of the developer. | +| `apps` | `array` | List of apps associated with 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 67c20080a7..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}` | -| `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. | | `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/* | ## 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..b2161d08e8 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. | +| `revisionId` | `string` | Revision id that defines the ordering of the EnvironmentGroupConfig resource. The higher the revision, the more recently the configuration was deployed. | ## 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 9936bf9ea1..e1390fc1af 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. | -| `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 | +| `properties` | `object` | Message for compatibility with legacy Edge specification for Java Properties object in JSON. | +| `lastModifiedAt` | `string` | Output only. Last modification time of this environment as milliseconds since epoch. | | `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. | | `hasAttachedFlowHooks` | `boolean` | | -| `displayName` | `string` | Optional. Display name for this environment. | -| `lastModifiedAt` | `string` | Output only. Last modification 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. | | `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 | +| `createdAt` | `string` | Output only. Creation time of this environment as milliseconds since epoch. | +| `displayName` | `string` | Optional. Display name for this environment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/environments_debugmask/index.md b/docs/google-docs/providers/google/apigee/environments_debugmask/index.md index e16af9f050..931ff66927 100644 --- a/docs/google-docs/providers/google/apigee/environments_debugmask/index.md +++ b/docs/google-docs/providers/google/apigee/environments_debugmask/index.md @@ -25,9 +25,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Name of the debug mask. | +| `variables` | `array` | List of variables that should be masked from the debug output. | +| `faultXPaths` | `array` | List of XPaths that specify the XML elements to be filtered from XML payloads in error flows. | +| `namespaces` | `object` | Map of namespaces to URIs. | +| `requestJSONPaths` | `array` | List of JSON paths that specify the JSON elements to be filtered from JSON request message payloads. | +| `faultJSONPaths` | `array` | List of JSON paths that specify the JSON elements to be filtered from JSON payloads in error flows. | +| `responseXPaths` | `array` | List of XPaths that specify the XML elements to be filtered from XML response message payloads. | +| `responseJSONPaths` | `array` | List of JSON paths that specify the JSON elements to be filtered from JSON response message payloads. | +| `requestXPaths` | `array` | List of XPaths that specify the XML elements to be filtered from XML request message payloads. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `organizations_environments_get_debugmask` | `EXEC` | `environmentsId, organizationsId` | Gets the debug mask singleton resource for an environment. | +| `organizations_environments_get_debugmask` | `SELECT` | `environmentsId, organizationsId` | Gets the debug mask singleton resource for an environment. | | `organizations_environments_update_debugmask` | `EXEC` | `environmentsId, organizationsId` | Updates the debug mask singleton resource for an environment. | diff --git a/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md b/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md index 7525744e11..c03e040ffc 100644 --- a/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md +++ b/docs/google-docs/providers/google/apigee/environments_deployed_config/index.md @@ -25,8 +25,31 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Name of the environment configuration in the following format: `organizations/{org}/environments/{env}/configs/{config}` | +| `createTime` | `string` | Time that the environment configuration was created. | +| `uid` | `string` | Unique ID for the environment configuration. The ID will only change if the environment is deleted and recreated. | +| `targets` | `array` | List of target servers in the environment. Disabled target servers are not displayed. | +| `pubsubTopic` | `string` | Name of the PubSub topic for the environment. | +| `featureFlags` | `object` | Feature flags inherited from the organization and environment. | +| `revisionId` | `string` | Revision ID of the environment configuration. The higher the value, the more recently the configuration was deployed. | +| `sequenceNumber` | `string` | DEPRECATED: Use revision_id. | +| `deployments` | `array` | List of deployments in the environment. | +| `gatewayConfigLocation` | `string` | The location for the gateway config blob as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. | +| `keystores` | `array` | List of keystores in the environment. | +| `flowhooks` | `array` | List of flow hooks in the environment. | +| `provider` | `string` | Used by the Control plane to add context information to help detect the source of the document during diagnostics and debugging. | +| `envScopedRevisionId` | `string` | Revision ID for environment-scoped resources (e.g. target servers, keystores) in this config. This ID will increment any time a resource not scoped to a deployment group changes. | +| `traceConfig` | `object` | NEXT ID: 8 RuntimeTraceConfig defines the configurations for distributed trace in an environment. | +| `debugMask` | `object` | | +| `deploymentGroups` | `array` | List of deployment groups in the environment. | +| `resourceReferences` | `array` | List of resource references in the environment. | +| `forwardProxyUri` | `string` | The forward proxy's url to be used by the runtime. When set, runtime will send requests to the target via the given forward proxy. This is only used by programmable gateways. | +| `arcConfigLocation` | `string` | The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways. | +| `resources` | `array` | List of resource versions in the environment. | +| `dataCollectors` | `array` | List of data collectors used by the deployments in the environment. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `organizations_environments_get_deployed_config` | `EXEC` | `environmentsId, organizationsId` | +| `organizations_environments_get_deployed_config` | `SELECT` | `environmentsId, organizationsId` | diff --git a/docs/google-docs/providers/google/apigee/exports/index.md b/docs/google-docs/providers/google/apigee/exports/index.md index aa8b70c1cd..3883d90da1 100644 --- a/docs/google-docs/providers/google/apigee/exports/index.md +++ b/docs/google-docs/providers/google/apigee/exports/index.md @@ -25,17 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Display name of the export job. | -| `description` | `string` | Description of the export job. | -| `updated` | `string` | Output only. Time the export job was last updated. | -| `datastoreName` | `string` | Name of the datastore that is the destination of the export job [datastore] | -| `executionTime` | `string` | Output only. Execution time for this export job. If the job is still in progress, it will be set to the amount of time that has elapsed since`created`, in seconds. Else, it will set to (`updated` - `created`), in seconds. | -| `self` | `string` | Output only. Self link of the export job. A URI that can be used to retrieve the status of an export job. Example: `/organizations/myorg/environments/myenv/analytics/exports/9cfc0d85-0f30-46d6-ae6f-318d0cb961bd` | -| `error` | `string` | Output only. Error is set when export fails | -| `state` | `string` | Output only. Status of the export job. Valid values include `enqueued`, `running`, `completed`, and `failed`. | -| `created` | `string` | Output only. Time the export job was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/flowhooks/index.md b/docs/google-docs/providers/google/apigee/flowhooks/index.md index c8f16a3cfd..5656a588fb 100644 --- a/docs/google-docs/providers/google/apigee/flowhooks/index.md +++ b/docs/google-docs/providers/google/apigee/flowhooks/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | Description of the flow hook. | -| `flowHookPoint` | `string` | Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. | | `sharedFlow` | `string` | Shared flow attached to this flow hook, or empty if there is none attached. | | `continueOnError` | `boolean` | Optional. Flag that specifies whether execution should continue if the flow hook throws an exception. Set to `true` to continue execution. Set to `false` to stop execution if the flow hook throws an exception. Defaults to `true`. | +| `flowHookPoint` | `string` | Output only. Where in the API call flow the flow hook is invoked. Must be one of `PreProxyFlowHook`, `PostProxyFlowHook`, `PreTargetFlowHook`, or `PostTargetFlowHook`. | ## 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..f074e196ab 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 | |:-----|:---------|:------------| -| `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/apigee/host_queries_result_view/index.md b/docs/google-docs/providers/google/apigee/host_queries_result_view/index.md index e74ac9c6f2..7a686466ed 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 | |:-----|:---------|:------------| -| `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` | | +| `rows` | `array` | Rows of query result. Each row is a JSON object. Example: {sum(message_count): 1, developer_app: "(not set)",…} | ## 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 d794659943..1557c5ce91 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 | |:-----|:---------|:------------| -| `queryParams` | `object` | Metadata for the security report. | +| `created` | `string` | Creation time of the query. | | `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | -| `displayName` | `string` | Display Name specified by the user. | | `updated` | `string` | Output only. Last updated timestamp for the query. | -| `resultRows` | `string` | ResultRows is available only after the query is completed. | -| `created` | `string` | Creation time of the query. | -| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | -| `result` | `object` | Contains informations about the security report results. | -| `error` | `string` | Error is set when query fails. | | `reportDefinitionId` | `string` | Report Definition ID. | -| `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | -| `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` | | `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | +| `result` | `object` | Contains informations about the security report results. | +| `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` | +| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | +| `displayName` | `string` | Display Name specified by the user. | +| `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | +| `error` | `string` | Error is set when query fails. | +| `resultRows` | `string` | ResultRows is available only after the query is completed. | +| `queryParams` | `object` | Metadata for the security report. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/host_security_reports_result/index.md b/docs/google-docs/providers/google/apigee/host_security_reports_result/index.md index 8370cc1e67..bd74ecd926 100644 --- a/docs/google-docs/providers/google/apigee/host_security_reports_result/index.md +++ b/docs/google-docs/providers/google/apigee/host_security_reports_result/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/apigee/host_stats/index.md b/docs/google-docs/providers/google/apigee/host_stats/index.md index ad0e4ebbd0..1953093b42 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 | |:-----|:---------|:------------| +| `metaData` | `object` | Encapsulates additional information about query execution. | | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigee/index.md b/docs/google-docs/providers/google/apigee/index.md index 73e6e7c7c4..7c49fe5d41 100644 --- a/docs/google-docs/providers/google/apigee/index.md +++ b/docs/google-docs/providers/google/apigee/index.md @@ -20,7 +20,7 @@ Use The Apigee API To Programmatically Develop And Manage APIs With A Set Of RES
total resources: 90
-total selectable resources: 70
+total selectable resources: 72
total methods: 310
@@ -33,7 +33,7 @@ Use The Apigee API To Programmatically Develop And Manage APIs With A Set Of RES TypeService TitleApigee API DescriptionUse The Apigee API To Programmatically Develop And Manage APIs With A Set Of RESTful Operations. Develop And Secure API Proxies, Deploy And Undeploy API Proxy Revisions, Monitor APIs, Configure Environments, Manage Users, And More. Note: This Product Is Available As A Free Trial For A Time Period Of 60 Days. -Idapigee:v23.08.00161 +Idapigee:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/apigee/instances/index.md b/docs/google-docs/providers/google/apigee/instances/index.md index 74a7d0857a..34bfa94425 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. | -| `displayName` | `string` | Optional. Display name for the instance. | -| `host` | `string` | Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. | -| `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` | -| `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. | -| `state` | `string` | Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. | +| `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`. | | `lastModifiedAt` | `string` | Output only. Time the instance was last modified in milliseconds since epoch. | | `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. | -| `createdAt` | `string` | Output only. Time the instance was created in milliseconds since epoch. | +| `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` | +| `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/([^/]+)` | | `location` | `string` | Required. Compute Engine location where the instance resides. | +| `host` | `string` | Output only. Internal hostname or IP address of the Apigee endpoint used by clients to connect to the service. | +| `createdAt` | `string` | Output only. Time the instance was created in milliseconds since epoch. | +| `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. | | `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. | -| `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/([^/]+)` | -| `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`. | +| `state` | `string` | Output only. State of the instance. Values other than `ACTIVE` means the resource is not ready to use. | +| `displayName` | `string` | Optional. Display name for the instance. | ## 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 21b5397327..39a0000c90 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. | -| `consumerKey` | `string` | Consumer key. | -| `issuedAt` | `string` | Time the developer app was created in milliseconds since epoch. | -| `expiresAt` | `string` | Time the developer app expires in milliseconds since epoch. | -| `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. | +| `consumerKey` | `string` | Immutable. Consumer key. | | `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. | +| `attributes` | `array` | List of attributes associated with the credential. | +| `issuedAt` | `string` | Output only. Time the AppGroup app was created in milliseconds since epoch. | | `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` | Output only. Time the AppGroup app expires in milliseconds since epoch. | +| `apiProducts` | `array` | Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created. | +| `expiresInSeconds` | `string` | Immutable. 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. | ## 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 073529f510..86de28cbfa 100644 --- a/docs/google-docs/providers/google/apigee/operations/index.md +++ b/docs/google-docs/providers/google/apigee/operations/index.md @@ -28,13 +28,13 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `organizations_operations_get` | `SELECT` | `operationsId, organizationsId` | 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. | | `organizations_operations_list` | `SELECT` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_organizations_operations_list` | `EXEC` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `organizations_operations_get` | `EXEC` | `operationsId, organizationsId` | 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. | 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/queries/index.md b/docs/google-docs/providers/google/apigee/queries/index.md index 013d29a9c6..e8bd72c7ce 100644 --- a/docs/google-docs/providers/google/apigee/queries/index.md +++ b/docs/google-docs/providers/google/apigee/queries/index.md @@ -25,21 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Asynchronous Query Name. | -| `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. | -| `envgroupHostname` | `string` | Hostname is available only when query is executed at host level. | -| `queryParams` | `object` | | -| `executionTime` | `string` | ExecutionTime is available only after the query is completed. | -| `error` | `string` | Error is set when query fails. | -| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | -| `resultRows` | `string` | ResultRows is available only after the query is completed. | -| `state` | `string` | Query state could be "enqueued", "running", "completed", "failed". | -| `reportDefinitionId` | `string` | Asynchronous Report ID. | -| `updated` | `string` | Last updated timestamp for the query. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/rateplans/index.md b/docs/google-docs/providers/google/apigee/rateplans/index.md index 79278638e1..04ad54e38d 100644 --- a/docs/google-docs/providers/google/apigee/rateplans/index.md +++ b/docs/google-docs/providers/google/apigee/rateplans/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `ratePlans` | `array` | List of rate plans in an organization. | | `nextStartKey` | `string` | Value that can be sent as `startKey` to retrieve the next page of content. If this field is omitted, there are no subsequent pages. | +| `ratePlans` | `array` | List of rate plans in an organization. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/reports/index.md b/docs/google-docs/providers/google/apigee/reports/index.md index 18085772ba..4ca79cc355 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 | +| `sortOrder` | `string` | Legacy field: not used much. Contains the sort order for the sort columns | | `sortByCols` | `array` | Legacy field: not used much. Contains the list of sort by columns | -| `filter` | `string` | This field contains the filter expression | | `dimensions` | `array` | This contains the list of dimensions for the report | -| `toTime` | `string` | Legacy field: not used. Contains the end time for the report | -| `comments` | `array` | Legacy field: not used. This field contains a list of comments associated with custom report | -| `lastModifiedAt` | `string` | Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt | -| `lastViewedAt` | `string` | Output only. Last viewed time of this entity as milliseconds since epoch | -| `properties` | `array` | This field contains report properties such as ui metadata etc. | -| `metrics` | `array` | Required. This contains the list of metrics | -| `timeUnit` | `string` | This field contains the time unit of aggregation for the report | | `fromTime` | `string` | Legacy field: not used. Contains the from time for the report | -| `organization` | `string` | Output only. Organization name | -| `topk` | `string` | Legacy field: not used. This field contains the top k parameter value for restricting the result | -| `environment` | `string` | Output only. Environment name | -| `createdAt` | `string` | Output only. Unix time when the app was created json key: createdAt | +| `lastModifiedAt` | `string` | Output only. Modified time of this entity as milliseconds since epoch. json key: lastModifiedAt | | `displayName` | `string` | This is the display name 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 | | `limit` | `string` | Legacy field: not used This field contains the limit for the result retrieved | +| `organization` | `string` | Output only. Organization name | +| `timeUnit` | `string` | This field contains the time unit of aggregation for the report | +| `environment` | `string` | Output only. Environment name | +| `chartType` | `string` | This field contains the chart type for the report | | `offset` | `string` | Legacy field: not used. This field contains the offset for the data | +| `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 | +| `metrics` | `array` | Required. This contains the list of metrics | +| `properties` | `array` | This field contains report properties such as ui metadata etc. | +| `topk` | `string` | Legacy field: not used. This field contains the top k parameter value for restricting the result | +| `filter` | `string` | This field contains the filter expression | | `tags` | `array` | Legacy field: not used. This field contains a list of tags associated with custom report | -| `chartType` | `string` | This field contains the chart type for the report | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/resourcefiles/index.md b/docs/google-docs/providers/google/apigee/resourcefiles/index.md index 99583c375a..ded3ac0bc2 100644 --- a/docs/google-docs/providers/google/apigee/resourcefiles/index.md +++ b/docs/google-docs/providers/google/apigee/resourcefiles/index.md @@ -25,6 +25,11 @@ 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. | ## 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 ad06538c33..60f47c6880 100644 --- a/docs/google-docs/providers/google/apigee/revisions_deployments/index.md +++ b/docs/google-docs/providers/google/apigee/revisions_deployments/index.md @@ -27,15 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `apiProxy` | `string` | API proxy. | | `deployStartTime` | `string` | Time the API proxy was marked `deployed` in the control plane in millisconds since epoch. | +| `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}`. | +| `apiProxy` | `string` | API proxy. | | `environment` | `string` | Environment. | -| `revision` | `string` | API proxy revision. | | `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. | -| `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. | | `instances` | `array` | Status reported by each runtime instance. **Note**: This field is displayed only when viewing deployment status. | | `state` | `string` | Current state of the deployment. **Note**: This field is displayed only when viewing deployment 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. | | `errors` | `array` | Errors reported for this deployment. Populated only when state == ERROR. **Note**: This field is displayed only when viewing deployment status. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/apigee/runtime_config/index.md b/docs/google-docs/providers/google/apigee/runtime_config/index.md index 6b798b7218..8f557149e1 100644 --- a/docs/google-docs/providers/google/apigee/runtime_config/index.md +++ b/docs/google-docs/providers/google/apigee/runtime_config/index.md @@ -28,9 +28,9 @@ 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}/runtimeConfig`. | -| `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. | | `traceBucket` | `string` | Cloud Storage bucket used for uploading Trace records. | +| `analyticsBucket` | `string` | Cloud Storage bucket used for uploading Analytics records. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 ecabfd2f42..81417f4287 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 | -| `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. | | `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. | ## 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 6bc80e5a6e..ce3d6737b3 100644 --- a/docs/google-docs/providers/google/apigee/security_profiles/index.md +++ b/docs/google-docs/providers/google/apigee/security_profiles/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. | -| `displayName` | `string` | Display name of the security profile. | -| `revisionUpdateTime` | `string` | Output only. The time when revision was updated. | +| `environments` | `array` | List of environments attached to 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. | | `revisionId` | `string` | Output only. Revision ID of the security profile. | -| `scoringConfigs` | `array` | List of profile scoring configs in this revision. | -| `environments` | `array` | List of environments attached to security 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. | | `maxScore` | `integer` | Output only. Maximum security score that can be generated by this profile. | -| `revisionCreateTime` | `string` | Output only. The time when revision was created. | +| `scoringConfigs` | `array` | List of profile scoring configs in this revision. | +| `displayName` | `string` | Display name of the security profile. | +| `revisionUpdateTime` | `string` | Output only. The time when revision was updated. | ## 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 8538f9530b..8a4a2b6b6c 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,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. | -| `displayName` | `string` | Display name of the security 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. | | `revisionId` | `string` | Output only. Revision ID of the security profile. | -| `minScore` | `integer` | Output only. Minimum security score that can be generated by this profile. | +| `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. | +| `minScore` | `integer` | Output only. Minimum security score that can be generated by this 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. | -| `environments` | `array` | List of environments attached to 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. | ## 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 fd9d55faf2..e1481f49f1 100644 --- a/docs/google-docs/providers/google/apigee/security_reports/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `resultRows` | `string` | ResultRows 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. | +| `result` | `object` | Contains informations about the security report results. | | `executionTime` | `string` | ExecutionTime is available only after the query is completed. | -| `state` | `string` | Query state could be "enqueued", "running", "completed", "expired" and "failed". | -| `error` | `string` | Error is set when query fails. | | `queryParams` | `object` | Metadata for the security report. | -| `displayName` | `string` | Display Name specified by the user. | -| `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. | -| `result` | `object` | Contains informations about the security report results. | -| `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` | | `reportDefinitionId` | `string` | Report Definition ID. | +| `resultFileSize` | `string` | ResultFileSize is available only after the query is completed. | +| `error` | `string` | Error is set when query fails. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/security_reports_result/index.md b/docs/google-docs/providers/google/apigee/security_reports_result/index.md index a9fc91222b..9470301b69 100644 --- a/docs/google-docs/providers/google/apigee/security_reports_result/index.md +++ b/docs/google-docs/providers/google/apigee/security_reports_result/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/apigee/security_reports_result_view/index.md b/docs/google-docs/providers/google/apigee/security_reports_result_view/index.md index 58e9da96e1..a3b4b10833 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 | |:-----|:---------|:------------| +| `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/sharedflows/index.md b/docs/google-docs/providers/google/apigee/sharedflows/index.md index 117f037863..1efe1cf5b4 100644 --- a/docs/google-docs/providers/google/apigee/sharedflows/index.md +++ b/docs/google-docs/providers/google/apigee/sharedflows/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The ID of the shared flow. | +| `revision` | `array` | A list of revisions of this shared flow. | | `latestRevisionId` | `string` | The id of the most recently created revision for this shared flow. | | `metaData` | `object` | Metadata common to many entities in this API. | -| `revision` | `array` | A list of revisions of this shared flow. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigee/stats/index.md b/docs/google-docs/providers/google/apigee/stats/index.md index 0da3bc5e82..d786dc384a 100644 --- a/docs/google-docs/providers/google/apigee/stats/index.md +++ b/docs/google-docs/providers/google/apigee/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/targetservers/index.md b/docs/google-docs/providers/google/apigee/targetservers/index.md index 70f66033c9..7ea47305eb 100644 --- a/docs/google-docs/providers/google/apigee/targetservers/index.md +++ b/docs/google-docs/providers/google/apigee/targetservers/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The resource id of this target server. Values must match the regular expression | | `description` | `string` | Optional. A human-readable description of this TargetServer. | +| `host` | `string` | Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. | | `isEnabled` | `boolean` | Optional. Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true. | | `port` | `integer` | Required. The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive. | | `protocol` | `string` | Immutable. The protocol used by this TargetServer. | | `sSLInfo` | `object` | TLS configuration information for virtual hosts and TargetServers. | -| `host` | `string` | Required. The host name this target connects to. Value must be a valid hostname as described by RFC-1123. | ## 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 2b2ee41b5b..5d4ccf0531 100644 --- a/docs/google-docs/providers/google/apigeeregistry/apis/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/apis/index.md @@ -29,20 +29,20 @@ 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. | | `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. | -| `recommendedDeployment` | `string` | The recommended deployment of the API. Format: `projects/{project}/locations/{location}/apis/{api}/deployments/{deployment}` | | `updateTime` | `string` | Output only. Last update timestamp. | +| `createTime` | `string` | Output only. Creation timestamp. | +| `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}` | | `displayName` | `string` | Human-meaningful name. | | `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. | | `recommendedVersion` | `string` | The recommended version of the API. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_apis_get` | `SELECT` | `apisId, locationsId, projectsId` | Returns a specified API. | | `projects_locations_apis_list` | `SELECT` | `locationsId, projectsId` | Returns matching APIs. | | `projects_locations_apis_create` | `INSERT` | `locationsId, projectsId` | Creates a specified API. | | `projects_locations_apis_delete` | `DELETE` | `apisId, locationsId, projectsId` | Removes a specified API and all of the resources that it owns. | | `_projects_locations_apis_list` | `EXEC` | `locationsId, projectsId` | Returns matching APIs. | -| `projects_locations_apis_get` | `EXEC` | `apisId, locationsId, projectsId` | Returns a specified API. | | `projects_locations_apis_patch` | `EXEC` | `apisId, locationsId, projectsId` | Used to modify a specified API. | diff --git a/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md b/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md index 7c03b29fe6..e8cae54d3b 100644 --- a/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/artifacts/index.md @@ -28,21 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name. | -| `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. | | `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"). | | `updateTime` | `string` | Output only. Last update timestamp. | | `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. | -| `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. | -| `createTime` | `string` | Output only. Creation timestamp. | | `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. | +| `createTime` | `string` | Output only. Creation timestamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_apis_artifacts_get` | `SELECT` | `apisId, artifactsId, locationsId, projectsId` | Returns a specified artifact. | | `projects_locations_apis_artifacts_list` | `SELECT` | `apisId, locationsId, projectsId` | Returns matching artifacts. | +| `projects_locations_apis_deployments_artifacts_get` | `SELECT` | `apisId, artifactsId, deploymentsId, locationsId, projectsId` | Returns a specified artifact. | | `projects_locations_apis_deployments_artifacts_list` | `SELECT` | `apisId, deploymentsId, locationsId, projectsId` | Returns matching artifacts. | +| `projects_locations_apis_versions_artifacts_get` | `SELECT` | `apisId, artifactsId, locationsId, projectsId, versionsId` | Returns a specified artifact. | | `projects_locations_apis_versions_artifacts_list` | `SELECT` | `apisId, locationsId, projectsId, versionsId` | Returns matching artifacts. | +| `projects_locations_apis_versions_specs_artifacts_get` | `SELECT` | `apisId, artifactsId, locationsId, projectsId, specsId, versionsId` | Returns a specified artifact. | | `projects_locations_apis_versions_specs_artifacts_list` | `SELECT` | `apisId, locationsId, projectsId, specsId, versionsId` | Returns matching artifacts. | +| `projects_locations_artifacts_get` | `SELECT` | `artifactsId, locationsId, projectsId` | Returns a specified artifact. | | `projects_locations_artifacts_list` | `SELECT` | `locationsId, projectsId` | Returns matching artifacts. | | `projects_locations_apis_artifacts_create` | `INSERT` | `apisId, locationsId, projectsId` | Creates a specified artifact. | | `projects_locations_apis_deployments_artifacts_create` | `INSERT` | `apisId, deploymentsId, locationsId, projectsId` | Creates a specified artifact. | @@ -59,13 +64,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_projects_locations_apis_versions_artifacts_list` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Returns matching artifacts. | | `_projects_locations_apis_versions_specs_artifacts_list` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Returns matching artifacts. | | `_projects_locations_artifacts_list` | `EXEC` | `locationsId, projectsId` | Returns matching artifacts. | -| `projects_locations_apis_artifacts_get` | `EXEC` | `apisId, artifactsId, locationsId, projectsId` | Returns a specified artifact. | | `projects_locations_apis_artifacts_replace_artifact` | `EXEC` | `apisId, artifactsId, locationsId, projectsId` | Used to replace a specified artifact. | -| `projects_locations_apis_deployments_artifacts_get` | `EXEC` | `apisId, artifactsId, deploymentsId, locationsId, projectsId` | Returns a specified artifact. | | `projects_locations_apis_deployments_artifacts_replace_artifact` | `EXEC` | `apisId, artifactsId, deploymentsId, locationsId, projectsId` | Used to replace a specified artifact. | -| `projects_locations_apis_versions_artifacts_get` | `EXEC` | `apisId, artifactsId, locationsId, projectsId, versionsId` | Returns a specified artifact. | | `projects_locations_apis_versions_artifacts_replace_artifact` | `EXEC` | `apisId, artifactsId, locationsId, projectsId, versionsId` | Used to replace a specified artifact. | -| `projects_locations_apis_versions_specs_artifacts_get` | `EXEC` | `apisId, artifactsId, locationsId, projectsId, specsId, versionsId` | Returns a specified artifact. | | `projects_locations_apis_versions_specs_artifacts_replace_artifact` | `EXEC` | `apisId, artifactsId, locationsId, projectsId, specsId, versionsId` | Used to replace a specified artifact. | -| `projects_locations_artifacts_get` | `EXEC` | `artifactsId, locationsId, projectsId` | Returns a specified artifact. | | `projects_locations_artifacts_replace_artifact` | `EXEC` | `artifactsId, locationsId, projectsId` | Used to replace a specified artifact. | 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 3e1777c316..18043c5b3c 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 | |:-----|:---------|:------------| -| `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/artifacts_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/artifacts_iam_policies/index.md index cbda191613..a938f358dc 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 ceeecf5b8c..400d9fab1a 100644 --- a/docs/google-docs/providers/google/apigeeregistry/deployments/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/deployments/index.md @@ -29,26 +29,26 @@ 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. | -| `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. | +| `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. | +| `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. | | `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}` | -| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `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. | | `intendedAudience` | `string` | Text briefly identifying the intended audience of the API. Changes to this value will not affect the revision. | -| `displayName` | `string` | Human-meaningful name. | -| `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. | -| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. 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. | +| `displayName` | `string` | Human-meaningful name. | | `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. | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_apis_deployments_get` | `SELECT` | `apisId, deploymentsId, locationsId, projectsId` | Returns a specified deployment. | | `projects_locations_apis_deployments_list` | `SELECT` | `apisId, locationsId, projectsId` | Returns matching deployments. | | `projects_locations_apis_deployments_create` | `INSERT` | `apisId, locationsId, projectsId` | Creates a specified deployment. | | `projects_locations_apis_deployments_delete` | `DELETE` | `apisId, deploymentsId, locationsId, projectsId` | Removes a specified deployment, all revisions, and all child resources (e.g., artifacts). | | `_projects_locations_apis_deployments_list` | `EXEC` | `apisId, locationsId, projectsId` | Returns matching deployments. | -| `projects_locations_apis_deployments_get` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Returns a specified deployment. | | `projects_locations_apis_deployments_patch` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Used to modify a specified deployment. | | `projects_locations_apis_deployments_rollback` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. | | `projects_locations_apis_deployments_tag_revision` | `EXEC` | `apisId, deploymentsId, locationsId, projectsId` | Adds a tag to a specified revision of a deployment. | 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 9b2843c040..c138a5cafc 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. | -| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect the revision. | -| `displayName` | `string` | Human-meaningful name. | | `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | -| `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. | -| `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. | -| `endpointUri` | `string` | The address where the deployment is serving. Changes to this value will update 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. | -| `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. | | `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}` | -| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource was created. | +| `intendedAudience` | `string` | Text briefly identifying the intended audience of the API. Changes to this value will not affect the 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. | | `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `createTime` | `string` | Output only. Creation timestamp; when the deployment resource 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. | +| `endpointUri` | `string` | The address where the deployment is serving. Changes to this value will update the revision. | +| `accessGuidance` | `string` | Text briefly describing how to access the endpoint. Changes to this value will not affect 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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/index.md b/docs/google-docs/providers/google/apigeeregistry/index.md index e8d2dfaaaf..33eee7eaee 100644 --- a/docs/google-docs/providers/google/apigeeregistry/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleApigee Registry API Description -Idapigeeregistry:v23.08.00161 +Idapigeeregistry:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/apigeeregistry/instances/index.md b/docs/google-docs/providers/google/apigeeregistry/instances/index.md index c88a67ac16..25d986dc97 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. | -| `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. | | `config` | `object` | Available configurations to provision an Instance. | +| `createTime` | `string` | Output only. Creation timestamp. | +| `state` | `string` | Output only. The current state of the Instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md index 602bf8ca5f..11a5a39a25 100644 --- a/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/instances_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/locations/index.md b/docs/google-docs/providers/google/apigeeregistry/locations/index.md index eb7d968d08..a2a84185ee 100644 --- a/docs/google-docs/providers/google/apigeeregistry/locations/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/locations/index.md @@ -28,13 +28,13 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/apigeeregistry/operations/index.md b/docs/google-docs/providers/google/apigeeregistry/operations/index.md index 89d2aa669f..e5d0c0add1 100644 --- a/docs/google-docs/providers/google/apigeeregistry/operations/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/operations/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, 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`. | +| `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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/apigeeregistry/runtime_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/runtime_iam_policies/index.md index e23f6aef6a..6753528d6b 100644 --- a/docs/google-docs/providers/google/apigeeregistry/runtime_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/runtime_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apigeeregistry/specs/index.md b/docs/google-docs/providers/google/apigeeregistry/specs/index.md index b2d846aad3..4910f64b20 100644 --- a/docs/google-docs/providers/google/apigeeregistry/specs/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/specs/index.md @@ -29,26 +29,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | -| `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. | -| `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. | -| `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. | -| `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. | +| `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. | | `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. | -| `filename` | `string` | A possibly-hierarchical name used to refer to the spec from other specs. | +| `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. | | `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. | +| `filename` | `string` | A possibly-hierarchical name used to refer to the spec from other specs. | +| `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; 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. | -| `revisionCreateTime` | `string` | Output only. Revision creation timestamp; when the represented revision was created. | +| `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. | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `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"). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_apis_versions_specs_get` | `SELECT` | `apisId, locationsId, projectsId, specsId, versionsId` | Returns a specified spec. | | `projects_locations_apis_versions_specs_list` | `SELECT` | `apisId, locationsId, projectsId, versionsId` | Returns matching specs. | | `projects_locations_apis_versions_specs_create` | `INSERT` | `apisId, locationsId, projectsId, versionsId` | Creates a specified spec. | | `projects_locations_apis_versions_specs_delete` | `DELETE` | `apisId, locationsId, projectsId, specsId, versionsId` | Removes a specified spec, all revisions, and all child resources (e.g., artifacts). | | `_projects_locations_apis_versions_specs_list` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Returns matching specs. | -| `projects_locations_apis_versions_specs_get` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Returns a specified spec. | | `projects_locations_apis_versions_specs_patch` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Used to modify a specified spec. | | `projects_locations_apis_versions_specs_rollback` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Sets the current revision to a specified prior revision. Note that this creates a new revision with a new revision ID. | | `projects_locations_apis_versions_specs_tag_revision` | `EXEC` | `apisId, locationsId, projectsId, specsId, versionsId` | Adds a tag to a specified revision of a spec. | 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 c45b1460b8..a8e10c0997 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 | |:-----|:---------|:------------| -| `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/specs_revisions/index.md b/docs/google-docs/providers/google/apigeeregistry/specs_revisions/index.md index e9c7f4cf07..544938ce45 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. | -| `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. | -| `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; when the spec resource was created. | -| `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. | -| `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. | -| `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"). | | `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. | | `filename` | `string` | A possibly-hierarchical name used to refer to the spec from other specs. | +| `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. | +| `revisionUpdateTime` | `string` | Output only. Last update timestamp: when the represented revision was last modified. | +| `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 `apigeeregistry.googleapis.com/` and cannot be changed. | +| `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. | +| `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. | | `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"). | ## 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 33113e3f4c..d1fa8997f8 100644 --- a/docs/google-docs/providers/google/apigeeregistry/versions/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/versions/index.md @@ -29,19 +29,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Resource name. | | `description` | `string` | A detailed description. | -| `createTime` | `string` | Output only. Creation timestamp. | -| `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. | +| `primarySpec` | `string` | The primary spec for this version. Format: projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{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. | | `displayName` | `string` | Human-meaningful name. | -| `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. | +| `updateTime` | `string` | Output only. Last update timestamp. | +| `createTime` | `string` | Output only. Creation timestamp. | +| `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". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_apis_versions_get` | `SELECT` | `apisId, locationsId, projectsId, versionsId` | Returns a specified version. | | `projects_locations_apis_versions_list` | `SELECT` | `apisId, locationsId, projectsId` | Returns matching versions. | | `projects_locations_apis_versions_create` | `INSERT` | `apisId, locationsId, projectsId` | Creates a specified version. | | `projects_locations_apis_versions_delete` | `DELETE` | `apisId, locationsId, projectsId, versionsId` | Removes a specified version and all of the resources that it owns. | | `_projects_locations_apis_versions_list` | `EXEC` | `apisId, locationsId, projectsId` | Returns matching versions. | -| `projects_locations_apis_versions_get` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Returns a specified version. | | `projects_locations_apis_versions_patch` | `EXEC` | `apisId, locationsId, projectsId, versionsId` | Used to modify a specified version. | diff --git a/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md b/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md index f98ca14bff..0fbd90535b 100644 --- a/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md +++ b/docs/google-docs/providers/google/apigeeregistry/versions_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apikeys/index.md b/docs/google-docs/providers/google/apikeys/index.md index 13896a9bd9..33ced02a7c 100644 --- a/docs/google-docs/providers/google/apikeys/index.md +++ b/docs/google-docs/providers/google/apikeys/index.md @@ -20,7 +20,7 @@ Manages The API Keys Associated With Developer Projects.
total resources: 3
-total selectable resources: 2
+total selectable resources: 3
total methods: 10
@@ -33,7 +33,7 @@ Manages The API Keys Associated With Developer Projects. TypeService TitleAPI Keys API DescriptionManages The API Keys Associated With Developer Projects. -Idapikeys:v23.08.00161 +Idapikeys:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/apikeys/keys/index.md b/docs/google-docs/providers/google/apikeys/keys/index.md index 72e33cfaee..4265215edb 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`. | -| `updateTime` | `string` | Output only. A timestamp identifying the time this key was last updated. | -| `keyString` | `string` | Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. | -| `restrictions` | `object` | Describes the restrictions on the key. | -| `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. | -| `createTime` | `string` | Output only. A timestamp identifying the time this key was originally created. | | `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. | -| `displayName` | `string` | Human-readable display name of this key that you can modify. The maximum length is 63 characters. | | `uid` | `string` | Output only. Unique id in UUID4 format. | +| `displayName` | `string` | Human-readable display name of this key that you can modify. The maximum length is 63 characters. | +| `restrictions` | `object` | Describes the restrictions on the key. | +| `createTime` | `string` | Output only. A timestamp identifying the time this key was originally created. | | `deleteTime` | `string` | Output only. A timestamp when this key was deleted. If the resource is not deleted, this must be empty. | +| `updateTime` | `string` | Output only. A timestamp identifying the time this key was last updated. | +| `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. | +| `keyString` | `string` | Output only. An encrypted and signed value held by this key. This field can be accessed only through the `GetKeyString` method. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/apikeys/operations/index.md b/docs/google-docs/providers/google/apikeys/operations/index.md index 346e45b267..060b3dcd1e 100644 --- a/docs/google-docs/providers/google/apikeys/operations/index.md +++ b/docs/google-docs/providers/google/apikeys/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.apikeys.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}`. | +| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/appengine/apps/index.md b/docs/google-docs/providers/google/appengine/apps/index.md index 54a652841c..d5e9b0cb1a 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 | -| `defaultHostname` | `string` | Output only. Hostname used to reach this application, as resolved by App Engine.@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. | +| `featureSettings` | `object` | The feature specific settings to be used in the application. These define behaviors that are user configurable. | | `defaultBucket` | `string` | Output only. Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly | -| `authDomain` | `string` | Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. | -| `gcrDomain` | `string` | Output only. The Google Container Registry domain used for storing managed build docker images 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. | | `defaultCookieExpiration` | `string` | Cookie expiration policy for this application. | -| `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. | -| `databaseType` | `string` | The type of the Cloud Firestore or Cloud Datastore database associated with this application. | -| `iap` | `object` | Identity-Aware Proxy | | `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 | +| `databaseType` | `string` | The type of the Cloud Firestore or Cloud Datastore database associated with this application. | +| `gcrDomain` | `string` | Output only. The Google Container Registry domain used for storing managed build docker images 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. | | `servingStatus` | `string` | Serving status of this application. | -| `featureSettings` | `object` | The feature specific settings to be used in the application. These define behaviors that are user configurable. | +| `defaultHostname` | `string` | Output only. Hostname used to reach this application, as resolved by App Engine.@OutputOnly | +| `iap` | `object` | Identity-Aware Proxy | +| `authDomain` | `string` | Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account. | +| `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). | ## 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 e1f70a5c88..e5befdb0a5 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 | -| `certificateRawData` | `object` | An SSL certificate obtained from a certificate authority. | -| `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 | -| `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 | | `domainNames` | `array` | Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly | -| `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 | | `managedCertificate` | `object` | A certificate managed by App Engine. | +| `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 | +| `certificateRawData` | `object` | An SSL certificate obtained from a certificate authority. | +| `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 | +| `displayName` | `string` | The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/appengine/index.md b/docs/google-docs/providers/google/appengine/index.md index 7074d3ec93..32de87ac62 100644 --- a/docs/google-docs/providers/google/appengine/index.md +++ b/docs/google-docs/providers/google/appengine/index.md @@ -33,7 +33,7 @@ Provisions And Manages Developers' App Engine Applications. TypeService TitleApp Engine Admin API DescriptionProvisions And Manages Developers' App Engine Applications. -Idappengine:v23.08.00161 +Idappengine:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/appengine/instances/index.md b/docs/google-docs/providers/google/appengine/instances/index.md index 9fc1f97b5f..6fe2c9dc5f 100644 --- a/docs/google-docs/providers/google/appengine/instances/index.md +++ b/docs/google-docs/providers/google/appengine/instances/index.md @@ -29,21 +29,21 @@ 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. | -| `appEngineRelease` | `string` | Output only. App Engine release this instance is running on. | -| `vmDebugEnabled` | `boolean` | Output only. Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment. | | `averageLatency` | `integer` | Output only. Average latency (ms) over the last minute. | -| `errors` | `integer` | Output only. Number of errors 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. | +| `vmId` | `string` | Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. | | `memoryUsage` | `string` | Output only. Total memory in use (bytes). | +| `vmLiveness` | `string` | Output only. The liveness health check of this instance. Only applicable for instances in App Engine flexible environment. | | `vmStatus` | `string` | Output only. Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | -| `vmId` | `string` | Output only. Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment. | +| `vmName` | `string` | Output only. Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment. | +| `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 | +| `errors` | `integer` | Output only. Number of errors since this instance was started. | | `availability` | `string` | Output only. Availability of the instance. | | `requests` | `integer` | Output only. Number of requests since this instance was started. | -| `vmZoneName` | `string` | Output only. Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment. | -| `startTime` | `string` | Output only. Time that this instance was started.@OutputOnly | | `qps` | `number` | Output only. Average queries per second (QPS) over the last minute. | -| `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. | -| `vmLiveness` | `string` | Output only. The liveness health check of this instance. 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/locations/index.md b/docs/google-docs/providers/google/appengine/locations/index.md index eb76eab31b..cfce9cf348 100644 --- a/docs/google-docs/providers/google/appengine/locations/index.md +++ b/docs/google-docs/providers/google/appengine/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/appengine/operations/index.md b/docs/google-docs/providers/google/appengine/operations/index.md index 1e17dcc133..fde3adb729 100644 --- a/docs/google-docs/providers/google/appengine/operations/index.md +++ b/docs/google-docs/providers/google/appengine/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/appengine/services/index.md b/docs/google-docs/providers/google/appengine/services/index.md index 1cd966fb53..db3947edad 100644 --- a/docs/google-docs/providers/google/appengine/services/index.md +++ b/docs/google-docs/providers/google/appengine/services/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | Relative name of the service within the application. Example: default.@OutputOnly | | `name` | `string` | Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly | +| `split` | `object` | Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. | | `labels` | `object` | A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. | | `networkSettings` | `object` | A NetworkSettings resource is a container for ingress settings for a version or service. | -| `split` | `object` | Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions. | ## 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 d6b96bdd8b..5a7fa2333c 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 | +| `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. | +| `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. | +| `flexibleRuntimeSettings` | `object` | Runtime settings for the App Engine flexible environment. | +| `createTime` | `string` | Time that this version was created.@OutputOnly | +| `errorHandlers` | `array` | Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set. | +| `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. | +| `appEngineApis` | `boolean` | Allows App Engine second generation runtimes to access the legacy bundled services. | +| `versionUrl` | `string` | Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly | | `threadsafe` | `boolean` | Whether multiple requests can be dispatched to this version at once. | -| `apiConfig` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. | -| `vm` | `boolean` | Whether to deploy this version in a container on a virtual machine. | +| `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. | +| `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. | +| `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 | +| `entrypoint` | `object` | The entrypoint for the application. | +| `runtimeChannel` | `string` | The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. | | `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. | -| `automaticScaling` | `object` | Automatic scaling is based on request rate, response latencies, and other application metrics. | -| `resources` | `object` | Machine resources for a version. | -| `readinessCheck` | `object` | Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. | +| `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. | +| `runtimeMainExecutablePath` | `string` | The path or name of the app's main executable. | +| `buildEnvVariables` | `object` | Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. | | `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). | -| `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. | -| `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 | -| `network` | `object` | Extra network settings. Only applicable in the App Engine flexible environment. | +| `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. | +| `apiConfig` | `object` | Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration for API handlers. | +| `envVariables` | `object` | Environment variables available to the application.Only returned in GET requests if view=FULL is set. | +| `env` | `string` | App Engine execution environment for this version.Defaults to standard. | | `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. | +| `livenessCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. | +| `vpcAccessConnector` | `object` | VPC access connector specification. | | `runtime` | `string` | Desired runtime. Example: python27. | +| `automaticScaling` | `object` | Automatic scaling is based on request rate, response latencies, and other application metrics. | +| `createdBy` | `string` | Email address of the user who created this version.@OutputOnly | +| `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. | | `zones` | `array` | The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated. | -| `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. | -| `versionUrl` | `string` | Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly | -| `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. | -| `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. | -| `runtimeChannel` | `string` | The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel. | -| `flexibleRuntimeSettings` | `object` | Runtime settings for the App Engine flexible environment. | -| `inboundServices` | `array` | Before an application can receive email or XMPP messages, the application must be configured to enable the service. | -| `livenessCheck` | `object` | Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. | -| `entrypoint` | `object` | The entrypoint for the application. | -| `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. | | `betaSettings` | `object` | Metadata settings that are supplied to this version to enable beta runtime features. | +| `inboundServices` | `array` | Before an application can receive email or XMPP messages, the application must be configured to enable the service. | +| `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 | +| `vm` | `boolean` | Whether to deploy this version in a container on a virtual machine. | +| `readinessCheck` | `object` | Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation. | | `deployment` | `object` | Code and application artifacts used to deploy a version to App Engine. | -| `createdBy` | `string` | Email address of the user who created this version.@OutputOnly | -| `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. | -| `buildEnvVariables` | `object` | Environment variables available to the build environment.Only returned in GET requests if view=FULL is set. | -| `runtimeMainExecutablePath` | `string` | The path or name of the app's main executable. | -| `env` | `string` | App Engine execution environment for this version.Defaults to standard. | -| `envVariables` | `object` | Environment variables available to the application.Only returned in GET requests if view=FULL is set. | -| `createTime` | `string` | Time that this version was created.@OutputOnly | -| `appEngineApis` | `boolean` | Allows App Engine second generation runtimes to access the legacy bundled services. | -| `vpcAccessConnector` | `object` | VPC access connector specification. | -| `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. | -| `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 | +| `network` | `object` | Extra network settings. Only applicable in the App Engine flexible environment. | +| `resources` | `object` | Machine resources for a version. | ## 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 f81ef37819..07568ad854 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. | +| `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. | | `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. | ## 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 b0c6b50fdf..72a042f525 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. | +| `hashes` | `array` | The hashes of the file content. | +| `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/index.md b/docs/google-docs/providers/google/artifactregistry/index.md index 795ac14b1a..0d5867aff3 100644 --- a/docs/google-docs/providers/google/artifactregistry/index.md +++ b/docs/google-docs/providers/google/artifactregistry/index.md @@ -20,7 +20,7 @@ Store And Manage Build Artifacts In A Scalable And Integrated Service Built On G
total resources: 19
-total selectable resources: 13
+total selectable resources: 14
total methods: 56
@@ -33,7 +33,7 @@ Store And Manage Build Artifacts In A Scalable And Integrated Service Built On G TypeService TitleArtifact Registry API DescriptionStore And Manage Build Artifacts In A Scalable And Integrated Service Built On Google Infrastructure. -Idartifactregistry:v23.08.00161 +Idartifactregistry:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/artifactregistry/locations/index.md b/docs/google-docs/providers/google/artifactregistry/locations/index.md index 1b86a897d7..94a2387c91 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"` | -| `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/artifactregistry/maven_artifacts/index.md b/docs/google-docs/providers/google/artifactregistry/maven_artifacts/index.md index 761a3e7131..16aef18cab 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. | +| `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 | | `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. | ## 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..0ace3aa918 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. | -| `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. | +| `tags` | `array` | Tags attached to this package. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/artifactregistry/operations/index.md b/docs/google-docs/providers/google/artifactregistry/operations/index.md index eeb0627afe..30b11debb5 100644 --- a/docs/google-docs/providers/google/artifactregistry/operations/index.md +++ b/docs/google-docs/providers/google/artifactregistry/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.artifactregistry.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}`. | +| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/artifactregistry/packages/index.md b/docs/google-docs/providers/google/artifactregistry/packages/index.md index df700b3409..2338f8307c 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. | -| `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. | +| `updateTime` | `string` | The time when the package was last updated. This includes publishing a new version of the package. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 e6bb5d4afa..c8a0a6c06b 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. | -| `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. | | `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/repositories/index.md b/docs/google-docs/providers/google/artifactregistry/repositories/index.md index 8e4009571f..2cbf3eae35 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. | -| `createTime` | `string` | Output only. The time when the repository was created. | -| `cleanupPolicyDryRun` | `boolean` | Optional. If true, the cleanup pipeline is prevented from deleting versions in this repository. | -| `mode` | `string` | The mode of the repository. | +| `mavenConfig` | `object` | MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven 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. | | `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. | +| `remoteRepositoryConfig` | `object` | Remote repository configuration. | +| `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. | +| `dockerConfig` | `object` | DockerRepositoryConfig is docker related repository details. Provides additional configuration details for repositories of the docker format type. | | `virtualRepositoryConfig` | `object` | Virtual repository configuration. | +| `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. | -| `updateTime` | `string` | Output only. The time when the repository was last updated. | -| `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. | | `format` | `string` | The format of packages that are stored in the repository. | -| `dockerConfig` | `object` | DockerRepositoryConfig is docker related repository details. Provides additional configuration details for repositories of the docker format type. | -| `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. | -| `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. | | `sbomConfig` | `object` | Config for whether to generate SBOMs for resources in this repository, as well as output fields describing current state. | -| `remoteRepositoryConfig` | `object` | Remote repository configuration. | -| `mavenConfig` | `object` | MavenRepositoryConfig is maven related repository details. Provides additional configuration details for repositories of the maven format type. | +| `updateTime` | `string` | Output only. The time when the repository was last updated. | +| `cleanupPolicyDryRun` | `boolean` | Optional. If true, the cleanup pipeline is prevented from deleting versions in this repository. | +| `createTime` | `string` | Output only. The time when the repository was created. | +| `mode` | `string` | The mode of the repository. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 846e6fb482..da95df20a0 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 | |:-----|:---------|:------------| -| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/assuredworkloads/index.md b/docs/google-docs/providers/google/assuredworkloads/index.md index 19cb64bce0..1a443de83f 100644 --- a/docs/google-docs/providers/google/assuredworkloads/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleAssured Workloads API Description -Idassuredworkloads:v23.08.00161 +Idassuredworkloads:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/assuredworkloads/operations/index.md b/docs/google-docs/providers/google/assuredworkloads/operations/index.md index ea5f998dda..7512bf67c1 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, 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/assuredworkloads/violations/index.md b/docs/google-docs/providers/google/assuredworkloads/violations/index.md index 5f1b4958e6..d63bd10176 100644 --- a/docs/google-docs/providers/google/assuredworkloads/violations/index.md +++ b/docs/google-docs/providers/google/assuredworkloads/violations/index.md @@ -29,18 +29,18 @@ 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. | -| `state` | `string` | Output only. State of the violation | -| `acknowledged` | `boolean` | A boolean that indicates if the violation is acknowledged | -| `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} | -| `resolveTime` | `string` | Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. | | `category` | `string` | Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. | | `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} | +| `state` | `string` | Output only. State of the violation | +| `acknowledged` | `boolean` | A boolean that indicates if the violation is acknowledged | | `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. | +| `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} | +| `remediation` | `object` | Represents remediation guidance to resolve compliance violation for AssuredWorkload | | `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. | | `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} | +| `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. | -| `beginTime` | `string` | Output only. Time of the event which triggered the Violation. | -| `remediation` | `object` | Represents remediation guidance to resolve compliance violation for AssuredWorkload | | `orgPolicyConstraint` | `string` | Output only. Immutable. The org-policy-constraint that was incorrectly changed, which resulted in this violation. | ## 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 b11108b8dd..a9d6db09f2 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. | -| `labels` | `object` | Optional. Labels applied to the workload. | -| `complianceStatus` | `object` | Represents the Compliance Status of this workload | +| `createTime` | `string` | Output only. Immutable. The Workload creation timestamp. | | `partner` | `string` | Optional. Partner regime associated with this workload. | -| `saaEnrollmentResponse` | `object` | Signed Access Approvals (SAA) enrollment response. | -| `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. | -| `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 | +| `complianceStatus` | `object` | Represents the Compliance Status of this 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. | -| `createTime` | `string` | Output only. Immutable. The Workload creation timestamp. | -| `ekmProvisioningResponse` | `object` | External key management systems(EKM) Provisioning response | -| `enableSovereignControls` | `boolean` | Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. | +| `kajEnrollmentState` | `string` | Output only. Represents the KAJ enrollment state of the given 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`. | -| `partnerPermissions` | `object` | Permissions granted to the AW Partner SA account for the customer workload | -| `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." | +| `ekmProvisioningResponse` | `object` | External key management systems(EKM) Provisioning response | | `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. | -| `complianceRegime` | `string` | Required. Immutable. Compliance Regime associated with this workload. | +| `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 | +| `kmsSettings` | `object` | Settings specific to the Key Management Service. | | `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. | +| `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." | +| `saaEnrollmentResponse` | `object` | Signed Access Approvals (SAA) enrollment response. | | `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. | -| `kmsSettings` | `object` | Settings specific to the Key Management Service. | +| `complianceRegime` | `string` | Required. Immutable. Compliance Regime associated with this workload. | +| `labels` | `object` | Optional. Labels applied to the workload. | +| `enableSovereignControls` | `boolean` | Optional. Indicates the sovereignty status of the given workload. Currently meant to be used by Europe/Canada customers. | +| `partnerPermissions` | `object` | Permissions granted to the AW Partner SA account for the customer workload | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/index.md b/docs/google-docs/providers/google/baremetalsolution/index.md index 34a4609f86..490ff3f331 100644 --- a/docs/google-docs/providers/google/baremetalsolution/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/index.md @@ -20,7 +20,7 @@ Provides Ways To Manage Bare Metal Solution Hardware Installed In A Regional Ext
total resources: 13
-total selectable resources: 12
+total selectable resources: 13
total methods: 57
@@ -33,7 +33,7 @@ Provides Ways To Manage Bare Metal Solution Hardware Installed In A Regional Ext TypeService TitleBare Metal Solution API DescriptionProvides Ways To Manage Bare Metal Solution Hardware Installed In A Regional Extension Located Near A Google Cloud Data Center. -Idbaremetalsolution:v23.08.00161 +Idbaremetalsolution:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/baremetalsolution/instances/index.md b/docs/google-docs/providers/google/baremetalsolution/instances/index.md index 17ba96ec27..ec479a3538 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}` | -| `state` | `string` | Output only. The state of the server. | +| `createTime` | `string` | Output only. Create a time stamp. | +| `machineType` | `string` | Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | | `volumes` | `array` | Input only. List of Volumes to attach to this Instance on creation. This field won't be populated in Get/List responses. | -| `labels` | `object` | Labels as key value pairs. | | `networks` | `array` | Output only. List of networks associated with this server. | -| `networkTemplate` | `string` | Instance network template name. For eg, bondaa-bondaa, bondab-nic, etc. Generally, the template name follows the syntax of "bond" or "nic". | +| `workloadProfile` | `string` | The workload profile for the instance. | +| `luns` | `array` | Immutable. List of LUNs associated with this server. | +| `state` | `string` | Output only. The state of the server. | +| `labels` | `object` | Labels as key value pairs. | +| `loginInfo` | `string` | Output only. Text field about info for logging in. | +| `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. | | `interactiveSerialConsoleEnabled` | `boolean` | Output only. True if the interactive serial console feature is enabled for the instance, false otherwise. The default value is false. | -| `updateTime` | `string` | Output only. Update a time stamp. | -| `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". | | `osImage` | `string` | The OS image currently installed on the server. | -| `hyperthreadingEnabled` | `boolean` | True if you enable hyperthreading for the server, otherwise false. The default value is false. | -| `createTime` | `string` | Output only. Create a time stamp. | -| `loginInfo` | `string` | Output only. Text field about info for logging in. | -| `machineType` | `string` | Immutable. The server type. [Available server types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | -| `luns` | `array` | Immutable. List of LUNs associated with this server. | -| `workloadProfile` | `string` | The workload profile for the instance. | | `firmwareVersion` | `string` | Output only. The firmware version 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. | +| `hyperthreadingEnabled` | `boolean` | True if you enable hyperthreading for the server, otherwise false. The default value is false. | +| `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. | +| `updateTime` | `string` | Output only. Update a time stamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/locations/index.md b/docs/google-docs/providers/google/baremetalsolution/locations/index.md index cb81d6027a..b88d9ea899 100644 --- a/docs/google-docs/providers/google/baremetalsolution/locations/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/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/baremetalsolution/luns/index.md b/docs/google-docs/providers/google/baremetalsolution/luns/index.md index bd86d7609a..e3128e3b0d 100644 --- a/docs/google-docs/providers/google/baremetalsolution/luns/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/luns/index.md @@ -30,15 +30,15 @@ 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. | | `expireTime` | `string` | Output only. Time after which LUN will be fully deleted. It is filled only for LUNs in COOL_OFF state. | -| `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. | -| `sizeGb` | `string` | The size of this LUN, in gigabytes. | -| `state` | `string` | The state of this storage volume. | -| `storageVolume` | `string` | Display the storage volume for this LUN. | | `bootLun` | `boolean` | Display if this LUN is a boot LUN. | +| `storageVolume` | `string` | Display the storage volume for this LUN. | | `shareable` | `boolean` | Display if this LUN can be shared between multiple physical servers. | | `storageType` | `string` | The storage type for this LUN. | +| `sizeGb` | `string` | The size of this LUN, in gigabytes. | +| `state` | `string` | The state of this storage volume. | +| `instances` | `array` | Output only. Instances this Lun is attached to. | | `wwid` | `string` | The WWID for this LUN. | +| `multiprotocolType` | `string` | The LUN multiprotocol type ensures the characteristics of the LUN are optimized for each operating system. | ## 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 648edabccd..69b94681d8 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}` | -| `servicesCidr` | `string` | IP range for reserved for services (e.g. NFS). | -| `macAddress` | `array` | List of physical interfaces. | +| `pod` | `string` | Output only. Pod name. | | `state` | `string` | The Network state. | | `cidr` | `string` | The cidr of the Network. | -| `ipAddress` | `string` | IP address configured. | | `jumboFramesEnabled` | `boolean` | Whether network uses standard frames or jumbo ones. | -| `pod` | `string` | Output only. Pod name. | -| `gatewayIp` | `string` | Output only. Gateway ip address. | -| `vrf` | `object` | A network VRF. | -| `vlanId` | `string` | The vlan id of the 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. | | `labels` | `object` | Labels as key value pairs. | +| `macAddress` | `array` | List of physical interfaces. | +| `servicesCidr` | `string` | IP range for reserved for services (e.g. NFS). | | `mountPoints` | `array` | Input only. List of mount points to attach the network to. | -| `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. | +| `vlanId` | `string` | The vlan id of the Network. | +| `vrf` | `object` | A network VRF. | | `type` | `string` | The type of this network. | +| `gatewayIp` | `string` | Output only. Gateway ip address. | +| `ipAddress` | `string` | IP address configured. | ## 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 80353fa279..7c35803343 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. | | `storageType` | `string` | Immutable. The storage type of the underlying volume. | +| `allowedClients` | `array` | List of allowed access points. | +| `labels` | `object` | Labels as key value pairs. | +| `volume` | `string` | Output only. The underlying volume of the share. Created automatically during provisioning. | | `requestedSizeGib` | `string` | The requested size, in GiB. | -| `state` | `string` | Output only. The state of the NFS share. | | `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. | -| `volume` | `string` | Output only. The underlying volume of the share. Created automatically during provisioning. | -| `labels` | `object` | Labels as key value pairs. | -| `allowedClients` | `array` | List of allowed access points. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/operations/index.md b/docs/google-docs/providers/google/baremetalsolution/operations/index.md index 755bce6527..1677d8dfe1 100644 --- a/docs/google-docs/providers/google/baremetalsolution/operations/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.baremetalsolution.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}`. | +| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/os_images/index.md b/docs/google-docs/providers/google/baremetalsolution/os_images/index.md index 41f8cb69f3..005e4156d1 100644 --- a/docs/google-docs/providers/google/baremetalsolution/os_images/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/os_images/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. OS Image's unique name. | | `description` | `string` | OS Image description. | -| `supportedNetworkTemplates` | `array` | Network templates that can be used with this OS Image. | | `applicableInstanceTypes` | `array` | Instance types this image is applicable to. [Available types](https://cloud.google.com/bare-metal/docs/bms-planning#server_configurations) | | `code` | `string` | OS Image code. | +| `supportedNetworkTemplates` | `array` | Network templates that can be used with this OS Image. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 3fd1a5ced8..442be70e43 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. | +| `volumes` | `array` | Volumes to be created. | +| `ticketId` | `string` | A generated ticket id to track provisioning request. | +| `instances` | `array` | Instances to be created. | +| `vpcScEnabled` | `boolean` | If true, VPC SC is enabled for the cluster. | +| `cloudConsoleUri` | `string` | Output only. URI to Cloud Console UI view of this provisioning config. | | `updateTime` | `string` | Output only. Last update timestamp. | +| `networks` | `array` | Networks to be created. | +| `state` | `string` | Output only. State of ProvisioningConfig. | | `handoverServiceAccount` | `string` | A service account to enable customers to access instance credentials upon handover. | | `customId` | `string` | Optional. The user-defined identifier of the provisioning config. | -| `instances` | `array` | Instances to be created. | -| `cloudConsoleUri` | `string` | Output only. URI to Cloud Console UI view of this provisioning config. | -| `volumes` | `array` | Volumes to be created. | +| `email` | `string` | Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. | | `statusMessage` | `string` | Optional status messages associated with the FAILED state. | -| `vpcScEnabled` | `boolean` | If true, VPC SC is enabled for the cluster. | | `location` | `string` | Optional. Location name of this ProvisioningConfig. It is optional only for Intake UI transition period. | -| `email` | `string` | Email provided to send a confirmation with provisioning config to. Deprecated in favour of email field in request messages. | -| `networks` | `array` | Networks to be created. | -| `state` | `string` | Output only. State of ProvisioningConfig. | -| `ticketId` | `string` | A generated ticket id to track provisioning request. | ## 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 1a28020e9f..c05c4c09fc 100644 --- a/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/provisioning_quotas/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 provisioning quota. | -| `storageGib` | `string` | Storage size (GB). | | `networkBandwidth` | `string` | Network bandwidth, Gbps | | `assetType` | `string` | The asset type of this provisioning quota. | -| `availableCount` | `integer` | The available count of the provisioning quota. | | `serverCount` | `string` | Server count. | -| `location` | `string` | The specific location of the provisioining quota. | -| `instanceQuota` | `object` | A resource budget. | +| `storageGib` | `string` | Storage size (GB). | +| `availableCount` | `integer` | The available count of the provisioning quota. | | `gcpService` | `string` | The gcp service of the provisioning quota. | +| `instanceQuota` | `object` | A resource budget. | +| `location` | `string` | The specific location of the provisioining quota. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md b/docs/google-docs/providers/google/baremetalsolution/snapshots/index.md index 7606c65781..c71cb0a841 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. | +| `createTime` | `string` | Output only. The creation time 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. | ## 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 46af371115..d9c5678bed 100644 --- a/docs/google-docs/providers/google/baremetalsolution/volumes/index.md +++ b/docs/google-docs/providers/google/baremetalsolution/volumes/index.md @@ -29,30 +29,28 @@ 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}` | -| `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. | +| `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. | -| `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. | -| `protocol` | `string` | Output only. Storage protocol for the Volume. | -| `remainingSpaceGib` | `string` | The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots. | -| `maxSizeGib` | `string` | Maximum size volume can be expanded to in case of evergency, in GiB. | +| `bootVolume` | `boolean` | Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN. | +| `notes` | `string` | Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention. | +| `pod` | `string` | Immutable. Pod name. | +| `performanceTier` | `string` | Immutable. Performance tier of the Volume. Default is SHARED. | | `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. | -| `originallyRequestedSizeGib` | `string` | Originally requested size, in GiB. | | `expireTime` | `string` | Output only. Time after which volume will be fully deleted. It is filled only for volumes in COOLOFF state. | -| `snapshotSchedulePolicy` | `string` | The name of the snapshot schedule policy in use for this volume, if any. | -| `instances` | `array` | Output only. Instances this Volume is attached to. This field is set only in Get requests. | | `labels` | `object` | Labels as key value pairs. | -| `bootVolume` | `boolean` | Output only. Whether this volume is a boot volume. A boot volume is one which contains a boot LUN. | -| `pod` | `string` | Immutable. Pod name. | -| `state` | `string` | The state of this storage 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. | +| `protocol` | `string` | Output only. Storage protocol for the Volume. | +| `storageType` | `string` | The storage type for this volume. | | `snapshotReservationDetail` | `object` | Details about snapshot space reservation and usage on the storage volume. | -| `requestedSizeGib` | `string` | The requested size of this storage volume, in GiB. | -| `performanceTier` | `string` | Immutable. Performance tier of the Volume. Default is SHARED. | -| `workloadProfile` | `string` | The workload profile for the volume. | +| `emergencySizeGib` | `string` | Additional emergency size that was requested for this Volume, in GiB. current_size_gib includes this value. | | `snapshotEnabled` | `boolean` | Whether snapshots are enabled. | -| `notes` | `string` | Input only. User-specified notes for new Volume. Used to provision Volumes that require manual intervention. | | `snapshotAutoDeleteBehavior` | `string` | The behavior to use when snapshot reserved space is full. | -| `storageType` | `string` | The storage type for this volume. | +| `requestedSizeGib` | `string` | The requested size of this storage volume, in GiB. | +| `remainingSpaceGib` | `string` | The space remaining in the storage volume for new LUNs, in GiB, excluding space reserved for snapshots. | +| `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. | +| `workloadProfile` | `string` | The workload profile for the volume. | +| `maxSizeGib` | `string` | Maximum size volume can be expanded to in case of evergency, in GiB. | +| `state` | `string` | The state of this storage volume. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/batch/index.md b/docs/google-docs/providers/google/batch/index.md index f84d6688d6..41a8b58274 100644 --- a/docs/google-docs/providers/google/batch/index.md +++ b/docs/google-docs/providers/google/batch/index.md @@ -33,7 +33,7 @@ An API To Manage The Running Of Batch Jobs On Google Cloud Platform. TypeService TitleBatch API DescriptionAn API To Manage The Running Of Batch Jobs On Google Cloud Platform. -Idbatch:v23.08.00161 +Idbatch:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/batch/jobs/index.md b/docs/google-docs/providers/google/batch/jobs/index.md index 44dd7dec05..21761bf129 100644 --- a/docs/google-docs/providers/google/batch/jobs/index.md +++ b/docs/google-docs/providers/google/batch/jobs/index.md @@ -28,16 +28,16 @@ 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". | -| `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. | -| `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. | -| `updateTime` | `string` | Output only. The last time the Job was updated. | -| `taskGroups` | `array` | Required. TaskGroups in the Job. Only one TaskGroup is supported now. | | `allocationPolicy` | `object` | A Job's resource allocation policy describes when, where, and how compute resources should be allocated for the Job. | -| `createTime` | `string` | Output only. When the Job was created. | +| `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. | | `status` | `object` | Job status. | -| `uid` | `string` | Output only. A system generated unique ID (in UUID4 format) for the Job. | | `logsPolicy` | `object` | LogsPolicy describes how outputs from a Job's Tasks (stdout/stderr) will be preserved. | | `notifications` | `array` | Notification configurations. | +| `taskGroups` | `array` | Required. TaskGroups in the Job. Only one TaskGroup is supported now. | +| `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. | +| `updateTime` | `string` | Output only. The last time the Job was updated. | +| `createTime` | `string` | Output only. When the Job was created. | +| `uid` | `string` | Output only. A system generated unique ID (in UUID4 format) for the Job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/batch/locations/index.md b/docs/google-docs/providers/google/batch/locations/index.md index 1463fba2aa..c1eec42627 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". | +| `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/batch/operations/index.md b/docs/google-docs/providers/google/batch/operations/index.md index 020824e02b..dae0829226 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}`. | -| `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/beyondcorp/app_connections/index.md b/docs/google-docs/providers/google/beyondcorp/app_connections/index.md index b5d205d05a..5bf3ee5d2d 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connections/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connections/index.md @@ -29,22 +29,22 @@ 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. | | `applicationEndpoint` | `object` | ApplicationEndpoint represents a remote application endpoint. | -| `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. | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | | `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. | | `displayName` | `string` | Optional. An arbitrary user-provided name for the AppConnection. Cannot exceed 64 characters. | -| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | | `gateway` | `object` | Gateway represents a user facing component that serves as an entrance to enable connectivity. | -| `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. | +| `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. | | `state` | `string` | Output only. The current state of the AppConnection. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_app_connections_get` | `SELECT` | `appConnectionsId, locationsId, projectsId` | Gets details of a single AppConnection. | | `projects_locations_app_connections_list` | `SELECT` | `locationsId, projectsId` | Lists AppConnections in a given project and location. | | `projects_locations_app_connections_create` | `INSERT` | `locationsId, projectsId` | Creates a new AppConnection in a given project and location. | | `projects_locations_app_connections_delete` | `DELETE` | `appConnectionsId, locationsId, projectsId` | Deletes a single AppConnection. | | `_projects_locations_app_connections_list` | `EXEC` | `locationsId, projectsId` | Lists AppConnections in a given project and location. | -| `projects_locations_app_connections_get` | `EXEC` | `appConnectionsId, locationsId, projectsId` | Gets details of a single AppConnection. | | `projects_locations_app_connections_patch` | `EXEC` | `appConnectionsId, locationsId, projectsId` | Updates the parameters of a single AppConnection. | | `projects_locations_app_connections_resolve` | `EXEC` | `locationsId, projectsId` | Resolves AppConnections details for a given AppConnector. An internal method called by a connector to find AppConnections to connect to. | 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 29f1104081..314ace220d 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_connectors/index.md @@ -28,22 +28,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Unique resource name of the AppConnector. The name is ignored when creating a AppConnector. | -| `createTime` | `string` | Output only. Timestamp when the resource was created. | -| `principalInfo` | `object` | PrincipalInfo represents an Identity oneof. | -| `resourceInfo` | `object` | ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent | | `state` | `string` | Output only. The current state of the AppConnector. | -| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | -| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | | `uid` | `string` | Output only. A unique identifier for the instance generated by the system. | +| `resourceInfo` | `object` | ResourceInfo represents the information/status of an app connector resource. Such as: - remote_agent - container - runtime - appgateway - appconnector - appconnection - tunnel - logagent | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | | `displayName` | `string` | Optional. An arbitrary user-provided name for the AppConnector. Cannot exceed 64 characters. | +| `principalInfo` | `object` | PrincipalInfo represents an Identity oneof. | +| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_app_connectors_get` | `SELECT` | `appConnectorsId, locationsId, projectsId` | Gets details of a single AppConnector. | | `projects_locations_app_connectors_list` | `SELECT` | `locationsId, projectsId` | Lists AppConnectors in a given project and location. | | `projects_locations_app_connectors_create` | `INSERT` | `locationsId, projectsId` | Creates a new AppConnector in a given project and location. | | `projects_locations_app_connectors_delete` | `DELETE` | `appConnectorsId, locationsId, projectsId` | Deletes a single AppConnector. | | `_projects_locations_app_connectors_list` | `EXEC` | `locationsId, projectsId` | Lists AppConnectors in a given project and location. | -| `projects_locations_app_connectors_get` | `EXEC` | `appConnectorsId, locationsId, projectsId` | Gets details of a single AppConnector. | | `projects_locations_app_connectors_patch` | `EXEC` | `appConnectorsId, locationsId, projectsId` | Updates the parameters of a single AppConnector. | | `projects_locations_app_connectors_report_status` | `EXEC` | `appConnectorsId, locationsId, projectsId` | Report status for a given connector. | | `projects_locations_app_connectors_resolve_instance_config` | `EXEC` | `appConnectorsId, locationsId, projectsId` | Gets instance configuration for a given AppConnector. An internal method called by a AppConnector to get its container config. | 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 0ecf4d0940..3478f75abe 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_gateways/index.md @@ -28,21 +28,21 @@ 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. | +| `createTime` | `string` | Output only. Timestamp when the resource was created. | +| `updateTime` | `string` | Output only. Timestamp when the resource was last modified. | +| `uri` | `string` | Output only. Server-defined URI for this resource. | | `allocatedConnections` | `array` | Output only. A list of connections allocated for the Gateway | +| `type` | `string` | Required. The type of network connectivity used by the AppGateway. | | `displayName` | `string` | Optional. An arbitrary user-provided name for the AppGateway. Cannot exceed 64 characters. | +| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | | `state` | `string` | Output only. The current state of the AppGateway. | | `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. | -| `type` | `string` | Required. The type of network connectivity used by the AppGateway. | | `hostType` | `string` | Required. The type of hosting used by the AppGateway. | -| `createTime` | `string` | Output only. Timestamp when the resource was created. | -| `labels` | `object` | Optional. Resource labels to represent user provided metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_app_gateways_get` | `SELECT` | `appGatewaysId, locationsId, projectsId` | Gets details of a single AppGateway. | | `projects_locations_app_gateways_list` | `SELECT` | `locationsId, projectsId` | Lists AppGateways in a given project and location. | | `projects_locations_app_gateways_create` | `INSERT` | `locationsId, projectsId` | Creates a new AppGateway in a given project and location. | | `projects_locations_app_gateways_delete` | `DELETE` | `appGatewaysId, locationsId, projectsId` | Deletes a single AppGateway. | | `_projects_locations_app_gateways_list` | `EXEC` | `locationsId, projectsId` | Lists AppGateways in a given project and location. | -| `projects_locations_app_gateways_get` | `EXEC` | `appGatewaysId, locationsId, projectsId` | Gets details of a single AppGateway. | diff --git a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md b/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md index 607766af8d..8010b4e312 100644 --- a/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md +++ b/docs/google-docs/providers/google/beyondcorp/app_gateways_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| 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 ae03f642aa..1a3e47f782 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| 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 db2f61fbe0..c22200f510 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/beyondcorp/index.md b/docs/google-docs/providers/google/beyondcorp/index.md index c94a9f28d8..90958ee158 100644 --- a/docs/google-docs/providers/google/beyondcorp/index.md +++ b/docs/google-docs/providers/google/beyondcorp/index.md @@ -33,7 +33,7 @@ Beyondcorp Enterprise Provides Identity And Context Aware Access Controls For En TypeService TitleBeyondCorp API DescriptionBeyondcorp Enterprise Provides Identity And Context Aware Access Controls For Enterprise Resources And Enables Zero-Trust Access. Using The Beyondcorp Enterprise APIs, Enterprises Can Set Up Multi-Cloud And On-Prem Connectivity Solutions. -Idbeyondcorp:v23.08.00161 +Idbeyondcorp:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/beyondcorp/locations/index.md b/docs/google-docs/providers/google/beyondcorp/locations/index.md index d4c5995019..d4f7e8b710 100644 --- a/docs/google-docs/providers/google/beyondcorp/locations/index.md +++ b/docs/google-docs/providers/google/beyondcorp/locations/index.md @@ -28,13 +28,13 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/beyondcorp/operations/index.md b/docs/google-docs/providers/google/beyondcorp/operations/index.md index 481da1af56..a09ca26205 100644 --- a/docs/google-docs/providers/google/beyondcorp/operations/index.md +++ b/docs/google-docs/providers/google/beyondcorp/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 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. | +| `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 | |:-----|:--------------|:----------------|:------------| +| `organizations_locations_operations_get` | `SELECT` | `locationsId, operationsId, organizationsId` | 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. | | `organizations_locations_operations_list` | `SELECT` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_delete` | `DELETE` | `locationsId, operationsId, organizationsId` | 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`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_organizations_locations_operations_list` | `EXEC` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, organizationsId` | 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`. | -| `organizations_locations_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/bigquery/datasets/index.md b/docs/google-docs/providers/google/bigquery/datasets/index.md index 50b1e1beb0..ae3e1fb232 100644 --- a/docs/google-docs/providers/google/bigquery/datasets/index.md +++ b/docs/google-docs/providers/google/bigquery/datasets/index.md @@ -27,12 +27,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | 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. | +| `id` | `string` | [Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field. | +| `description` | `string` | [Optional] A user-friendly description of the dataset. | +| `kind` | `string` | [Output-only] The resource type. | +| `isCaseInsensitive` | `boolean` | [Optional] Indicates if table names are case insensitive in the dataset. | +| `storageBillingModel` | `string` | [Optional] Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. Default is LOGICAL. | +| `defaultEncryptionConfiguration` | `object` | | +| `tags` | `array` | [Optional]The tags associated with this dataset. Tag keys are globally unique. | +| `defaultTableExpirationMs` | `string` | [Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property. | +| `labels` | `object` | The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information. | +| `defaultRoundingMode` | `string` | [Output-only] The default rounding mode of the dataset. | +| `creationTime` | `string` | [Output-only] The time when this dataset was created, in milliseconds since the epoch. | +| `friendlyName` | `string` | [Optional] A descriptive name for the dataset. | +| `defaultPartitionExpirationMs` | `string` | [Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property. | +| `etag` | `string` | [Output-only] A hash of the resource. | +| `access` | `array` | [Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; | | `datasetReference` | `object` | | +| `satisfiesPzs` | `boolean` | [Output-only] Reserved for future use. | +| `maxTimeTravelHours` | `string` | [Optional] Number of hours for the max time travel for all tables in the dataset. | +| `lastModifiedTime` | `string` | [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch. | +| `externalDatasetReference` | `object` | | +| `defaultCollation` | `string` | [Output-only] The default collation of the dataset. | +| `location` | `string` | The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations. | +| `selfLink` | `string` | [Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/index.md b/docs/google-docs/providers/google/bigquery/index.md index 729736cf37..36a6edd748 100644 --- a/docs/google-docs/providers/google/bigquery/index.md +++ b/docs/google-docs/providers/google/bigquery/index.md @@ -33,7 +33,7 @@ A Data Platform For Customers To Create, Manage, Share And Query Data. TypeService TitleBigQuery API DescriptionA Data Platform For Customers To Create, Manage, Share And Query Data. -Idbigquery:v23.08.00161 +Idbigquery:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/bigquery/jobs/index.md b/docs/google-docs/providers/google/bigquery/jobs/index.md index cde8bbdbbf..8abce280f6 100644 --- a/docs/google-docs/providers/google/bigquery/jobs/index.md +++ b/docs/google-docs/providers/google/bigquery/jobs/index.md @@ -27,13 +27,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | Unique opaque ID of the job. | -| `jobReference` | `object` | | +| `id` | `string` | [Output-only] Opaque ID field of the job | +| `user_email` | `string` | [Output-only] Email address of the user who ran the job. | +| `selfLink` | `string` | [Output-only] A URL that can be used to access this resource again. | +| `etag` | `string` | [Output-only] A hash of this resource. | +| `kind` | `string` | [Output-only] The type of the resource. | | `status` | `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. | -| `errorResult` | `object` | | -| `kind` | `string` | The resource type. | -| `user_email` | `string` | [Full-projection-only] Email address of the user who ran the job. | +| `jobReference` | `object` | | | `statistics` | `object` | | | `configuration` | `object` | | ## Methods 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 9089392916..d243ba0bd3 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 @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `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. | -| `numDmlAffectedRows` | `string` | [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. | -| `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. | | `schema` | `object` | | | `jobReference` | `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. | | `totalBytesProcessed` | `string` | The total number of bytes processed for this query. | -| `etag` | `string` | A hash of this response. | +| `numDmlAffectedRows` | `string` | [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. | +| `pageToken` | `string` | A token used for paging results. | | `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. | | `cacheHit` | `boolean` | Whether the query result was fetched from the query cache. | | `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. | +| `etag` | `string` | A hash of this response. | +| `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. | ## 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 b1c80509ac..0fc4bb87fc 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. | -| `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. | -| `modelType` | `string` | Output only. Type of the model resource. | -| `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. | -| `hparamSearchSpaces` | `object` | Hyperparameter search spaces. These should be a subset of training_options. | -| `trainingRuns` | `array` | Information for all training runs in increasing order of start_time. | -| `etag` | `string` | Output only. A hash of this resource. | | `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. | -| `remoteModelInfo` | `object` | Remote Model Info | -| `creationTime` | `string` | Output only. The time when this model was created, in millisecs since the epoch. | -| `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. | -| `friendlyName` | `string` | Optional. A descriptive name for this model. | +| `modelReference` | `object` | | +| `trainingRuns` | `array` | Information for all training runs in increasing order of start_time. | | `bestTrialId` | `string` | The best trial_id across all training runs. | +| `friendlyName` | `string` | Optional. A descriptive name for this model. | +| `location` | `string` | Output only. The geographic location where the model resides. This value is inherited from the dataset. | +| `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. | +| `etag` | `string` | Output only. A hash of this resource. | | `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. | -| `modelReference` | `object` | | +| `lastModifiedTime` | `string` | Output only. The time when this model was last modified, 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. | +| `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. | +| `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. | | `encryptionConfiguration` | `object` | | +| `remoteModelInfo` | `object` | Remote Model Info | +| `modelType` | `string` | Output only. Type of the model resource. | +| `hparamSearchSpaces` | `object` | Hyperparameter search spaces. These should be a subset of training_options. | | `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. | -| `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. | -| `lastModifiedTime` | `string` | Output only. The time when this model was last modified, in millisecs since the epoch. | -| `location` | `string` | Output only. The geographic location where the model resides. This value is inherited from the dataset. | +| `creationTime` | `string` | Output only. The time when this model was created, in millisecs since the epoch. | +| `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. | ## 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/routines/index.md b/docs/google-docs/providers/google/bigquery/routines/index.md index 8b68321f81..2049fd36ba 100644 --- a/docs/google-docs/providers/google/bigquery/routines/index.md +++ b/docs/google-docs/providers/google/bigquery/routines/index.md @@ -28,22 +28,22 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `description` | `string` | Optional. The description of the routine, if defined. | +| `language` | `string` | Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. | +| `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"} } } ] } } | | `remoteFunctionOptions` | `object` | Options for a remote user-defined function. | +| `creationTime` | `string` | Output only. The time when this routine was created, in milliseconds since the epoch. | +| `routineType` | `string` | Required. The type of routine. | +| `determinismLevel` | `string` | Optional. The determinism level of the JavaScript UDF, if defined. | | `etag` | `string` | Output only. A hash of this resource. | -| `sparkOptions` | `object` | Options for a user-defined Spark 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. | -| `creationTime` | `string` | Output only. The time when this routine was created, in milliseconds since the epoch. | -| `lastModifiedTime` | `string` | Output only. The time when this routine was last modified, in milliseconds since the epoch. | -| `returnTableType` | `object` | A table type | -| `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"} } } ] } } | +| `sparkOptions` | `object` | Options for a user-defined Spark routine. | +| `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. | +| `dataGovernanceType` | `string` | Optional. Data governance specific option, if the value is DATA_MASKING, the function will be validated as masking functions. | | `arguments` | `array` | Optional. | | `routineReference` | `object` | | -| `routineType` | `string` | Required. The type of routine. | +| `returnTableType` | `object` | A table type | +| `lastModifiedTime` | `string` | Output only. The time when this routine was last modified, in milliseconds since the epoch. | | `importedLibraries` | `array` | Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. | -| `dataGovernanceType` | `string` | Optional. Data governance specific option, if the value is DATA_MASKING, the function will be validated as masking functions. | -| `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. | -| `language` | `string` | Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise. | -| `determinismLevel` | `string` | Optional. The determinism level of the JavaScript UDF, if defined. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/row_access_policies/index.md b/docs/google-docs/providers/google/bigquery/row_access_policies/index.md index 13c91508a4..2fd6fdfcab 100644 --- a/docs/google-docs/providers/google/bigquery/row_access_policies/index.md +++ b/docs/google-docs/providers/google/bigquery/row_access_policies/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `lastModifiedTime` | `string` | Output only. The time when this row access policy was last modified, in milliseconds since the epoch. | -| `rowAccessPolicyReference` | `object` | | | `creationTime` | `string` | Output only. The time when this row access policy was created, in milliseconds since the epoch. | | `etag` | `string` | Output only. A hash of this resource. | | `filterPredicate` | `string` | Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0 | +| `lastModifiedTime` | `string` | Output only. The time when this row access policy was last modified, in milliseconds since the epoch. | +| `rowAccessPolicyReference` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigquery/tabledata/index.md b/docs/google-docs/providers/google/bigquery/tabledata/index.md index 47629a0c52..755494938d 100644 --- a/docs/google-docs/providers/google/bigquery/tabledata/index.md +++ b/docs/google-docs/providers/google/bigquery/tabledata/index.md @@ -27,11 +27,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `totalRows` | `string` | The total number of rows in the complete table. | -| `etag` | `string` | A hash of this page of results. | | `kind` | `string` | The resource type of the response. | | `pageToken` | `string` | A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing. | | `rows` | `array` | Rows of results. | +| `totalRows` | `string` | The total number of rows in the complete table. | +| `etag` | `string` | A hash of this page of results. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigquery/tables/index.md b/docs/google-docs/providers/google/bigquery/tables/index.md index e9edec952f..bb162b79ff 100644 --- a/docs/google-docs/providers/google/bigquery/tables/index.md +++ b/docs/google-docs/providers/google/bigquery/tables/index.md @@ -27,18 +27,49 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `id` | `string` | An opaque ID of the table | -| `clustering` | `object` | | -| `labels` | `object` | The labels associated with this table. You can use these to organize and group your tables. | +| `id` | `string` | [Output-only] An opaque ID uniquely identifying the table. | +| `description` | `string` | [Optional] A user-friendly description of this table. | +| `numPhysicalBytes` | `string` | [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel. | +| `type` | `string` | [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE. | +| `selfLink` | `string` | [Output-only] A URL that can be used to access this resource again. | +| `snapshotDefinition` | `object` | | +| `tableConstraints` | `object` | | +| `kind` | `string` | [Output-only] The type of the resource. | +| `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. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables. | | `timePartitioning` | `object` | | -| `rangePartitioning` | `object` | | -| `kind` | `string` | The resource type. | -| `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. | +| `etag` | `string` | [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change. | +| `numRows` | `string` | [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer. | +| `schema` | `object` | | +| `cloneDefinition` | `object` | | +| `friendlyName` | `string` | [Optional] A descriptive name for this table. | +| `location` | `string` | [Output-only] The geographic location where the table resides. This value is inherited from the dataset. | +| `defaultRoundingMode` | `string` | [Output-only] The default rounding mode of the table. | +| `numTotalPhysicalBytes` | `string` | [Output-only] The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. | +| `defaultCollation` | `string` | [Output-only] The default collation of the table. | +| `requirePartitionFilter` | `boolean` | [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. | +| `view` | `object` | | +| `biglakeConfiguration` | `object` | | +| `numLongTermPhysicalBytes` | `string` | [Output-only] Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. | +| `creationTime` | `string` | [Output-only] The time when this table was created, in milliseconds since the epoch. | +| `clustering` | `object` | | +| `labels` | `object` | The labels associated with this table. You can use these to organize and group your tables. 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. | +| `numTimeTravelPhysicalBytes` | `string` | [Output-only] Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes. | +| `numPartitions` | `string` | [Output-only] The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. | +| `numTotalLogicalBytes` | `string` | [Output-only] Total number of logical bytes in the table or materialized view. | +| `externalDataConfiguration` | `object` | | | `tableReference` | `object` | | -| `creationTime` | `string` | The time when this table was created, in milliseconds since the epoch. | -| `type` | `string` | The type of table. Possible values are: TABLE, VIEW. | -| `view` | `object` | Additional details for a view. | +| `model` | `object` | | +| `maxStaleness` | `string` | [Optional] Max staleness of data that could be returned when table or materialized view is queried (formatted as Google SQL Interval type). | +| `numActiveLogicalBytes` | `string` | [Output-only] Number of logical bytes that are less than 90 days old. | +| `rangePartitioning` | `object` | | +| `encryptionConfiguration` | `object` | | +| `lastModifiedTime` | `string` | [Output-only] The time when this table was last modified, in milliseconds since the epoch. | +| `materializedView` | `object` | | +| `streamingBuffer` | `object` | | +| `numActivePhysicalBytes` | `string` | [Output-only] Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes. | +| `numLongTermLogicalBytes` | `string` | [Output-only] Number of logical bytes that are more than 90 days old. | +| `numBytes` | `string` | [Output-only] The size of this table in bytes, excluding any data in the streaming buffer. | +| `numLongTermBytes` | `string` | [Output-only] The number of bytes in the table that are considered "long-term storage". | ## 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 480a84a540..c1764bbdcd 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. | +| `cloudSql` | `object` | Connection properties specific to the Cloud SQL. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryconnection/index.md b/docs/google-docs/providers/google/bigqueryconnection/index.md index f975d8eb8b..fba400a49f 100644 --- a/docs/google-docs/providers/google/bigqueryconnection/index.md +++ b/docs/google-docs/providers/google/bigqueryconnection/index.md @@ -33,7 +33,7 @@ Allows Users To Manage BigQuery Connections To External Data Sources. TypeService TitleBigQuery Connection API DescriptionAllows Users To Manage BigQuery Connections To External Data Sources. -Idbigqueryconnection:v23.08.00161 +Idbigqueryconnection:v23.08.00163 ## Resources 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 0c6e13a5a0..ae0aa80db1 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/data_sources/index.md @@ -29,21 +29,21 @@ 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. | +| `supportsMultipleTransfers` | `boolean` | Deprecated. This field has no effect. | | `helpUrl` | `string` | Url for the help document for this data source. | -| `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. | +| `dataSourceId` | `string` | Data source id. | | `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. | -| `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 | -| `authorizationType` | `string` | Indicates the type of authorization. | -| `parameters` | `array` | Data source parameters. | -| `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`. | -| `defaultDataRefreshWindowDays` | `integer` | Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. | | `displayName` | `string` | User friendly data source name. | -| `minimumScheduleInterval` | `string` | The minimum interval for scheduler to schedule runs. | -| `dataSourceId` | `string` | Data source id. | -| `supportsMultipleTransfers` | `boolean` | Deprecated. This field has no effect. | | `manualRunsDisabled` | `boolean` | Disables backfilling and manual run scheduling for the data source. | -| `transferType` | `string` | Deprecated. This field has no effect. | +| `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. | +| `defaultDataRefreshWindowDays` | `integer` | Default data refresh window on days. Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`. | | `clientId` | `string` | Data source client id which should be used to receive refresh token. | +| `minimumScheduleInterval` | `string` | The minimum interval for scheduler to schedule runs. | +| `transferType` | `string` | Deprecated. This field has no effect. | +| `parameters` | `array` | Data source parameters. | +| `authorizationType` | `string` | Indicates the type of authorization. | +| `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`. | +| `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 | | `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. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/index.md index f4555d0456..47e460e64f 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/index.md @@ -33,7 +33,7 @@ Schedule Queries Or Transfer External Data From SaaS Applications To Google BigQ TypeService TitleBigQuery Data Transfer API DescriptionSchedule Queries Or Transfer External Data From SaaS Applications To Google BigQuery On A Regular Basis. -Idbigquerydatatransfer:v23.08.00161 +Idbigquerydatatransfer:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md index 827db196c9..423bd65207 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/locations/index.md @@ -35,7 +35,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_enroll_data_sources` | `EXEC` | `locationsId, projectsId` | Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and the documents can be found in the public guide for [BigQuery Web UI](https://cloud.google.com/bigquery/bigquery-web-ui) and [Data Transfer Service](https://cloud.google.com/bigquery/docs/working-with-transfers). | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md b/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md index ad3e77f591..cc63cf0583 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/runs/index.md @@ -28,28 +28,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `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. | -| `scheduleTime` | `string` | Minimum time after which a transfer run can be started. | -| `runTime` | `string` | For batch transfer runs, specifies the date and time of the data should be ingested. | -| `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}` | -| `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | +| `startTime` | `string` | Output only. Time when transfer run was started. Parameter ignored by server for input requests. | +| `endTime` | `string` | Output only. Time when transfer run ended. Parameter ignored by server for input requests. | | `dataSourceId` | `string` | Output only. Data source id. | -| `state` | `string` | Data transfer run state. Ignored for input requests. | +| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | | `updateTime` | `string` | Output only. Last time the data transfer run state was updated. | -| `endTime` | `string` | Output only. Time when transfer run ended. 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. | -| `startTime` | `string` | Output only. Time when transfer run was started. Parameter ignored by server for input requests. | +| `destinationDatasetId` | `string` | Output only. The BigQuery target dataset id. | +| `state` | `string` | Data transfer run state. Ignored for input requests. | +| `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | | `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). | +| `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. | +| `runTime` | `string` | For batch transfer runs, specifies the date and time of the data should be ingested. | +| `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}` | | `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 | -| `emailPreferences` | `object` | Represents preferences for sending email notifications for transfer run events. | -| `destinationDatasetId` | `string` | Output only. The BigQuery target dataset id. | +| `scheduleTime` | `string` | Minimum time after which a transfer run can be started. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_transfer_configs_runs_get` | `SELECT` | `locationsId, projectsId, runsId, transferConfigsId` | Returns information about the particular transfer run. | | `projects_locations_transfer_configs_runs_list` | `SELECT` | `locationsId, projectsId, transferConfigsId` | Returns information about running and completed transfer runs. | +| `projects_transfer_configs_runs_get` | `SELECT` | `projectsId, runsId, transferConfigsId` | Returns information about the particular transfer run. | | `projects_transfer_configs_runs_list` | `SELECT` | `projectsId, transferConfigsId` | Returns information about running and completed transfer runs. | | `projects_locations_transfer_configs_runs_delete` | `DELETE` | `locationsId, projectsId, runsId, transferConfigsId` | Deletes the specified transfer run. | | `projects_transfer_configs_runs_delete` | `DELETE` | `projectsId, runsId, transferConfigsId` | Deletes the specified transfer run. | | `_projects_locations_transfer_configs_runs_list` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Returns information about running and completed transfer runs. | | `_projects_transfer_configs_runs_list` | `EXEC` | `projectsId, transferConfigsId` | Returns information about running and completed transfer runs. | -| `projects_locations_transfer_configs_runs_get` | `EXEC` | `locationsId, projectsId, runsId, transferConfigsId` | Returns information about the particular transfer run. | -| `projects_transfer_configs_runs_get` | `EXEC` | `projectsId, runsId, transferConfigsId` | Returns information about the particular transfer run. | 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 d0f4b201c3..9cec09e63e 100644 --- a/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md +++ b/docs/google-docs/providers/google/bigquerydatatransfer/transfer_configs/index.md @@ -28,27 +28,29 @@ 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. | -| `userId` | `string` | Deprecated. Unique ID of the user on whose behalf transfer is done. | -| `destinationDatasetId` | `string` | The BigQuery target dataset id. | -| `updateTime` | `string` | Output only. Data transfer modification time. Ignored by server on input. | | `datasetRegion` | `string` | Output only. Region in which BigQuery dataset is located. | -| `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 | -| `nextRunTime` | `string` | Output only. Next time when data transfer will run. | -| `state` | `string` | Output only. State of the most recently updated transfer run. | -| `ownerInfo` | `object` | Information about a user. | -| `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}` | +| `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 | +| `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. | | `encryptionConfiguration` | `object` | Represents the encryption configuration for a transfer. | -| `disabled` | `boolean` | Is this config disabled. When set to true, no runs are scheduled for a given 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 | -| `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. | +| `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. | +| `destinationDatasetId` | `string` | The BigQuery target dataset id. | | `scheduleOptions` | `object` | Options customizing the data transfer schedule. | -| `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. | +| `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. | +| `disabled` | `boolean` | Is this config disabled. When set to true, no runs are scheduled for a given transfer. | +| `displayName` | `string` | User specified display name for the data transfer. | +| `ownerInfo` | `object` | Information about a user. | +| `state` | `string` | Output only. State of the most recently updated transfer run. | +| `nextRunTime` | `string` | Output only. Next time when data transfer will run. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_transfer_configs_get` | `SELECT` | `locationsId, projectsId, transferConfigsId` | Returns information about a data transfer config. | | `projects_locations_transfer_configs_list` | `SELECT` | `locationsId, projectsId` | Returns information about all transfer configs owned by a project in the specified location. | +| `projects_transfer_configs_get` | `SELECT` | `projectsId, transferConfigsId` | Returns information about a data transfer config. | | `projects_transfer_configs_list` | `SELECT` | `projectsId` | Returns information about all transfer configs owned by a project in the specified location. | | `projects_locations_transfer_configs_create` | `INSERT` | `locationsId, projectsId` | Creates a new data transfer configuration. | | `projects_transfer_configs_create` | `INSERT` | `projectsId` | Creates a new data transfer configuration. | @@ -56,11 +58,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_transfer_configs_delete` | `DELETE` | `projectsId, transferConfigsId` | Deletes a data transfer configuration, including any associated transfer runs and logs. | | `_projects_locations_transfer_configs_list` | `EXEC` | `locationsId, projectsId` | Returns information about all transfer configs owned by a project in the specified location. | | `_projects_transfer_configs_list` | `EXEC` | `projectsId` | Returns information about all transfer configs owned by a project in the specified location. | -| `projects_locations_transfer_configs_get` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Returns information about a data transfer config. | | `projects_locations_transfer_configs_patch` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Updates a data transfer configuration. All fields must be set, even if they are not updated. | | `projects_locations_transfer_configs_schedule_runs` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead. | | `projects_locations_transfer_configs_start_manual_runs` | `EXEC` | `locationsId, projectsId, transferConfigsId` | Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. | -| `projects_transfer_configs_get` | `EXEC` | `projectsId, transferConfigsId` | Returns information about a data transfer config. | | `projects_transfer_configs_patch` | `EXEC` | `projectsId, transferConfigsId` | Updates a data transfer configuration. All fields must be set, even if they are not updated. | | `projects_transfer_configs_schedule_runs` | `EXEC` | `projectsId, transferConfigsId` | Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use StartManualTransferRuns instead. | | `projects_transfer_configs_start_manual_runs` | `EXEC` | `projectsId, transferConfigsId` | Start manual transfer runs to be executed now with schedule_time equal to current time. The transfer runs can be created for a time range where the run_time is between start_time (inclusive) and end_time (exclusive), or for a specific run_time. | 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/capacity_commitments/index.md b/docs/google-docs/providers/google/bigqueryreservation/capacity_commitments/index.md index 55d4bec650..878bcf1824 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. | +| `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. | | `plan` | `string` | Capacity commitment commitment plan. | | `slotCount` | `string` | Number of slots in this commitment. | -| `state` | `string` | Output only. State of the 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). | -| `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. | | `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. | +| `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. | +| `isFlatRate` | `boolean` | Output only. If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment. | +| `commitmentEndTime` | `string` | Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. | +| `state` | `string` | Output only. State of the commitment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigqueryreservation/index.md b/docs/google-docs/providers/google/bigqueryreservation/index.md index 03245f79c3..f264129d87 100644 --- a/docs/google-docs/providers/google/bigqueryreservation/index.md +++ b/docs/google-docs/providers/google/bigqueryreservation/index.md @@ -33,7 +33,7 @@ A Service To Modify Your BigQuery Flat-Rate Reservations. TypeService TitleBigQuery Reservation API DescriptionA Service To Modify Your BigQuery Flat-Rate Reservations. -Idbigqueryreservation:v23.08.00161 +Idbigqueryreservation:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md b/docs/google-docs/providers/google/bigqueryreservation/reservations/index.md index 0d36757abe..b79255d4e2 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. | -| `edition` | `string` | Edition of the reservation. | -| `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. | -| `updateTime` | `string` | Output only. Last update time of the reservation. | -| `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. | | `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. | | `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. | -| `autoscale` | `object` | Auto scaling settings. | | `creationTime` | `string` | Output only. Creation time of the reservation. | +| `updateTime` | `string` | Output only. Last update time of the reservation. | +| `autoscale` | `object` | Auto scaling settings. | +| `edition` | `string` | Edition of the reservation. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md b/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md index 01c4b78c7a..c614a757bf 100644 --- a/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/app_profiles/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The unique name of the app profile. Values are of the form `projects/{project}/instances/{instance}/appProfiles/_a-zA-Z0-9*`. | | `description` | `string` | Long form description of the use case for this AppProfile. | -| `etag` | `string` | Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. | | `multiClusterRoutingUseAny` | `object` | Read/write requests are routed to the nearest cluster in the instance, and will fail over to the nearest cluster that is available in the event of transient errors or delays. Clusters in a region are considered equidistant. Choosing this option sacrifices read-your-writes consistency to improve availability. | | `singleClusterRouting` | `object` | Unconditionally routes all read/write requests to a specific cluster. This option preserves read-your-writes consistency but does not improve availability. | +| `etag` | `string` | Strongly validated etag for optimistic concurrency control. Preserve the value returned from `GetAppProfile` when calling `UpdateAppProfile` to fail the request if there has been a modification in the mean time. The `update_mask` of the request need not include `etag` for this protection to apply. See [Wikipedia](https://en.wikipedia.org/wiki/HTTP_ETag) and [RFC 7232](https://tools.ietf.org/html/rfc7232#section-2.3) for more details. | ## 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 5c75271f41..76ae16caeb 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}`. | -| `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. | -| `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/. | -| `state` | `string` | Output only. The current state of the backup. | -| `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. | | `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}`. | | `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. | +| `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. | | `sizeBytes` | `string` | Output only. Size of the backup in bytes. | +| `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. | +| `state` | `string` | Output only. The current state of 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/. | +| `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/hot_tablets/index.md b/docs/google-docs/providers/google/bigtableadmin/hot_tablets/index.md index 9c27eb3ae3..763af1aa50 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_-]*`. | -| `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). | | `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). | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/index.md b/docs/google-docs/providers/google/bigtableadmin/index.md index d38b1a579b..3f9b0db283 100644 --- a/docs/google-docs/providers/google/bigtableadmin/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/index.md @@ -33,7 +33,7 @@ Administer Your Cloud Bigtable Tables And Instances. TypeService TitleCloud Bigtable Admin API DescriptionAdminister Your Cloud Bigtable Tables And Instances. -Idbigtableadmin:v23.08.00161 +Idbigtableadmin:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/bigtableadmin/instances/index.md b/docs/google-docs/providers/google/bigtableadmin/instances/index.md index 6a9e202960..c9625d090f 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]`. | -| `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. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md b/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md index a71df70677..8878258fc9 100644 --- a/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/instances_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/bigtableadmin/operations/index.md b/docs/google-docs/providers/google/bigtableadmin/operations/index.md index 115f0c32cb..cee89899c0 100644 --- a/docs/google-docs/providers/google/bigtableadmin/operations/index.md +++ b/docs/google-docs/providers/google/bigtableadmin/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/bigtableadmin/tables/index.md b/docs/google-docs/providers/google/bigtableadmin/tables/index.md index 0a30683bc3..42f85b506c 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` | -| `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` | | `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`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/billingbudgets/budgets/index.md b/docs/google-docs/providers/google/billingbudgets/budgets/index.md index 87ead7330b..4e5e9c616b 100644 --- a/docs/google-docs/providers/google/billingbudgets/budgets/index.md +++ b/docs/google-docs/providers/google/billingbudgets/budgets/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 the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. | +| `budgetFilter` | `object` | A filter for a budget, limiting the scope of the cost to calculate. | | `displayName` | `string` | User data for display name in UI. The name must be less than or equal to 60 characters. | | `etag` | `string` | Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. | | `notificationsRule` | `object` | NotificationsRule defines notifications that are sent based on budget spend and thresholds. | | `thresholdRules` | `array` | Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. | | `amount` | `object` | The budgeted amount for each usage period. | -| `budgetFilter` | `object` | A filter for a budget, limiting the scope of the cost to calculate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/billingbudgets/index.md b/docs/google-docs/providers/google/billingbudgets/index.md index 0559216211..57cb9c0f92 100644 --- a/docs/google-docs/providers/google/billingbudgets/index.md +++ b/docs/google-docs/providers/google/billingbudgets/index.md @@ -33,7 +33,7 @@ The Cloud Billing Budget API Stores Cloud Billing Budgets, Which Define A Budget TypeService TitleCloud Billing Budget API DescriptionThe Cloud Billing Budget API Stores Cloud Billing Budgets, Which Define A Budget Plan And The Rules To Execute As Spend Is Tracked Against That Plan. -Idbillingbudgets:v23.08.00161 +Idbillingbudgets:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/binaryauthorization/attestors/index.md b/docs/google-docs/providers/google/binaryauthorization/attestors/index.md index 89d3d7fc53..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. | +| `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. | -| `updateTime` | `string` | Output only. Time when the attestor was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 4d0feb4b47..d2223a62f4 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 | |:-----|:---------|:------------| -| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/binaryauthorization/index.md b/docs/google-docs/providers/google/binaryauthorization/index.md index ca087ff8b6..7c142cce5e 100644 --- a/docs/google-docs/providers/google/binaryauthorization/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/index.md @@ -20,7 +20,7 @@ The Management Interface For Binary Authorization, A Service That Provides Polic
total resources: 6
-total selectable resources: 4
+total selectable resources: 6
total methods: 24
@@ -33,7 +33,7 @@ The Management Interface For Binary Authorization, A Service That Provides Polic TypeService TitleBinary Authorization API DescriptionThe Management Interface For Binary Authorization, A Service That Provides Policy-Based Deployment Validation And Control For Images Deployed To Google Kubernetes Engine (GKE), Anthos Service Mesh, Anthos Clusters, And Cloud Run. -Idbinaryauthorization:v23.08.00161 +Idbinaryauthorization:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/binaryauthorization/policy/index.md b/docs/google-docs/providers/google/binaryauthorization/policy/index.md index 2bda54e65b..e799e690c7 100644 --- a/docs/google-docs/providers/google/binaryauthorization/policy/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/policy/index.md @@ -25,9 +25,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `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. | +| `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` | +| `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. | +| `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. | +| `kubernetesServiceAccountAdmissionRules` | `object` | Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. `test-ns:default` | +| `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. | +| `updateTime` | `string` | Output only. Time when the policy was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_policy` | `EXEC` | `projectsId` | A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the policy for this project. Returns a default policy if the project does not have one. | +| `get_policy` | `SELECT` | `projectsId` | A policy specifies the attestors that must attest to a container image, before the project is allowed to deploy that image. There is at most one policy per project. All image admission requests are permitted if a project has no policy. Gets the policy for this project. Returns a default policy if the project does not have one. | | `update_policy` | `EXEC` | `projectsId` | Creates or updates a project's policy, and returns a copy of the new policy. A policy is always updated as a whole, to avoid race conditions with concurrent policy enforcement (or management!) requests. Returns NOT_FOUND if the project does not exist, INVALID_ARGUMENT if the request is malformed. | 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 b50888ac34..0b0f067bc0 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/binaryauthorization/systempolicy_policy/index.md b/docs/google-docs/providers/google/binaryauthorization/systempolicy_policy/index.md index 8bd261d16d..f12bdf15c8 100644 --- a/docs/google-docs/providers/google/binaryauthorization/systempolicy_policy/index.md +++ b/docs/google-docs/providers/google/binaryauthorization/systempolicy_policy/index.md @@ -25,8 +25,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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` | +| `updateTime` | `string` | Output only. Time when the policy was last updated. | +| `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. | +| `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. | +| `kubernetesServiceAccountAdmissionRules` | `object` | Optional. Per-kubernetes-service-account admission rules. Service account spec format: `namespace:serviceaccount`. e.g. `test-ns: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. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_policy` | `EXEC` | `locationsId` | +| `get_policy` | `SELECT` | `locationsId` | 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 e9b628fb05..3720b80104 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`. | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/blockchainnodeengine/index.md b/docs/google-docs/providers/google/blockchainnodeengine/index.md index 25b0665bbe..5a3204a6b5 100644 --- a/docs/google-docs/providers/google/blockchainnodeengine/index.md +++ b/docs/google-docs/providers/google/blockchainnodeengine/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleBlockchain Node Engine API Description -Idblockchainnodeengine:v23.08.00161 +Idblockchainnodeengine:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md b/docs/google-docs/providers/google/blockchainnodeengine/operations/index.md index d979325474..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}`. | -| `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/certificatemanager/certificate_issuance_configs/index.md b/docs/google-docs/providers/google/certificatemanager/certificate_issuance_configs/index.md index 3100dd56cb..e7932a3b43 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 @@ -29,13 +29,13 @@ 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. | -| `labels` | `object` | Set of labels associated with a CertificateIssuanceConfig. | | `updateTime` | `string` | Output only. The last update timestamp of a CertificateIssuanceConfig. | -| `lifetime` | `string` | Required. Workload certificate lifetime requested. | | `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. | -| `certificateAuthorityConfig` | `object` | The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. | -| `createTime` | `string` | Output only. The creation timestamp of a CertificateIssuanceConfig. | | `keyAlgorithm` | `string` | Required. The key algorithm to use when generating the private key. | +| `createTime` | `string` | Output only. The creation timestamp of a CertificateIssuanceConfig. | +| `labels` | `object` | Set of labels associated with a CertificateIssuanceConfig. | +| `lifetime` | `string` | Required. Workload certificate lifetime requested. | +| `certificateAuthorityConfig` | `object` | The CA that issues the workload certificate. It includes CA address, type, authentication to CA service, etc. | ## 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 7fda02753c..266c241c96 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. | -| `labels` | `object` | Set of labels associated with a Certificate Map Entry. | +| `state` | `string` | Output only. A serving state of this 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. | -| `updateTime` | `string` | Output only. The update timestamp of a Certificate Map Entry. | +| `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/*`. | | `createTime` | `string` | Output only. The creation timestamp of a Certificate Map Entry. | -| `state` | `string` | Output only. A serving state of this Certificate Map Entry. | +| `updateTime` | `string` | Output only. The update timestamp of a Certificate Map Entry. | +| `matcher` | `string` | A predefined matcher for particular cases, other than SNI selection. | ## 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 4a699dcdfd..dc21eded7d 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. | +| `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. | | `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. | ## 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 1783aeb797..be3950bc7f 100644 --- a/docs/google-docs/providers/google/certificatemanager/certificates/index.md +++ b/docs/google-docs/providers/google/certificatemanager/certificates/index.md @@ -29,15 +29,15 @@ 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. | +| `updateTime` | `string` | Output only. The last update timestamp of a Certificate. | | `pemCertificate` | `string` | Output only. The PEM-encoded certificate chain. | | `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. | +| `createTime` | `string` | Output only. The creation timestamp 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. | | `scope` | `string` | Immutable. The scope of the certificate. | -| `createTime` | `string` | Output only. The creation timestamp of a Certificate. | | `expireTime` | `string` | Output only. The expiry timestamp of a Certificate. | -| `labels` | `object` | Set of labels associated with a Certificate. | | `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. | +| `labels` | `object` | Set of labels associated with a Certificate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/certificatemanager/index.md b/docs/google-docs/providers/google/certificatemanager/index.md index d2a9a0b8ef..80480a76e6 100644 --- a/docs/google-docs/providers/google/certificatemanager/index.md +++ b/docs/google-docs/providers/google/certificatemanager/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleCertificate Manager API Description -Idcertificatemanager:v23.08.00161 +Idcertificatemanager:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/certificatemanager/locations/index.md b/docs/google-docs/providers/google/certificatemanager/locations/index.md index 7820382e81..44278ce351 100644 --- a/docs/google-docs/providers/google/certificatemanager/locations/index.md +++ b/docs/google-docs/providers/google/certificatemanager/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/certificatemanager/operations/index.md b/docs/google-docs/providers/google/certificatemanager/operations/index.md index 0fc7f399c7..4a161c5510 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). | ## 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 0be5bd08e6..3b566ff673 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 3eec21bccc..1d7d8fc321 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. | -| `resource` | `object` | A representation of a Google Cloud resource. | -| `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. | -| `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. | | `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/). | -| `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. | | `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"]` | -| `updateTime` | `string` | The last update timestamp of an asset. update_time is updated when create/update/delete operation is performed. | -| `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. | +| `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. | +| `resource` | `object` | A representation of a Google Cloud resource. | | `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. | -| `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`. | +| `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. | +| `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. | +| `updateTime` | `string` | The last update timestamp of an asset. update_time is updated when create/update/delete operation is performed. | | `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. | +| `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`. | | `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). | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudasset/cloudasset/index.md b/docs/google-docs/providers/google/cloudasset/cloudasset/index.md index 20adcb62bb..a5127fc305 100644 --- a/docs/google-docs/providers/google/cloudasset/cloudasset/index.md +++ b/docs/google-docs/providers/google/cloudasset/cloudasset/index.md @@ -30,5 +30,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `analyze_move` | `EXEC` | `resource` | Analyze moving a resource to a specified destination without kicking off the actual move. The analysis is best effort depending on the user's permissions of viewing different hierarchical policies and configurations. The policies and configuration are subject to change before the actual resource migration takes place. | -| `analyze_org_policy_governed_containers` | `EXEC` | `scope` | Analyzes organization policies governed containers (projects, folders or organization) under a scope. | -| `query_assets` | `EXEC` | `parent` | Issue a job that queries assets using a SQL statement compatible with [BigQuery SQL](https://cloud.google.com/bigquery/docs/introduction-sql). If the query execution finishes within timeout and there's no pagination, the full query results will be returned in the `QueryAssetsResponse`. Otherwise, full query results can be obtained by issuing extra requests with the `job_reference` from the a previous `QueryAssets` call. Note, the query result has approximately 10 GB limitation enforced by [BigQuery](https://cloud.google.com/bigquery/docs/best-practices-performance-output). Queries return larger results will result in errors. | +| `export_assets` | `EXEC` | `parent` | Exports assets with time and resource types to a given Cloud Storage location/BigQuery table. For Cloud Storage location destinations, the output format is newline-delimited JSON. Each line represents a google.cloud.asset.v1.Asset in the JSON format; for BigQuery table destinations, the output table stores the fields in asset Protobuf as columns. This API implements the google.longrunning.Operation API, which allows you to keep track of the export. We recommend intervals of at least 2 seconds with exponential retry to poll the export operation result. For regular-size resource parent, the export operation usually finishes within 5 minutes. | +| `search_all_resources` | `EXEC` | `scope` | Searches all Google Cloud resources within the specified scope, such as a project, folder, or organization. The caller must be granted the `cloudasset.assets.searchAllResources` permission on the desired scope, otherwise the request will be rejected. | diff --git a/docs/google-docs/providers/google/cloudasset/feeds/index.md b/docs/google-docs/providers/google/cloudasset/feeds/index.md index f84411455d..e4f24fff58 100644 --- a/docs/google-docs/providers/google/cloudasset/feeds/index.md +++ b/docs/google-docs/providers/google/cloudasset/feeds/index.md @@ -30,5 +30,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `parent` | Lists all asset feeds in a parent project/folder/organization. | | `create` | `INSERT` | `parent` | Creates a feed in a parent project/folder/organization to listen to its asset updates. | -| `delete` | `DELETE` | `name` | Deletes an asset feed. | -| `patch` | `EXEC` | `name` | Updates an asset feed configuration. | diff --git a/docs/google-docs/providers/google/cloudasset/index.md b/docs/google-docs/providers/google/cloudasset/index.md index 514e19b3c0..2c2d45b9ab 100644 --- a/docs/google-docs/providers/google/cloudasset/index.md +++ b/docs/google-docs/providers/google/cloudasset/index.md @@ -20,7 +20,7 @@ The Cloud Asset API Manages The History And Inventory Of Google Cloud Resources.
total resources: 8
-total selectable resources: 3
+total selectable resources: 4
total methods: 16
@@ -33,7 +33,7 @@ The Cloud Asset API Manages The History And Inventory Of Google Cloud Resources. TypeService TitleCloud Asset API DescriptionThe Cloud Asset API Manages The History And Inventory Of Google Cloud Resources. -Idcloudasset:v23.08.00161 +Idcloudasset:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudasset/operations/index.md b/docs/google-docs/providers/google/cloudasset/operations/index.md index f00ca76ed4..dd59115ecf 100644 --- a/docs/google-docs/providers/google/cloudasset/operations/index.md +++ b/docs/google-docs/providers/google/cloudasset/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.cloudasset.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}`. | +| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudasset/saved_queries/index.md b/docs/google-docs/providers/google/cloudasset/saved_queries/index.md index cb265288af..612f46ca5b 100644 --- a/docs/google-docs/providers/google/cloudasset/saved_queries/index.md +++ b/docs/google-docs/providers/google/cloudasset/saved_queries/index.md @@ -40,4 +40,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `list` | `SELECT` | `parent` | Lists all saved queries in a parent project/folder/organization. | | `create` | `INSERT` | `parent` | Creates a saved query in a parent project/folder/organization. | +| `delete` | `DELETE` | `name` | Deletes a saved query. | | `_list` | `EXEC` | `parent` | Lists all saved queries in a parent project/folder/organization. | +| `patch` | `EXEC` | `name` | Updates a saved query. | 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 9c798e7d0e..107c9ccaea 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 1c70b7d6c4..11f772429f 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`. | +| `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. | -| `billingAccountName` | `string` | The resource name of the billing account associated with the project, if any. For example, `billingAccounts/012345-567890-ABCDEF`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudbilling/index.md b/docs/google-docs/providers/google/cloudbilling/index.md index d8adacdb04..8199ec3ddd 100644 --- a/docs/google-docs/providers/google/cloudbilling/index.md +++ b/docs/google-docs/providers/google/cloudbilling/index.md @@ -33,7 +33,7 @@ Allows Developers To Manage Billing For Their Google Cloud Platform Projects Pro TypeService TitleCloud Billing API DescriptionAllows Developers To Manage Billing For Their Google Cloud Platform Projects Programmatically. -Idcloudbilling:v23.08.00161 +Idcloudbilling:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudbilling/skus/index.md b/docs/google-docs/providers/google/cloudbilling/skus/index.md index 480a2a35bc..e11cac93fa 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. | -| `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" | +| `category` | `object` | Represents the category hierarchy of a SKU. | +| `geoTaxonomy` | `object` | Encapsulates the geographic taxonomy data for a sku. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md b/docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md index a84c2db397..a6b52e192e 100644 --- a/docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md +++ b/docs/google-docs/providers/google/cloudbuild/bitbucket_repos/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the repository. | | `description` | `string` | Description of the repository. | +| `browseUri` | `string` | Link to the browse repo page on the Bitbucket Server instance. | | `displayName` | `string` | Display name of the repository. | | `repoId` | `object` | BitbucketServerRepositoryId identifies a specific repository hosted on a Bitbucket Server. | -| `browseUri` | `string` | Link to the browse repo page on the Bitbucket Server instance. | ## 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 878e15e4a6..d66b890814 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. | -| `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. | +| `connectedRepositories` | `array` | Output only. Connected Bitbucket Server repositories for this config. | +| `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. | +| `createTime` | `string` | Time when the config was created. | | `secrets` | `object` | BitbucketServerSecrets represents the secrets in Secret Manager for a Bitbucket Server. | +| `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. | +| `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. | | `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. | -| `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. | | `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. | -| `connectedRepositories` | `array` | Output only. Connected Bitbucket Server repositories for this config. | ## 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 2c39213dd1..15370ed36f 100644 --- a/docs/google-docs/providers/google/cloudbuild/builds/index.md +++ b/docs/google-docs/providers/google/cloudbuild/builds/index.md @@ -29,37 +29,39 @@ 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. | -| `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. | -| `warnings` | `array` | Output only. Non-fatal problems encountered during the execution of the build. | +| `approval` | `object` | BuildApproval describes a build's approval configuration, state, and result. | +| `results` | `object` | Artifacts created by the build pipeline. | | `source` | `object` | Location of the source in a supported storage service. | | `options` | `object` | Optional arguments to enable specific features of builds. | +| `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 | +| `substitutions` | `object` | Substitutions data for `Build` resource. | +| `startTime` | `string` | Output only. Time at which execution of the build was started. | +| `failureInfo` | `object` | A fatal problem encountered during the execution of the build. | +| `logUrl` | `string` | Output only. URL to logs for this build in Google Cloud Console. | | `statusDetail` | `string` | Output only. Customer-readable message about the current status. | -| `tags` | `array` | Tags for annotation of a `Build`. These are not docker tags. | -| `steps` | `array` | Required. The operations to be performed on the workspace. | | `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`. | -| `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. | -| `failureInfo` | `object` | A fatal problem encountered during the execution of the build. | -| `results` | `object` | Artifacts created by the build pipeline. | -| `sourceProvenance` | `object` | Provenance of the source. Ways to find the original source, or verify that some source was used for this build. | -| `status` | `string` | Output only. Status of the build. | +| `createTime` | `string` | Output only. Time at which the request to create the build was received. | | `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`. | -| `availableSecrets` | `object` | Secrets and secret environment variables. | +| `sourceProvenance` | `object` | Provenance of the source. Ways to find the original source, or verify that some source was used for this 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. | | `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. | -| `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 | -| `startTime` | `string` | Output only. Time at which execution of the build was started. | -| `logUrl` | `string` | Output only. URL to logs for this build in Google Cloud Console. | -| `approval` | `object` | BuildApproval describes a build's approval configuration, state, and result. | +| `availableSecrets` | `object` | Secrets and secret environment variables. | | `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. | | `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. | -| `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. | -| `substitutions` | `object` | Substitutions data for `Build` resource. | +| `steps` | `array` | Required. The operations to be performed on the workspace. | +| `warnings` | `array` | Output only. Non-fatal problems encountered during the execution of the build. | +| `status` | `string` | Output only. Status of the build. | +| `tags` | `array` | Tags for annotation of a `Build`. These are not docker tags. | | `projectId` | `string` | Output only. ID of the project. | +| `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. | +| `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. | | `artifacts` | `object` | Artifacts produced by a build that should be uploaded upon successful completion of all build steps. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_builds_get` | `SELECT` | `id, projectId` | Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. | | `projects_builds_list` | `SELECT` | `projectId` | Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. | +| `projects_locations_builds_get` | `SELECT` | `buildsId, locationsId, projectsId` | Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. | | `projects_locations_builds_list` | `SELECT` | `locationsId, projectsId` | Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. | | `projects_builds_create` | `INSERT` | `projectId` | Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). | | `projects_locations_builds_create` | `INSERT` | `locationsId, projectsId` | Starts a build with the specified configuration. This method returns a long-running `Operation`, which includes the build ID. Pass the build ID to `GetBuild` to determine the build status (such as `SUCCESS` or `FAILURE`). | @@ -67,9 +69,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_projects_locations_builds_list` | `EXEC` | `locationsId, projectsId` | Lists previously requested builds. Previously requested builds may still be in-progress, or may have finished successfully or unsuccessfully. | | `projects_builds_approve` | `EXEC` | `buildsId, projectsId` | Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done. | | `projects_builds_cancel` | `EXEC` | `id, projectId` | Cancels a build in progress. | -| `projects_builds_get` | `EXEC` | `id, projectId` | Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. | | `projects_builds_retry` | `EXEC` | `id, projectId` | Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. | | `projects_locations_builds_approve` | `EXEC` | `buildsId, locationsId, projectsId` | Approves or rejects a pending build. If approved, the returned LRO will be analogous to the LRO returned from a CreateBuild call. If rejected, the returned LRO will be immediately done. | | `projects_locations_builds_cancel` | `EXEC` | `buildsId, locationsId, projectsId` | Cancels a build in progress. | -| `projects_locations_builds_get` | `EXEC` | `buildsId, locationsId, projectsId` | Returns information about a previously requested build. The `Build` that is returned includes its status (such as `SUCCESS`, `FAILURE`, or `WORKING`), and timing information. | | `projects_locations_builds_retry` | `EXEC` | `buildsId, locationsId, projectsId` | Creates a new build based on the specified build. This method creates a new build using the original build request, which may or may not result in an identical build. For triggered builds: * Triggered builds resolve to a precise revision; therefore a retry of a triggered build will result in a build that uses the same revision. For non-triggered builds that specify `RepoSource`: * If the original build built from the tip of a branch, the retried build will build from the tip of that branch, which may not be the same revision as the original build. * If the original build specified a commit sha or revision ID, the retried build will use the identical source. For builds that specify `StorageSource`: * If the original build pulled source from Cloud Storage without specifying the generation of the object, the new build will use the current object, which may be different from the original build source. * If the original build pulled source from Cloud Storage and specified the generation of the object, the new build will attempt to use the same object, which may or may not be available depending on the bucket's lifecycle management settings. | diff --git a/docs/google-docs/providers/google/cloudbuild/github_enterprise_configs/index.md b/docs/google-docs/providers/google/cloudbuild/github_enterprise_configs/index.md index 1fb3989431..3275c964c2 100644 --- a/docs/google-docs/providers/google/cloudbuild/github_enterprise_configs/index.md +++ b/docs/google-docs/providers/google/cloudbuild/github_enterprise_configs/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Optional. The full resource name for the GitHubEnterpriseConfig For example: "projects/{$project_id}/locations/{$location_id}/githubEnterpriseConfigs/{$config_id}" | +| `peeredNetwork` | `string` | Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server 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 GitHub Enterprise server 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. | | `secrets` | `object` | GitHubEnterpriseSecrets represents the names of all necessary secrets in Secret Manager for a GitHub Enterprise server. Format is: projects//secrets/. | +| `sslCa` | `string` | Optional. SSL certificate to use for requests to GitHub Enterprise. | | `webhookKey` | `string` | The key that should be attached to webhook calls to the ReceiveWebhook endpoint. | | `displayName` | `string` | Name to display for this config. | +| `appId` | `string` | Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server. | | `createTime` | `string` | Output only. Time when the installation was associated with the project. | -| `sslCa` | `string` | Optional. SSL certificate to use for requests to GitHub Enterprise. | | `hostUrl` | `string` | The URL of the github enterprise host the configuration is for. | -| `peeredNetwork` | `string` | Optional. The network to be used when reaching out to the GitHub Enterprise server. The VPC network must be enabled for private service connection. This should be set if the GitHub Enterprise server 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 GitHub Enterprise server 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. | -| `appId` | `string` | Required. The GitHub app id of the Cloud Build app on the GitHub Enterprise server. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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/index.md b/docs/google-docs/providers/google/cloudbuild/index.md index aad7a63b7d..010c4e4638 100644 --- a/docs/google-docs/providers/google/cloudbuild/index.md +++ b/docs/google-docs/providers/google/cloudbuild/index.md @@ -20,7 +20,7 @@ Creates And Manages Builds On Google Cloud Platform.
total resources: 15
-total selectable resources: 8
+total selectable resources: 9
total methods: 73
@@ -33,7 +33,7 @@ Creates And Manages Builds On Google Cloud Platform. TypeService TitleCloud Build API DescriptionCreates And Manages Builds On Google Cloud Platform. -Idcloudbuild:v23.08.00161 +Idcloudbuild:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudbuild/operations/index.md b/docs/google-docs/providers/google/cloudbuild/operations/index.md index 3ea6c21490..fda89d148c 100644 --- a/docs/google-docs/providers/google/cloudbuild/operations/index.md +++ b/docs/google-docs/providers/google/cloudbuild/operations/index.md @@ -25,11 +25,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `operations_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. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `operations_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`. | -| `operations_get` | `EXEC` | `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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/cloudbuild/triggers/index.md b/docs/google-docs/providers/google/cloudbuild/triggers/index.md index 9990a8382d..eddff7ce53 100644 --- a/docs/google-docs/providers/google/cloudbuild/triggers/index.md +++ b/docs/google-docs/providers/google/cloudbuild/triggers/index.md @@ -30,34 +30,36 @@ 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. | +| `tags` | `array` | Tags for annotation of a `BuildTrigger` | | `createTime` | `string` | Output only. Time when the trigger was created. | +| `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. | +| `github` | `object` | GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub 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. | +| `filename` | `string` | Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). | +| `pubsubConfig` | `object` | PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. | +| `webhookConfig` | `object` | WebhookConfig describes the configuration of a trigger that creates a build whenever a webhook is sent to a trigger's webhook URL. | +| `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. | | `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. | +| `gitlabEnterpriseEventsConfig` | `object` | GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. | +| `repositoryEventConfig` | `object` | The configuration of a trigger that creates a build whenever an event from Repo API is received. | +| `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. | | `gitFileSource` | `object` | GitFileSource describes a file within a (possibly remote) code repository. | -| `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. | -| `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}` | -| `sourceToBuild` | `object` | GitRepoSource describes a repo and ref of a code repository. | -| `disabled` | `boolean` | If true, the trigger will never automatically execute a build. | -| `filter` | `string` | A Common Expression Language string. | -| `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. | | `substitutions` | `object` | Substitutions for Build resource. The keys must match the following regular expression: `^_[A-Z0-9_]+$`. | -| `resourceName` | `string` | The `Trigger` name with format: `projects/{project}/locations/{location}/triggers/{trigger}`, where {trigger} is a unique identifier generated by the service. | +| `disabled` | `boolean` | If true, the trigger will never automatically execute 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. | +| `bitbucketServerTriggerConfig` | `object` | BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server event is received. | | `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. | -| `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. | -| `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. | | `triggerTemplate` | `object` | Location of the source in a Google Cloud Source Repository. | -| `bitbucketServerTriggerConfig` | `object` | BitbucketServerTriggerConfig describes the configuration of a trigger that creates a build whenever a Bitbucket Server 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. | -| `github` | `object` | GitHubEventsConfig describes the configuration of a trigger that creates a build whenever a GitHub event is received. | -| `gitlabEnterpriseEventsConfig` | `object` | GitLabEventsConfig describes the configuration of a trigger that creates a build whenever a GitLab event is received. | -| `tags` | `array` | Tags for annotation of a `BuildTrigger` | -| `pubsubConfig` | `object` | PubsubConfig describes the configuration of a trigger that creates a build whenever a Pub/Sub message is published. | +| `sourceToBuild` | `object` | GitRepoSource describes a repo and ref of a code repository. | | `approvalConfig` | `object` | ApprovalConfig describes configuration for manual approval of a build. | -| `filename` | `string` | Path, from the source root, to the build configuration file (i.e. cloudbuild.yaml). | +| `filter` | `string` | A Common Expression Language string. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_triggers_get` | `SELECT` | `locationsId, projectsId, triggersId` | Returns information about a `BuildTrigger`. This API is experimental. | | `projects_locations_triggers_list` | `SELECT` | `locationsId, projectsId` | Lists existing `BuildTrigger`s. This API is experimental. | +| `projects_triggers_get` | `SELECT` | `projectId, triggerId` | Returns information about a `BuildTrigger`. This API is experimental. | | `projects_triggers_list` | `SELECT` | `projectId` | Lists existing `BuildTrigger`s. This API is experimental. | | `projects_locations_triggers_create` | `INSERT` | `locationsId, projectsId` | Creates a new `BuildTrigger`. This API is experimental. | | `projects_triggers_create` | `INSERT` | `projectId` | Creates a new `BuildTrigger`. This API is experimental. | @@ -65,11 +67,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_triggers_delete` | `DELETE` | `projectId, triggerId` | Deletes a `BuildTrigger` by its project ID and trigger ID. This API is experimental. | | `_projects_locations_triggers_list` | `EXEC` | `locationsId, projectsId` | Lists existing `BuildTrigger`s. This API is experimental. | | `_projects_triggers_list` | `EXEC` | `projectId` | Lists existing `BuildTrigger`s. This API is experimental. | -| `projects_locations_triggers_get` | `EXEC` | `locationsId, projectsId, triggersId` | Returns information about a `BuildTrigger`. This API is experimental. | | `projects_locations_triggers_patch` | `EXEC` | `locationsId, projectsId, triggersId` | Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental. | | `projects_locations_triggers_run` | `EXEC` | `locationsId, projectsId, triggersId` | Runs a `BuildTrigger` at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers. | | `projects_locations_triggers_webhook` | `EXEC` | `locationsId, projectsId, triggersId` | ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger. | -| `projects_triggers_get` | `EXEC` | `projectId, triggerId` | Returns information about a `BuildTrigger`. This API is experimental. | | `projects_triggers_patch` | `EXEC` | `projectId, triggerId` | Updates a `BuildTrigger` by its project ID and trigger ID. This API is experimental. | | `projects_triggers_run` | `EXEC` | `projectId, triggerId` | Runs a `BuildTrigger` at a particular source revision. To run a regional or global trigger, use the POST request that includes the location endpoint in the path (ex. v1/projects/{projectId}/locations/{region}/triggers/{triggerId}:run). The POST request that does not include the location endpoint in the path can only be used when running global triggers. | | `projects_triggers_webhook` | `EXEC` | `projectId, trigger` | ReceiveTriggerWebhook [Experimental] is called when the API receives a webhook request targeted at a specific trigger. | 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 a9b382de4a..3c3ec48d69 100644 --- a/docs/google-docs/providers/google/cloudbuild/worker_pools/index.md +++ b/docs/google-docs/providers/google/cloudbuild/worker_pools/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 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. | -| `displayName` | `string` | A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters. | -| `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`. | -| `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`. | -| `updateTime` | `string` | Output only. Time at which the request to update the `WorkerPool` was received. | -| `annotations` | `object` | User specified annotations. See https://google.aip.dev/128#annotations for more details such as format and size limitations. | +| `privatePoolV1Config` | `object` | Configuration for a V1 `PrivatePool`. | | `state` | `string` | Output only. `WorkerPool` state. | +| `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. | +| `displayName` | `string` | A user-specified, human-readable name for the `WorkerPool`. If provided, this value must be 1-63 characters. | +| `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. | +| `createTime` | `string` | Output only. Time at which the request to create the `WorkerPool` was received. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_worker_pools_get` | `SELECT` | `locationsId, projectsId, workerPoolsId` | Returns details of a `WorkerPool`. | | `projects_locations_worker_pools_list` | `SELECT` | `locationsId, projectsId` | Lists `WorkerPool`s. | | `projects_locations_worker_pools_create` | `INSERT` | `locationsId, projectsId` | Creates a `WorkerPool`. | | `projects_locations_worker_pools_delete` | `DELETE` | `locationsId, projectsId, workerPoolsId` | Deletes a `WorkerPool`. | | `_projects_locations_worker_pools_list` | `EXEC` | `locationsId, projectsId` | Lists `WorkerPool`s. | -| `projects_locations_worker_pools_get` | `EXEC` | `locationsId, projectsId, workerPoolsId` | Returns details of a `WorkerPool`. | | `projects_locations_worker_pools_patch` | `EXEC` | `locationsId, projectsId, workerPoolsId` | Updates a `WorkerPool`. | diff --git a/docs/google-docs/providers/google/clouddeploy/config/index.md b/docs/google-docs/providers/google/clouddeploy/config/index.md index e81732e07c..ae64579241 100644 --- a/docs/google-docs/providers/google/clouddeploy/config/index.md +++ b/docs/google-docs/providers/google/clouddeploy/config/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | 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. | +| `supportedVersions` | `array` | All supported versions of Skaffold. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 8fb4062f4a..95b30ada1b 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. | -| `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 `DeliveryPipeline`. | -| `updateTime` | `string` | Output only. Most recent time at which the pipeline was updated. | +| `createTime` | `string` | Output only. Time at which the pipeline 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. | | `annotations` | `object` | User annotations. These attributes can only be set and used by the user, and not by Cloud Deploy. | -| `serialPipeline` | `object` | SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. | | `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. | +| `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. | +| `serialPipeline` | `object` | SerialPipeline defines a sequential set of stages for a `DeliveryPipeline`. | | `suspended` | `boolean` | When suspended, no new releases or rollouts can be created, but in-progress ones will complete. | -| `createTime` | `string` | Output only. Time at which the pipeline was created. | +| `uid` | `string` | Output only. Unique identifier of the `DeliveryPipeline`. | +| `updateTime` | `string` | Output only. Most recent time at which the pipeline was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouddeploy/index.md b/docs/google-docs/providers/google/clouddeploy/index.md index 207ef136a2..cfe516be29 100644 --- a/docs/google-docs/providers/google/clouddeploy/index.md +++ b/docs/google-docs/providers/google/clouddeploy/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleCloud Deploy API Description -Idclouddeploy:v23.08.00161 +Idclouddeploy:v23.08.00163 ## Resources 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 921befa9d6..4f9a21395f 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}. | -| `postdeployJobRun` | `object` | PostdeployJobRun contains information specific to a postdeploy `JobRun`. | -| `startTime` | `string` | Output only. Time at which the `JobRun` was started. | +| `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. | +| `verifyJobRun` | `object` | VerifyJobRun contains information specific to a verify `JobRun`. | +| `createChildRolloutJobRun` | `object` | CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`. | +| `phaseId` | `string` | Output only. ID of the `Rollout` phase this `JobRun` belongs in. | | `uid` | `string` | Output only. Unique identifier of the `JobRun`. | | `predeployJobRun` | `object` | PredeployJobRun contains information specific to a predeploy `JobRun`. | -| `endTime` | `string` | Output only. Time at which the `JobRun` ended. | -| `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. | -| `createTime` | `string` | Output only. Time at which the `JobRun` was created. | | `deployJobRun` | `object` | DeployJobRun contains information specific to a deploy `JobRun`. | -| `jobId` | `string` | Output only. ID of the `Rollout` job this `JobRun` corresponds to. | -| `phaseId` | `string` | Output only. ID of the `Rollout` phase this `JobRun` belongs in. | -| `createChildRolloutJobRun` | `object` | CreateChildRolloutJobRun contains information specific to a createChildRollout `JobRun`. | +| `postdeployJobRun` | `object` | PostdeployJobRun contains information specific to a postdeploy `JobRun`. | +| `createTime` | `string` | Output only. Time at which the `JobRun` was created. | +| `startTime` | `string` | Output only. Time at which the `JobRun` was started. | +| `endTime` | `string` | Output only. Time at which the `JobRun` ended. | | `state` | `string` | Output only. The current state of the `JobRun`. | +| `jobId` | `string` | Output only. ID of the `Rollout` job this `JobRun` corresponds to. | | `advanceChildRolloutJobRun` | `object` | AdvanceChildRolloutJobRun contains information specific to a advanceChildRollout `JobRun`. | -| `verifyJobRun` | `object` | VerifyJobRun contains information specific to a verify `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 283fcf45dc..a6017e861d 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"` | -| `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/clouddeploy/operations/index.md b/docs/google-docs/providers/google/clouddeploy/operations/index.md index 012260f2f4..afc8cc531f 100644 --- a/docs/google-docs/providers/google/clouddeploy/operations/index.md +++ b/docs/google-docs/providers/google/clouddeploy/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/clouddeploy/releases/index.md b/docs/google-docs/providers/google/clouddeploy/releases/index.md index 1e32857195..3a7bcd0bc4 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. | -| `skaffoldConfigPath` | `string` | Filepath of the Skaffold config inside of the config URI. | -| `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. | -| `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. | -| `targetRenders` | `object` | Output only. Map from target ID to details of the render operation for that target. | -| `renderEndTime` | `string` | Output only. Time at which the render completed. | -| `renderStartTime` | `string` | Output only. Time at which the render began. | -| `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. | -| `deployParameters` | `object` | Optional. The deploy parameters to use for all targets in this release. | -| `createTime` | `string` | Output only. Time at which the `Release` was created. | | `abandoned` | `boolean` | Output only. Indicates whether this is an abandoned release. | -| `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. | -| `skaffoldConfigUri` | `string` | Cloud Storage URI of tar.gz archive containing Skaffold configuration. | | `condition` | `object` | ReleaseCondition contains all conditions relevant to a Release. | +| `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. | +| `buildArtifacts` | `array` | List of artifacts to pass through to Skaffold command. | | `uid` | `string` | Output only. Unique identifier of the `Release`. | -| `renderState` | `string` | Output only. Current state of the render operation. | +| `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. | +| `targetArtifacts` | `object` | Output only. Map from target ID to the target artifacts created during the render operation. | +| `renderEndTime` | `string` | Output only. Time at which the render completed. | +| `createTime` | `string` | Output only. Time at which the `Release` was created. | | `deliveryPipelineSnapshot` | `object` | A `DeliveryPipeline` resource in the Cloud Deploy API. A `DeliveryPipeline` defines a pipeline through which a Skaffold configuration can progress. | +| `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. | +| `deployParameters` | `object` | Optional. The deploy parameters to use for all targets in this release. | +| `skaffoldConfigUri` | `string` | Cloud Storage URI of tar.gz archive containing Skaffold configuration. | | `targetSnapshots` | `array` | Output only. Snapshot of the targets taken at release creation time. | -| `buildArtifacts` | `array` | List of artifacts to pass through to Skaffold command. | -| `targetArtifacts` | `object` | Output only. Map from target ID to the target artifacts created during the render operation. | +| `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. | +| `renderState` | `string` | Output only. Current state of the render operation. | +| `skaffoldConfigPath` | `string` | Filepath of the Skaffold config inside of the config URI. | +| `renderStartTime` | `string` | Output only. Time at which the render began. | +| `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 90a337c1ea..5a6245b061 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. | -| `phases` | `array` | Output only. The phases that represent the workflows of this `Rollout`. | -| `createTime` | `string` | Output only. Time at which the `Rollout` was created. | -| `metadata` | `object` | Metadata includes information associated with a `Rollout`. | -| `uid` | `string` | Output only. Unique identifier of the `Rollout`. | -| `approvalState` | `string` | Output only. Approval state of the `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. | -| `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}`. | -| `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. | -| `controllerRollout` | `string` | Output only. Name of the `ControllerRollout`. Format is projects/{project}/ locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/a-z{0,62}. | -| `enqueueTime` | `string` | Output only. Time at which the `Rollout` was enqueued. | +| `deployFailureCause` | `string` | Output only. The reason this rollout failed. This will always be unspecified while the rollout is in 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. | | `targetId` | `string` | Required. The ID of Target to which this `Rollout` is deploying. | +| `phases` | `array` | Output only. The phases that represent the workflows of this `Rollout`. | +| `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. | +| `failureReason` | `string` | Output only. Additional information about the rollout failure, if available. | +| `approveTime` | `string` | Output only. Time at which the `Rollout` was approved. | +| `approvalState` | `string` | Output only. Approval state of the `Rollout`. | +| `createTime` | `string` | Output only. Time at which the `Rollout` was created. | | `deployEndTime` | `string` | Output only. Time at which the `Rollout` finished 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}`. | | `state` | `string` | Output only. Current state of the `Rollout`. | -| `approveTime` | `string` | Output only. Time at which the `Rollout` was approved. | -| `deployFailureCause` | `string` | Output only. The reason this rollout failed. This will always be unspecified while the rollout is in progress. | +| `uid` | `string` | Output only. Unique identifier of the `Rollout`. | +| `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. | | `deployStartTime` | `string` | Output only. Time at which the `Rollout` started deploying. | +| `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}. | +| `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 4365447368..7d4dd83b30 100644 --- a/docs/google-docs/providers/google/clouddeploy/targets/index.md +++ b/docs/google-docs/providers/google/clouddeploy/targets/index.md @@ -29,19 +29,19 @@ 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. | +| `targetId` | `string` | Output only. Resource id of the `Target`. | +| `updateTime` | `string` | Output only. Most recent time at which the `Target` was updated. | | `gke` | `object` | Information specifying a GKE Cluster. | -| `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. | -| `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`. | +| `run` | `object` | Information specifying where to deploy a Cloud Run Service. | | `uid` | `string` | Output only. Unique identifier of the `Target`. | -| `updateTime` | `string` | Output only. Most recent time at which the `Target` was updated. | | `deployParameters` | `object` | Optional. The deploy parameters to use for this target. | -| `run` | `object` | Information specifying where to deploy a Cloud Run Service. | -| `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`. | +| `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. | +| `anthosCluster` | `object` | Information specifying an Anthos Cluster. | | `multiTarget` | `object` | Information specifying a multiTarget. | | `requireApproval` | `boolean` | Optional. Whether or not the `Target` requires approval. | -| `anthosCluster` | `object` | Information specifying an Anthos Cluster. | -| `targetId` | `string` | Output only. Resource id of the `Target`. | | `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. | | `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. | ## 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 bb2da6a759..8e0ba60f53 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 | |:-----|:---------|:------------| -| `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. | | `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. | ## 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 2662064533..64043c5644 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 | |:-----|:---------|:------------| -| `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. | +| `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. | | `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. | +| `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. | +| `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. | | `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. | -| `group` | `object` | Description of a group of similar error events. | | `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. | | `representative` | `object` | An error event which is returned by the Error Reporting system. | -| `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. | ## 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 7e38bda892..f7cae9655b 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). | -| `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. | +| `resolutionStatus` | `string` | Error group's resolution status. An unspecified resolution status will be interpreted as OPEN | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/clouderrorreporting/index.md b/docs/google-docs/providers/google/clouderrorreporting/index.md index 6070b8b42b..55d1073d37 100644 --- a/docs/google-docs/providers/google/clouderrorreporting/index.md +++ b/docs/google-docs/providers/google/clouderrorreporting/index.md @@ -33,7 +33,7 @@ Groups And Counts Similar Errors From Cloud Services And Applications, Reports N TypeService TitleError Reporting API DescriptionGroups And Counts Similar Errors From Cloud Services And Applications, Reports New Errors, And Provides Access To Error Groups And Their Associated Errors. -Idclouderrorreporting:v23.08.00161 +Idclouderrorreporting:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudfunctions/functions/index.md b/docs/google-docs/providers/google/cloudfunctions/functions/index.md index 053a068def..e4846c51a1 100644 --- a/docs/google-docs/providers/google/cloudfunctions/functions/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/functions/index.md @@ -29,17 +29,17 @@ 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. | -| `labels` | `object` | Labels associated with this Cloud Function. | | `environment` | `string` | Describe whether the function is 1st Gen or 2nd Gen. | +| `stateMessages` | `array` | Output only. State Messages for this Cloud Function. | | `url` | `string` | Output only. The deployed url for the function. | | `serviceConfig` | `object` | Describes the Service being deployed. Currently Supported : Cloud Run (fully managed). | -| `updateTime` | `string` | Output only. The last update timestamp of a Cloud 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. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | | `state` | `string` | Output only. State of the function. | -| `stateMessages` | `array` | Output only. State Messages for this Cloud Function. | +| `updateTime` | `string` | Output only. The last update timestamp of a Cloud 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}`. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `eventTrigger` | `object` | Describes EventTrigger, used to request events to be sent from another service. | +| `labels` | `object` | Labels associated with this Cloud Function. | +| `buildConfig` | `object` | Describes the Build step of the function that builds a container from the given source. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudfunctions/index.md b/docs/google-docs/providers/google/cloudfunctions/index.md index 71dae1faea..0259d4b4d6 100644 --- a/docs/google-docs/providers/google/cloudfunctions/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/index.md @@ -33,7 +33,7 @@ Manages Lightweight User-Provided Functions Executed In Response To Events. TypeService TitleCloud Functions API DescriptionManages Lightweight User-Provided Functions Executed In Response To Events. -Idcloudfunctions:v23.08.00161 +Idcloudfunctions:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudfunctions/locations/index.md b/docs/google-docs/providers/google/cloudfunctions/locations/index.md index 077c0abee1..cd7a6e6dbc 100644 --- a/docs/google-docs/providers/google/cloudfunctions/locations/index.md +++ b/docs/google-docs/providers/google/cloudfunctions/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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudfunctions/operations/index.md b/docs/google-docs/providers/google/cloudfunctions/operations/index.md index 03518f286f..78b67f5c90 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`. | +| `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/cloudidentity/client_states/index.md b/docs/google-docs/providers/google/cloudidentity/client_states/index.md index a12eedb395..f0fd29d1d6 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') | -| `scoreReason` | `string` | A descriptive cause of the health score. | +| `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 | -| `customId` | `string` | This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. | +| `createTime` | `string` | Output only. The time the client state data was created. | +| `scoreReason` | `string` | A descriptive cause of the health score. | | `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. | -| `managed` | `string` | The management state of the resource as specified by the API client. | | `assetTags` | `array` | The caller can specify asset tags for this resource | -| `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. | -| `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. | | `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. | | `lastUpdateTime` | `string` | Output only. The time the client state data was last updated. | +| `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. | ## 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 a15601d05f..20342daa9f 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. | -| `compromisedState` | `string` | Compromised State of the DeviceUser object | -| `managementState` | `string` | Output only. Management state of the user on the device. | | `firstSyncTime` | `string` | Output only. Most recent time when user registered with this service. | -| `lastSyncTime` | `string` | Output only. Last time when user synced with policies. | -| `userAgent` | `string` | Output only. User agent on the device for this specific user | +| `managementState` | `string` | Output only. Management state of the user on the device. | | `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. | -| `createTime` | `string` | When the user first signed in to the device | +| `compromisedState` | `string` | Compromised State of the DeviceUser object | +| `userAgent` | `string` | Output only. User agent on the device for this specific user | | `passwordState` | `string` | Password state of the DeviceUser object | +| `createTime` | `string` | When the user first signed in to the device | +| `lastSyncTime` | `string` | Output only. Last time when user synced with policies. | ## 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 e1b78d93d1..755d1074cd 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. | -| `lastSyncTime` | `string` | Most recent time when device synced with this service. | -| `brand` | `string` | Output only. Device brand. Example: Samsung. | +| `deviceId` | `string` | Unique identifier for the device. | +| `enabledUsbDebugging` | `boolean` | Output only. Whether USB debugging is enabled on device. | | `imei` | `string` | Output only. IMEI number of device if GSM device; empty otherwise. | -| `meid` | `string` | Output only. MEID number of device if CDMA device; empty otherwise. | -| `buildNumber` | `string` | Output only. Build number of the device. | -| `hostname` | `string` | Host name of the device. | -| `model` | `string` | Output only. Model name of device. Example: Pixel 3. | -| `createTime` | `string` | Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. | -| `securityPatchTime` | `string` | Output only. OS security patch update time on device. | -| `manufacturer` | `string` | Output only. Device manufacturer. Example: Motorola. | -| `managementState` | `string` | Output only. Management state of the device | -| `releaseVersion` | `string` | Output only. OS release version. Example: 6.0. | +| `deviceType` | `string` | Output only. Type of device. | | `encryptionState` | `string` | Output only. Device encryption state. | -| `serialNumber` | `string` | Serial Number of device. Example: HT82V1A01076. | | `basebandVersion` | `string` | Output only. Baseband version of the device. | +| `brand` | `string` | Output only. Device brand. Example: Samsung. | | `bootloaderVersion` | `string` | Output only. Device bootloader version. Example: 0.6.7. | -| `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". | -| `kernelVersion` | `string` | Output only. Kernel version of the device. | +| `manufacturer` | `string` | Output only. Device manufacturer. Example: Motorola. | +| `managementState` | `string` | Output only. Management state of the device | +| `networkOperator` | `string` | Output only. Mobile or network operator of device, if available. | +| `hostname` | `string` | Host name of the device. | +| `lastSyncTime` | `string` | Most recent time when device synced with this service. | | `androidSpecificAttributes` | `object` | Resource representing the Android specific attributes of a Device. | -| `osVersion` | `string` | Output only. OS version of the device. Example: Android 8.1.0. | -| `assetTag` | `string` | Asset tag of the device. | +| `serialNumber` | `string` | Serial Number of device. Example: HT82V1A01076. | | `ownerType` | `string` | Output only. Whether the device is owned by the company or an individual | +| `kernelVersion` | `string` | Output only. Kernel version of the device. | +| `buildNumber` | `string` | Output only. Build number of the device. | +| `meid` | `string` | Output only. MEID number of device if CDMA device; empty otherwise. | +| `assetTag` | `string` | Asset tag of the device. | +| `releaseVersion` | `string` | Output only. OS release version. Example: 6.0. | +| `securityPatchTime` | `string` | Output only. OS security patch update time on device. | +| `createTime` | `string` | Output only. When the Company-Owned device was imported. This field is empty for BYOD devices. | | `compromisedState` | `string` | Output only. Represents whether the Device is compromised. | | `wifiMacAddresses` | `array` | WiFi MAC addresses of device. | -| `deviceId` | `string` | Unique identifier for the device. | -| `networkOperator` | `string` | Output only. Mobile or network operator of device, if available. | -| `deviceType` | `string` | Output only. Type of device. | +| `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". | +| `osVersion` | `string` | Output only. OS version of the device. Example: Android 8.1.0. | | `enabledDeveloperOptions` | `boolean` | Output only. Whether developer options is enabled on device. | -| `enabledUsbDebugging` | `boolean` | Output only. Whether USB debugging is enabled on device. | +| `model` | `string` | Output only. Model name of device. Example: Pixel 3. | ## 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 2ed08500f8..4b3d07fbdd 100644 --- a/docs/google-docs/providers/google/cloudidentity/groups/index.md +++ b/docs/google-docs/providers/google/cloudidentity/groups/index.md @@ -29,13 +29,13 @@ 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. | -| `updateTime` | `string` | Output only. The time when the `Group` was last updated. | | `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) | | `displayName` | `string` | The display name of the `Group`. | | `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. | +| `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. | | `additionalGroupKeys` | `array` | Output only. Additional group keys associated with the Group. | +| `updateTime` | `string` | Output only. The time when the `Group` was last updated. | | `createTime` | `string` | Output only. The time when the `Group` was created. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/cloudidentity/idp_credentials/index.md b/docs/google-docs/providers/google/cloudidentity/idp_credentials/index.md index 244c235d64..3d98a33790 100644 --- a/docs/google-docs/providers/google/cloudidentity/idp_credentials/index.md +++ b/docs/google-docs/providers/google/cloudidentity/idp_credentials/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](https://cloud.google.com/apis/design/resource_names) of the credential. | +| `rsaKeyInfo` | `object` | Information of a RSA public key. | | `updateTime` | `string` | Output only. Time when the `IdpCredential` was last updated. | | `dsaKeyInfo` | `object` | Information of a DSA public key. | -| `rsaKeyInfo` | `object` | Information of a RSA public key. | ## 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..f4e62d61c1 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. | -| `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. | +| `ssoMode` | `string` | Inbound SSO behavior. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/index.md b/docs/google-docs/providers/google/cloudidentity/index.md index 0c70dea848..380c416be7 100644 --- a/docs/google-docs/providers/google/cloudidentity/index.md +++ b/docs/google-docs/providers/google/cloudidentity/index.md @@ -20,7 +20,7 @@ API For Provisioning And Managing Identity Resources.
total resources: 11
-total selectable resources: 10
+total selectable resources: 11
total methods: 65
@@ -33,7 +33,7 @@ API For Provisioning And Managing Identity Resources. TypeService TitleCloud Identity API DescriptionAPI For Provisioning And Managing Identity Resources. -Idcloudidentity:v23.08.00161 +Idcloudidentity:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudidentity/memberships/index.md b/docs/google-docs/providers/google/cloudidentity/memberships/index.md index 640b2eeb6d..34d5a119c8 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}`. | +| `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`. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudidentity/memberships_membership_graph/index.md b/docs/google-docs/providers/google/cloudidentity/memberships_membership_graph/index.md index 348c8c5ce0..ac929d287a 100644 --- a/docs/google-docs/providers/google/cloudidentity/memberships_membership_graph/index.md +++ b/docs/google-docs/providers/google/cloudidentity/memberships_membership_graph/index.md @@ -25,8 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_membership_graph` | `EXEC` | `groupsId` | +| `get_membership_graph` | `SELECT` | `groupsId` | diff --git a/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md b/docs/google-docs/providers/google/cloudidentity/userinvitations/index.md index f72f368e23..3fc753e214 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/cloudkms/crypto_key_versions/index.md b/docs/google-docs/providers/google/cloudkms/crypto_key_versions/index.md index 1343ec3d21..2fed9701f6 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/*`. | -| `generationFailureReason` | `string` | Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. | -| `destroyEventTime` | `string` | Output only. The time this CryptoKeyVersion's key material was destroyed. Only present if state is DESTROYED. | +| `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). | | `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. | -| `createTime` | `string` | Output only. The time at which this CryptoKeyVersion was created. | +| `externalDestructionFailureReason` | `string` | Output only. The root cause of the most recent external destruction failure. Only present if state is EXTERNAL_DESTRUCTION_FAILED. | +| `protectionLevel` | `string` | Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. | +| `generationFailureReason` | `string` | Output only. The root cause of the most recent generation failure. Only present if state is GENERATION_FAILED. | | `generateTime` | `string` | Output only. The time this CryptoKeyVersion's key material was generated. | -| `algorithm` | `string` | Output only. The CryptoKeyVersionAlgorithm that this CryptoKeyVersion supports. | | `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. | -| `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). | -| `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. | -| `protectionLevel` | `string` | Output only. The ProtectionLevel describing how crypto operations are performed with this CryptoKeyVersion. | +| `state` | `string` | The current state of the CryptoKeyVersion. | | `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. | -| `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. | +| `importFailureReason` | `string` | Output only. The root cause of the most recent import failure. Only present if state is IMPORT_FAILED. | +| `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. | +| `createTime` | `string` | Output only. The time at which this CryptoKeyVersion was created. | ## 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 6c875a5741..8eea8b229b 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 f991fc3af6..b22b647d82 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/*`. | +| `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. | +| `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. | +| `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. | | `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. | | `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. | | `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). | -| `purpose` | `string` | Immutable. The immutable purpose of this CryptoKey. | -| `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. | -| `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. | -| `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. | | `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. | +| `purpose` | `string` | Immutable. The immutable purpose of this CryptoKey. | +| `labels` | `object` | Labels with user-defined metadata. For more information, see [Labeling Keys](https://cloud.google.com/kms/docs/labeling-keys). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 eefafb0133..4399ce370d 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/*`. | +| `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. | -| `createTime` | `string` | Output only. The time at which the EkmConnection was created. | ## 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 a9557d0426..c005299983 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/*`. | +| `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. | +| `expireEventTime` | `string` | Output only. The time this ImportJob expired. Only present if state is EXPIRED. | +| `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. | +| `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. | | `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). | | `createTime` | `string` | Output only. The time at which this ImportJob was created. | -| `state` | `string` | Output only. The current state of the ImportJob, indicating if it can be used. | -| `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. | -| `expireEventTime` | `string` | Output only. The time this ImportJob expired. Only present if state is EXPIRED. | | `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. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md b/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md index 8d84cea655..423d9610b5 100644 --- a/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md +++ b/docs/google-docs/providers/google/cloudkms/import_jobs_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudkms/index.md b/docs/google-docs/providers/google/cloudkms/index.md index e0aca3b5dd..47791000d2 100644 --- a/docs/google-docs/providers/google/cloudkms/index.md +++ b/docs/google-docs/providers/google/cloudkms/index.md @@ -33,7 +33,7 @@ Manages Keys And Performs Cryptographic Operations In A Central Cloud Service, F TypeService TitleCloud Key Management Service (KMS) API DescriptionManages Keys And Performs Cryptographic Operations In A Central Cloud Service, For Direct Use By Other Cloud Resources And Applications. -Idcloudkms:v23.08.00161 +Idcloudkms:v23.08.00163 ## Resources 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 9049832686..c87d7a982c 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | 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/cloudprofiler/index.md b/docs/google-docs/providers/google/cloudprofiler/index.md index 0842fcddcc..9ffd257097 100644 --- a/docs/google-docs/providers/google/cloudprofiler/index.md +++ b/docs/google-docs/providers/google/cloudprofiler/index.md @@ -33,7 +33,7 @@ Manages Continuous Profiling Information. TypeService TitleCloud Profiler API DescriptionManages Continuous Profiling Information. -Idcloudprofiler:v23.08.00161 +Idcloudprofiler:v23.08.00163 ## Resources 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 fc52713c0d..7f59e50203 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 | |:-----|:---------|:------------| -| `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}`. | +| `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}`. | ## 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 70641cf9f1..04c7c98a1b 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". | +| `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. | | `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}])?`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 207d7d80cd..5f85cf3836 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/index.md b/docs/google-docs/providers/google/cloudresourcemanager/index.md index 66a01b9458..720f29851b 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/index.md @@ -20,7 +20,7 @@ Creates, Reads, And Updates Metadata For Google Cloud Platform Resource Containe
total resources: 17
-total selectable resources: 15
+total selectable resources: 17
total methods: 70
@@ -33,7 +33,7 @@ Creates, Reads, And Updates Metadata For Google Cloud Platform Resource Containe TypeService TitleCloud Resource Manager API DescriptionCreates, Reads, And Updates Metadata For Google Cloud Platform Resource Containers. -Idcloudresourcemanager:v23.08.00161 +Idcloudresourcemanager:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudresourcemanager/operations/index.md b/docs/google-docs/providers/google/cloudresourcemanager/operations/index.md index 55c36059b5..af8b6bd5e7 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/operations/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.cloudresourcemanager.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}`. | +| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md b/docs/google-docs/providers/google/cloudresourcemanager/organizations/index.md index 11465479b0..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. | -| `updateTime` | `string` | Output only. Timestamp when the Organization was last modified. | ## 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 9b3156a069..70abc6e12d 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` | -| `deleteTime` | `string` | Output only. The time at which this resource was requested for deletion. | -| `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` | | `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"` | | `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` | -| `parent` | `string` | Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`. | | `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. | +| `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` | +| `state` | `string` | Output only. The project lifecycle state. | | `updateTime` | `string` | Output only. The most recent time this resource was modified. | +| `deleteTime` | `string` | Output only. The time at which this resource was requested for deletion. | +| `parent` | `string` | Optional. A reference to a parent Resource. eg., `organizations/123` or `folders/876`. | | `createTime` | `string` | Output only. Creation time. | -| `state` | `string` | Output only. The project lifecycle state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 5408a06abd..bf1943d6d4 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/index.md index ab8449480e..40c4d3e558 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_bindings/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 TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`). | -| `tagValueNamespacedName` | `string` | The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected. | | `parent` | `string` | The full resource name of the resource the TagValue is bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123` | | `tagValue` | `string` | The TagValue of the TagBinding. Must be of the form `tagValues/456`. | +| `tagValueNamespacedName` | `string` | The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected. | ## 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 5bd43d95e1..3f28a1e1fa 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys/index.md @@ -30,12 +30,12 @@ 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. | | `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. | -| `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. | -| `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. | | `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. | -| `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. | +| `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. | | `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. | +| `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. | | `createTime` | `string` | Output only. Creation time. | ## Methods | Name | Accessible by | Required Params | Description | 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 98854c4692..8c8caf3f8e 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_namespaced/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_namespaced/index.md index 295753eab3..7303c1a609 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_namespaced/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_keys_namespaced/index.md @@ -25,8 +25,19 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `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. | +| `updateTime` | `string` | Output only. Update time. | +| `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}`. | +| `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 UpdateTagKeyRequest for details. | +| `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 | |:-----|:--------------|:----------------| -| `get_namespaced` | `EXEC` | | +| `get_namespaced` | `SELECT` | | diff --git a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_namespaced/index.md b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_namespaced/index.md index 0cfdd0df7f..de040bf294 100644 --- a/docs/google-docs/providers/google/cloudresourcemanager/tag_values_namespaced/index.md +++ b/docs/google-docs/providers/google/cloudresourcemanager/tag_values_namespaced/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. | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudscheduler/index.md b/docs/google-docs/providers/google/cloudscheduler/index.md index 2ac5eaa913..a084b7ecc2 100644 --- a/docs/google-docs/providers/google/cloudscheduler/index.md +++ b/docs/google-docs/providers/google/cloudscheduler/index.md @@ -33,7 +33,7 @@ Creates And Manages Jobs Run On A Regular Recurring Schedule. TypeService TitleCloud Scheduler API DescriptionCreates And Manages Jobs Run On A Regular Recurring Schedule. -Idcloudscheduler:v23.08.00161 +Idcloudscheduler:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudscheduler/jobs/index.md b/docs/google-docs/providers/google/cloudscheduler/jobs/index.md index 5aa6613f93..e45ba7f70a 100644 --- a/docs/google-docs/providers/google/cloudscheduler/jobs/index.md +++ b/docs/google-docs/providers/google/cloudscheduler/jobs/index.md @@ -29,18 +29,18 @@ 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). | -| `state` | `string` | Output only. State of the job. | -| `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). | -| `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. | +| `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. | | `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. | -| `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. | +| `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). | | `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. | +| `pubsubTarget` | `object` | Pub/Sub target. The job will be delivered by publishing a message to the given Pub/Sub topic. | | `userUpdateTime` | `string` | Output only. The creation time 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). | +| `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. | +| `state` | `string` | Output only. State of the job. | | `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. | -| `lastAttemptTime` | `string` | Output only. The time the last job attempt started. | -| `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/cloudshell/environments/index.md b/docs/google-docs/providers/google/cloudshell/environments/index.md index 3044bb5dc2..7d7ed8797b 100644 --- a/docs/google-docs/providers/google/cloudshell/environments/index.md +++ b/docs/google-docs/providers/google/cloudshell/environments/index.md @@ -31,11 +31,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Immutable. Full name of this resource, in the format `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the email address of the user to whom this environment belongs, and `{environment_id}` is the identifier of this environment. For example, `users/someone@example.com/environments/default`. | | `sshHost` | `string` | Output only. Host to which clients can connect to initiate SSH sessions with the environment. | | `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. | | `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". | +| `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. | | `webHost` | `string` | Output only. Host to which clients can connect to initiate HTTPS or WSS connections with the 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/index.md b/docs/google-docs/providers/google/cloudshell/index.md index 7ef345f01b..2684eb460e 100644 --- a/docs/google-docs/providers/google/cloudshell/index.md +++ b/docs/google-docs/providers/google/cloudshell/index.md @@ -33,7 +33,7 @@ Allows Users To Start, Configure, And Connect To Interactive Shell Sessions Runn TypeService TitleCloud Shell API DescriptionAllows Users To Start, Configure, And Connect To Interactive Shell Sessions Running In The Cloud. -Idcloudshell:v23.08.00161 +Idcloudshell:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudshell/operations/index.md b/docs/google-docs/providers/google/cloudshell/operations/index.md index 0b0f8368ca..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}`. | +| `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/cloudsupport/attachments/index.md b/docs/google-docs/providers/google/cloudsupport/attachments/index.md index 072f104412..f6ce330622 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. | -| `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). | +| `sizeBytes` | `string` | Output only. The size of the attachment in bytes. | +| `createTime` | `string` | Output only. The time at which the attachment was created. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/cloudsupport/cases/index.md b/docs/google-docs/providers/google/cloudsupport/cases/index.md index 27c16b4bea..1bd1eae0f8 100644 --- a/docs/google-docs/providers/google/cloudsupport/cases/index.md +++ b/docs/google-docs/providers/google/cloudsupport/cases/index.md @@ -29,24 +29,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name for the case. | | `description` | `string` | A broad description of the issue. | -| `timeZone` | `string` | The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API. | -| `priority` | `string` | The priority of this case. | +| `state` | `string` | Output only. The current status of the support case. | +| `contactEmail` | `string` | A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. | +| `subscriberEmailAddresses` | `array` | The email addresses to receive updates on this case. | | `creator` | `object` | An object containing information about the effective user and authenticated principal responsible for an action. | -| `createTime` | `string` | Output only. The time this case was created. | | `updateTime` | `string` | Output only. The time this case was last updated. | -| `escalated` | `boolean` | Whether the case is currently escalated. | -| `classification` | `object` | A classification object with a product type and value. | -| `contactEmail` | `string` | A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. | | `languageCode` | `string` | The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., `"en"`, `"zh-CN"`, `"zh-TW"`, `"ja"`, `"ko"`). If no language or an unsupported language is specified, this field defaults to English (en). Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours | -| `subscriberEmailAddresses` | `array` | The email addresses to receive updates on this case. | -| `state` | `string` | Output only. The current status of the support case. | -| `testCase` | `boolean` | Whether this case was created for internal API testing and should not be acted on by the support team. | | `displayName` | `string` | The short summary of the issue reported in this case. | +| `timeZone` | `string` | The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API. | +| `createTime` | `string` | Output only. The time this case was created. | +| `priority` | `string` | The priority of this case. | +| `escalated` | `boolean` | Whether the case is currently escalated. | +| `testCase` | `boolean` | Whether this case was created for internal API testing and should not be acted on by the support team. | +| `classification` | `object` | A classification object with a product type and value. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `name` | Retrieve the specified case. Here is an example of calling this endpoint using cURL: ```shell case="projects/some-project/cases/16033687" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case" ``` | | `list` | `SELECT` | `parent` | Retrieve all cases under the specified parent. Note: Listing cases under an organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`. Here is an example of calling this endpoint using cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` | -| `create` | `INSERT` | `parent` | Create a new case and associate it with the given Google Cloud Resource. The case object must have the following fields set: `display_name`, `description`, `classification`, and `priority`. Here is an example of calling this endpoint using cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` | +| `create` | `INSERT` | `parent` | Create a new case and associate it with a Google Cloud Resource. The case object must have the following fields set: `display_name`, `description`, `classification`, and `priority`. If you're just testing the API and don't want to route your case to an agent, set `testCase=true`. Here is an example of calling this endpoint using cURL: ```shell parent="projects/some-project" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header 'Content-Type: application/json' \ --data '{ "display_name": "Test case created by me.", "description": "a random test case, feel free to close", "classification": { "id": "100IK2AKCLHMGRJ9CDGMOCGP8DM6UTB4BT262T31BT1M2T31DHNMENPO6KS36CPJ786L2TBFEHGN6NPI64R3CDHN8880G08I1H3MURR7DHII0GRCDTQM8" }, "time_zone": "-07:00", "subscriber_email_addresses": [ "foo@domain.com", "bar@domain.com" ], "testCase": true, "priority": "P3" }' \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` | | `_list` | `EXEC` | `parent` | Retrieve all cases under the specified parent. Note: Listing cases under an organization returns only the cases directly parented by that organization. To retrieve all cases under an organization, including cases parented by projects under that organization, use `cases.search`. Here is an example of calling this endpoint using cURL: ```shell parent="projects/some-project" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$parent/cases" ``` | | `close` | `EXEC` | `name` | Close the specified case. Here is an example of calling this endpoint using cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request POST \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$case:close" ``` | | `patch` | `EXEC` | `name` | Update the specified case. Only a subset of fields can be updated. Here is an example of calling this endpoint using cURL: ```shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" ``` | diff --git a/docs/google-docs/providers/google/cloudsupport/comments/index.md b/docs/google-docs/providers/google/cloudsupport/comments/index.md index 35da5dcafc..a560639f30 100644 --- a/docs/google-docs/providers/google/cloudsupport/comments/index.md +++ b/docs/google-docs/providers/google/cloudsupport/comments/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name for the comment. | -| `plainTextBody` | `string` | Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. | | `body` | `string` | The full comment body. Maximum of 12800 characters. This can contain rich text syntax. | | `createTime` | `string` | Output only. The time when this comment was created. | | `creator` | `object` | An object containing information about the effective user and authenticated principal responsible for an action. | +| `plainTextBody` | `string` | Output only. DEPRECATED. An automatically generated plain text version of body with all rich text syntax stripped. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudsupport/index.md b/docs/google-docs/providers/google/cloudsupport/index.md index f7e2ea702c..afccda5253 100644 --- a/docs/google-docs/providers/google/cloudsupport/index.md +++ b/docs/google-docs/providers/google/cloudsupport/index.md @@ -33,7 +33,7 @@ Manages Google Cloud Technical Support Cases For Customer Care Support Offerings TypeService TitleGoogle Cloud Support API DescriptionManages Google Cloud Technical Support Cases For Customer Care Support Offerings. -Idcloudsupport:v23.08.00161 +Idcloudsupport:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudsupport/media/index.md b/docs/google-docs/providers/google/cloudsupport/media/index.md index c6b81d5eda..70deff5cf6 100644 --- a/docs/google-docs/providers/google/cloudsupport/media/index.md +++ b/docs/google-docs/providers/google/cloudsupport/media/index.md @@ -27,7 +27,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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 | -|:-----|:--------------|:----------------|:------------| -| `download` | `EXEC` | `name` | Download a file attachment on a case. Note: HTTP requests must append "?alt=media" to the URL. Here is an example of calling this endpoint using cURL: ```shell name="projects/some-project/cases/43594844/attachments/0674M00000WijAnZAJ" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ "https://cloudsupport.googleapis.com/v2/$name:download?alt=media" ``` | -| `upload` | `EXEC` | `parent` | Create a file attachment on a case or Cloud resource. The attachment object must have the following fields set: filename. Here is an example of calling this endpoint using cURL: ```shell echo "This text is in a file I'm uploading using CSAPI." \ > "./example_file.txt" case="projects/some-project/cases/43594844" curl \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --data-binary @"./example_file.txt" \ "https://cloudsupport.googleapis.com/upload/v2beta/$case/attachments?attachment.filename=uploaded_via_curl.txt" ``` | +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `upload` | `EXEC` | `parent` | diff --git a/docs/google-docs/providers/google/cloudtasks/index.md b/docs/google-docs/providers/google/cloudtasks/index.md index cd10b85158..f2802ba83c 100644 --- a/docs/google-docs/providers/google/cloudtasks/index.md +++ b/docs/google-docs/providers/google/cloudtasks/index.md @@ -33,7 +33,7 @@ Manages The Execution Of Large Numbers Of Distributed Requests. TypeService TitleCloud Tasks API DescriptionManages The Execution Of Large Numbers Of Distributed Requests. -Idcloudtasks:v23.08.00161 +Idcloudtasks:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/cloudtasks/locations/index.md b/docs/google-docs/providers/google/cloudtasks/locations/index.md index 2a07b8feff..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"` | +| `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/cloudtasks/queues/index.md b/docs/google-docs/providers/google/cloudtasks/queues/index.md index c44e54abe0..8c018bc927 100644 --- a/docs/google-docs/providers/google/cloudtasks/queues/index.md +++ b/docs/google-docs/providers/google/cloudtasks/queues/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Caller-specified and required in CreateQueue, after which it becomes output only. The queue name. The queue name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_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 queue'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. | -| `rateLimits` | `object` | Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. | -| `retryConfig` | `object` | Retry config. These settings determine when a failed task attempt is retried. | | `stackdriverLoggingConfig` | `object` | Configuration options for writing logs to [Stackdriver Logging](https://cloud.google.com/logging/docs/). | | `state` | `string` | Output only. The state of the queue. `state` can only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot be used to change `state`. | | `appEngineRoutingOverride` | `object` | App Engine Routing. Defines routing characteristics specific to App Engine - service, version, and instance. For more information about services, versions, and instances see [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). Using AppEngineRouting 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` | | `purgeTime` | `string` | Output only. The last time this queue was purged. All tasks that were created before this time were purged. A queue can be purged using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). Purge time will be truncated to the nearest microsecond. Purge time will be unset if the queue has never been purged. | +| `rateLimits` | `object` | Rate limits. This message determines the maximum rate that tasks can be dispatched by a queue, regardless of whether the dispatch is a first task attempt or a retry. Note: The debugging command, RunTask, will run a task even if the queue has reached its RateLimits. | +| `retryConfig` | `object` | Retry config. These settings determine when a failed task attempt is retried. | ## 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 ec8f7dc454..0ab5e1b33c 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. | +| `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. | | `lastAttempt` | `object` | The status of a task attempt. | -| `responseCount` | `integer` | Output only. The number of attempts which have received a response. | +| `dispatchCount` | `integer` | Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. | | `scheduleTime` | `string` | The time when the task is scheduled to be attempted or retried. `schedule_time` will be truncated to the nearest microsecond. | | `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. | | `createTime` | `string` | Output only. The time that the task was created. `create_time` will be truncated to the nearest second. | -| `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. | -| `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. | +| `firstAttempt` | `object` | The status of a task attempt. | | `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. | +| `responseCount` | `integer` | Output only. The number of attempts which have received a response. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/cloudtrace/index.md b/docs/google-docs/providers/google/cloudtrace/index.md index a91e968688..e5c4b4f005 100644 --- a/docs/google-docs/providers/google/cloudtrace/index.md +++ b/docs/google-docs/providers/google/cloudtrace/index.md @@ -33,7 +33,7 @@ Sends Application Trace Data To Cloud Trace For Viewing. Trace Data Is Collected TypeService TitleCloud Trace API DescriptionSends Application Trace Data To Cloud Trace For Viewing. Trace Data Is Collected For All App Engine Applications By Default. Trace Data From Other Applications Can Be Provided Using This API. This Library Is Used To Interact With The Cloud Trace API Directly. If You Are Looking To Instrument Your Application For Cloud Trace, We Recommend Using OpenTelemetry. -Idcloudtrace:v23.08.00161 +Idcloudtrace:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/composer/environments/index.md b/docs/google-docs/providers/google/composer/environments/index.md index 616951c285..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. | -| `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. | | `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/image_versions/index.md b/docs/google-docs/providers/google/composer/image_versions/index.md index ffadabfa10..50f364d535 100644 --- a/docs/google-docs/providers/google/composer/image_versions/index.md +++ b/docs/google-docs/providers/google/composer/image_versions/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `isDefault` | `boolean` | Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. | | `releaseDate` | `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 | | `supportedPythonVersions` | `array` | supported python versions | | `upgradeDisabled` | `boolean` | Whether it is impossible to upgrade an environment running with the image version. | | `creationDisabled` | `boolean` | Whether it is impossible to create an environment with the image version. | | `imageVersionId` | `string` | The string identifier of the ImageVersion, in the form: "composer-x.y.z-airflow-a.b.c" | -| `isDefault` | `boolean` | Whether this is the default ImageVersion used by Composer during environment creation if no input ImageVersion is specified. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/composer/index.md b/docs/google-docs/providers/google/composer/index.md index 1978b36f24..056d7b74e0 100644 --- a/docs/google-docs/providers/google/composer/index.md +++ b/docs/google-docs/providers/google/composer/index.md @@ -33,7 +33,7 @@ Manages Apache Airflow Environments On Google Cloud Platform. TypeService TitleCloud Composer API DescriptionManages Apache Airflow Environments On Google Cloud Platform. -Idcomposer:v23.08.00161 +Idcomposer:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/composer/operations/index.md b/docs/google-docs/providers/google/composer/operations/index.md index 2e0b6be44d..3fcdce91f4 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}`. | -| `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/compute/accelerator_types/index.md b/docs/google-docs/providers/google/compute/accelerator_types/index.md index e59bbdf607..f07e6b571f 100644 --- a/docs/google-docs/providers/google/compute/accelerator_types/index.md +++ b/docs/google-docs/providers/google/compute/accelerator_types/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` | [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. | | `maximumCardsPerInstance` | `integer` | [Output Only] Maximum number of accelerator cards allowed per instance. | | `selfLink` | `string` | [Output Only] Server-defined, fully qualified URL for this resource. | -| `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. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#acceleratorType for accelerator types. | -| `deprecated` | `object` | Deprecation status for a public resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `deprecated` | `object` | Deprecation status for a public resource. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of accelerator types. | | `get` | `SELECT` | `acceleratorType, project, zone` | Returns the specified accelerator type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of accelerator types that are available to the specified project. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of accelerator types that are available to the specified project. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of accelerator types. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of accelerator types. | diff --git a/docs/google-docs/providers/google/compute/addresses/index.md b/docs/google-docs/providers/google/compute/addresses/index.md index 5824c37812..71a42bc86c 100644 --- a/docs/google-docs/providers/google/compute/addresses/index.md +++ b/docs/google-docs/providers/google/compute/addresses/index.md @@ -30,31 +30,31 @@ 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. | +| `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | +| `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. | -| `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | -| `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.* | -| `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. | | `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. | +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | +| `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. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | +| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | +| `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | +| `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.* | | `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `address` | `string` | The static IP address represented by this resource. | | `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | -| `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. | -| `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. | -| `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. | +| `address` | `string` | The static IP address represented by this resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of addresses. | | `get` | `SELECT` | `address, project, region` | Returns the specified address resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of addresses contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates an address resource in the specified project by using the data included in the request. | | `delete` | `DELETE` | `address, project, region` | Deletes the specified address resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of addresses contained within the specified region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of addresses. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of addresses. | | `move` | `EXEC` | `address, project, region` | Moves the specified address resource. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/autoscalers/index.md b/docs/google-docs/providers/google/compute/autoscalers/index.md index ab894fe14f..0572d5b0a4 100644 --- a/docs/google-docs/providers/google/compute/autoscalers/index.md +++ b/docs/google-docs/providers/google/compute/autoscalers/index.md @@ -30,25 +30,25 @@ 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. | -| `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | -| `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | -| `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). | +| `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. | | `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. | | `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). | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | +| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | | `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#autoscaler for autoscalers. | +| `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | +| `selfLink` | `string` | [Output Only] Server-defined URL for 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of autoscalers. | | `get` | `SELECT` | `autoscaler, project, zone` | Returns the specified autoscaler resource. | | `list` | `SELECT` | `project, zone` | Retrieves a list of autoscalers contained within the specified zone. | | `insert` | `INSERT` | `project, zone` | Creates an autoscaler in the specified project using the data included in the request. | | `delete` | `DELETE` | `autoscaler, project, zone` | Deletes the specified autoscaler. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of autoscalers contained within the specified zone. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of autoscalers. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of autoscalers. | | `patch` | `EXEC` | `project, zone` | Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, zone` | Updates an autoscaler in the specified project using the data included in the request. | 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 133d6fa1d4..054e01e689 100644 --- a/docs/google-docs/providers/google/compute/backend_buckets/index.md +++ b/docs/google-docs/providers/google/compute/backend_buckets/index.md @@ -30,14 +30,14 @@ 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. | -| `customResponseHeaders` | `array` | Headers that the Application Load Balancer should add to proxied responses. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend bucket. | | `enableCdn` | `boolean` | If true, enable Cloud CDN for this BackendBucket. | -| `kind` | `string` | Type of the resource. | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend bucket. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | -| `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. | +| `customResponseHeaders` | `array` | Headers that the Application Load Balancer should add to proxied responses. | +| `kind` | `string` | Type of the resource. | | `bucketName` | `string` | Cloud Storage bucket name. | ## Methods | Name | Accessible by | Required Params | Description | @@ -46,7 +46,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of BackendBucket resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a BackendBucket resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `backendBucket, project` | Deletes the specified BackendBucket resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of BackendBucket resources available to the specified project. | | `patch` | `EXEC` | `backendBucket, project` | Updates the specified BackendBucket resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_edge_security_policy` | `EXEC` | `backendBucket, project` | Sets the edge security policy for the specified backend bucket. | | `update` | `EXEC` | `backendBucket, project` | Updates the specified BackendBucket resource with the data included in the request. | 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 ab9d43b907..6c86c1dfdf 100644 --- a/docs/google-docs/providers/google/compute/backend_services/index.md +++ b/docs/google-docs/providers/google/compute/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. | -| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | -| `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. | -| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `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. | -| `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. | -| `backends` | `array` | The list of backends that serve this BackendService. | -| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | -| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | -| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | | `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | -| `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. | -| `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. | +| `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. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge 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. | +| `connectionDraining` | `object` | Message containing connection draining configuration. | +| `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. | -| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a 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. | | `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | | `consistentHash` | `object` | This message defines settings for a consistent hash style 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. | -| `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. | -| `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. | -| `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. | -| `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. | -| `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). | -| `connectionDraining` | `object` | Message containing connection draining configuration. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `iap` | `object` | Identity-Aware Proxy | | `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. | +| `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. | +| `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. | | `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. | -| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | +| `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. | | `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). | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | +| `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. | +| `backends` | `array` | The list of backends that serve this 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). | +| `logConfig` | `object` | The available logging options for the load balancer traffic served by 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. | | `customRequestHeaders` | `array` | Headers that the load balancer adds to proxied requests. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `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. | -| `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. | -| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | +| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | +| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -74,7 +74,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of BackendService resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview . | | `delete` | `DELETE` | `backendService, project` | Deletes the specified BackendService resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of BackendService resources available to the specified project. | | `patch` | `EXEC` | `backendService, project` | Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_edge_security_policy` | `EXEC` | `backendService, project` | Sets the edge security policy for the specified backend service. | | `set_security_policy` | `EXEC` | `backendService, project` | Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview | diff --git a/docs/google-docs/providers/google/compute/backend_services_aggregated/index.md b/docs/google-docs/providers/google/compute/backend_services_aggregated/index.md index 586f53b18b..0eb923cd75 100644 --- a/docs/google-docs/providers/google/compute/backend_services_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/backend_services_aggregated/index.md @@ -25,8 +25,50 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `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). | +| `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. | +| `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. | +| `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. | +| `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. | +| `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | +| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | +| `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. | +| `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. | +| `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). | +| `connectionDraining` | `object` | Message containing connection draining configuration. | +| `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). | +| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a backend service. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `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. | +| `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. | +| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | +| `iap` | `object` | Identity-Aware Proxy | +| `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. | +| `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. | +| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for 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. | +| `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | +| `backends` | `array` | The list of backends that serve this 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). | +| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | +| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) 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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 c8560feda4..9771dc6c4a 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | 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 6ce8dddff7..e853263b21 100644 --- a/docs/google-docs/providers/google/compute/disk_types/index.md +++ b/docs/google-docs/providers/google/compute/disk_types/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` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of this resource. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | -| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | | `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. | +| `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. | +| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | +| `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". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of disk types. | | `get` | `SELECT` | `diskType, project, zone` | Returns the specified disk type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of disk types available to the specified project. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of disk types available to the specified project. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of disk types. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of disk types. | diff --git a/docs/google-docs/providers/google/compute/disks/index.md b/docs/google-docs/providers/google/compute/disks/index.md index f74742d8b3..7a52ab2f3b 100644 --- a/docs/google-docs/providers/google/compute/disks/index.md +++ b/docs/google-docs/providers/google/compute/disks/index.md @@ -31,55 +31,55 @@ 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. | | `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | -| `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `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. | -| `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. | | `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. | +| `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 | +| `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | +| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | +| `asyncPrimaryDisk` | `object` | | +| `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. | | `resourceStatus` | `object` | | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `params` | `object` | Additional disk params. | +| `options` | `string` | Internal use only. | +| `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. | +| `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `sourceImageEncryptionKey` | `object` | | | `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. | +| `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. | +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `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. | | `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. | +| `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. | +| `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 | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `asyncPrimaryDisk` | `object` | | -| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | +| `sourceSnapshotEncryptionKey` | `object` | | +| `diskEncryptionKey` | `object` | | | `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | -| `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 | +| `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. | | `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `options` | `string` | Internal use only. | -| `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `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. | -| `sourceSnapshotEncryptionKey` | `object` | | -| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | -| `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. | -| `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. | -| `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. | -| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | +| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | | `lastDetachTimestamp` | `string` | [Output Only] Last detach 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 | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | | `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. | -| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | -| `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. | -| `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | -| `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. | -| `sourceImageEncryptionKey` | `object` | | -| `params` | `object` | Additional disk params. | -| `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 | -| `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | +| `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 greater than 0. | +| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | | `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. | -| `diskEncryptionKey` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of persistent disks. | | `get` | `SELECT` | `disk, project, zone` | Returns the specified persistent disk. | | `list` | `SELECT` | `project, zone` | Retrieves a list of persistent disks contained within the specified zone. | | `insert` | `INSERT` | `project, zone` | Creates a persistent disk in the specified project using the data in the request. You can create a disk from a source (sourceImage, sourceSnapshot, or sourceDisk) or create an empty 500 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property. | | `delete` | `DELETE` | `disk, project, zone` | Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of persistent disks contained within the specified zone. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of persistent disks. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of persistent disks. | | `bulk_insert` | `EXEC` | `project, zone` | Bulk create a set of disks. | | `resize` | `EXEC` | `disk, project, zone` | Resizes the specified persistent disk. You can only increase the size of the disk. | | `set_labels` | `EXEC` | `project, resource, zone` | Sets the labels on a disk. To learn more about labels, read the Labeling Resources documentation. | 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 3ae553ad40..b27de98d3a 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. | -| `redundancyType` | `string` | Indicates the user-supplied redundancy type of this external VPN gateway. | | `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the 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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#externalVpnGateway for externalVpnGateways. | +| `redundancyType` | `string` | Indicates the user-supplied redundancy type of this 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,5 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of ExternalVpnGateway available to the specified project. | | `insert` | `INSERT` | `project` | Creates a ExternalVpnGateway in the specified project using the data included in the request. | | `delete` | `DELETE` | `externalVpnGateway, project` | Deletes the specified externalVpnGateway. | -| `_list` | `EXEC` | `project` | Retrieves the list of ExternalVpnGateway available to the specified project. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on an ExternalVpnGateway. To learn more about labels, read the Labeling Resources documentation. | 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 d140e66848..4dd55fcfa9 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. | -| `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. | -| `associations` | `array` | A list of associations that belong to this firewall policy. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `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. | | `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | +| `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. | +| `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. | +| `associations` | `array` | A list of associations that belong to this firewall policy. | | `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,7 +49,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | | Lists all the policies that have been configured for the specified folder or organization. | | `insert` | `INSERT` | | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `firewallPolicy` | Deletes the specified policy. | -| `_list` | `EXEC` | | Lists all the policies that have been configured for the specified folder or organization. | | `clone_rules` | `EXEC` | `firewallPolicy` | Copies rules to the specified firewall policy. | | `move` | `EXEC` | `firewallPolicy` | Moves the specified firewall policy. | | `patch` | `EXEC` | `firewallPolicy` | Patches the specified policy with the data included in the request. | 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 05eb31baf5..8b36ee7bec 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. | -| `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. | -| `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | | `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. | -| `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. | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | -| `action` | `string` | The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". | +| `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. | +| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | | `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. | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | | `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. | -| `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. | | `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | +| `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. | +| `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. | +| `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. | ## 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 4473665a27..aeaedf2646 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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#firewall for firewall rules. | -| `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`. | -| `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. | -| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | | `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. | -| `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. | +| `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. | +| `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. | | `logConfig` | `object` | The available logging options for a firewall rule. | +| `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. | | `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. | -| `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. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | -| `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. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#firewall for firewall rules. | +| `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`. | | `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 | +| `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. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,6 +53,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of firewall rules available to the specified project. | | `insert` | `INSERT` | `project` | Creates a firewall rule in the specified project using the data included in the request. | | `delete` | `DELETE` | `firewall, project` | Deletes the specified firewall. | -| `_list` | `EXEC` | `project` | Retrieves the list of firewall rules available to the specified project. | | `patch` | `EXEC` | `firewall, project` | Updates the specified firewall rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `firewall, project` | Updates the specified firewall rule with the data included in the request. Note that all fields will be updated if using PUT, even fields that are not specified. To update individual fields, please use PATCH instead. | 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 8a17c4cd90..99183a63a8 100644 --- a/docs/google-docs/providers/google/compute/forwarding_rules/index.md +++ b/docs/google-docs/providers/google/compute/forwarding_rules/index.md @@ -30,46 +30,46 @@ 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. | -| `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. | -| `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. | +| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | +| `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. | +| `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. | +| `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+)? | +| `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. | +| `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). | | `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. | +| `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. | +| `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. | | `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. | -| `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | +| `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). | +| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | +| `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. | +| `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. | +| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | +| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | | `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. | -| `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. | +| `pscConnectionStatus` | `string` | | +| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | +| `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. | +| `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+)? | +| `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. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#forwardingRule for Forwarding Rule resources. | | `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. | | `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. | -| `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. | | `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. | -| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | -| `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). | -| `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. | -| `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+)? | -| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | -| `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+)? | -| `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 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. | -| `pscConnectionStatus` | `string` | | -| `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | +| `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. | | `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. | -| `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. | -| `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. | -| `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | -| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | -| `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). | -| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of forwarding rules. | | `get` | `SELECT` | `forwardingRule, project, region` | Returns the specified ForwardingRule resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of ForwardingRule resources available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a ForwardingRule resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `forwardingRule, project, region` | Deletes the specified ForwardingRule resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of ForwardingRule resources available to the specified project and region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of forwarding rules. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of forwarding rules. | | `patch` | `EXEC` | `forwardingRule, project, region` | Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation. | | `set_target` | `EXEC` | `forwardingRule, project, region` | Changes target URL for forwarding rule. The new target should be of the same type as the old target. | 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 cfaba706ad..f8dcb5f1b6 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. | -| `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. | -| `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.* | -| `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. | -| `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. | -| `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. | +| `prefixLength` | `integer` | The prefix length if the resource represents an IP range. | | `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. | -| `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | -| `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. | -| `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. | -| `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. | | `address` | `string` | The static IP address represented by this resource. | -| `users` | `array` | [Output Only] The URLs of the resources that are using this address. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | | `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. | +| `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. | +| `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. | +| `addressType` | `string` | The type of address to reserve, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. | +| `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.* | +| `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. | +| `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. | +| `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#address for addresses. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -54,6 +54,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of global addresses. | | `insert` | `INSERT` | `project` | Creates an address resource in the specified project by using the data included in the request. | | `delete` | `DELETE` | `address, project` | Deletes the specified address resource. | -| `_list` | `EXEC` | `project` | Retrieves a list of global addresses. | | `move` | `EXEC` | `address, project` | Moves the specified address resource from one project to another project. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. | 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 7fc6c4d15e..ecacd3593a 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. | -| `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+)? | -| `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). | -| `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. | -| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | -| `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. | | `allowPscGlobalAccess` | `boolean` | This is used in PSC consumer ForwardingRule to control whether the PSC endpoint can be accessed from another region. | +| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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+)? | | `loadBalancingScheme` | `string` | Specifies the forwarding rule type. For more information about forwarding rules, refer to Forwarding rule concepts. | +| `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. | +| `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. | | `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. | -| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | -| `serviceDirectoryRegistrations` | `array` | Service Directory resources to register this forwarding rule with. Currently, only supports a single Service Directory resource. | -| `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. | +| `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). | | `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. | -| `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+)? | +| `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. | +| `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. | +| `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. | +| `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 forwarding rule. Valid options are IPV4 or IPV6. | +| `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. | +| `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. | +| `pscConnectionId` | `string` | [Output Only] The PSC connection id of the PSC Forwarding Rule. | +| `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. | +| `serviceName` | `string` | [Output Only] The internal fully qualified service name for this Forwarding Rule. This field is only used for internal load balancing. | | `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. | +| `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+)? | +| `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. | +| `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. | | `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. | | `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. | -| `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. | -| `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). | -| `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. | -| `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. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | -| `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. | -| `ipVersion` | `string` | The IP Version that will be used by this forwarding rule. Valid options are IPV4 or IPV6. | -| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -68,7 +68,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of GlobalForwardingRule resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a GlobalForwardingRule resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `forwardingRule, project` | Deletes the specified GlobalForwardingRule resource. | -| `_list` | `EXEC` | `project` | Retrieves a list of GlobalForwardingRule resources available to the specified project. | | `patch` | `EXEC` | `forwardingRule, project` | Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation. | | `set_target` | `EXEC` | `forwardingRule, project` | Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target. | 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 96f48cad90..f85800e4cb 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. | -| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | | `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | +| `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | | `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | +| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | | `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | | `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. | +| `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. | | `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" | | `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. | | `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,6 +53,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of network endpoint groups that are located in the specified project. | | `insert` | `INSERT` | `project` | Creates a network endpoint group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `networkEndpointGroup, project` | Deletes the specified network endpoint group.Note that the NEG cannot be deleted if there are backend services referencing it. | -| `_list` | `EXEC` | `project` | Retrieves the list of network endpoint groups that are located in the specified project. | | `attach_network_endpoints` | `EXEC` | `networkEndpointGroup, project` | Attach a network endpoint to the specified network endpoint group. | | `detach_network_endpoints` | `EXEC` | `networkEndpointGroup, project` | Detach the network endpoint from the specified network endpoint group. | 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 972476488e..4428834751 100644 --- a/docs/google-docs/providers/google/compute/global_operations/index.md +++ b/docs/google-docs/providers/google/compute/global_operations/index.md @@ -30,33 +30,33 @@ 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. | +| `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. | | `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `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. | +| `instancesBulkInsertOperationMetadata` | `object` | | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. 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. | -| `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. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `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. | | `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `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. | -| `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. | +| `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. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. 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. | -| `warnings` | `array` | [Output Only] If warning messages 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. | -| `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. | | `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. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | +| `warnings` | `array` | [Output Only] If warning messages 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`. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project` | Retrieves the specified Operations resource. | | `list` | `SELECT` | `project` | Retrieves a list of Operation resources contained within the specified project. | | `delete` | `DELETE` | `operation, project` | Deletes the specified Operations resource. | -| `_list` | `EXEC` | `project` | Retrieves a list of Operation resources contained within the specified project. | | `wait` | `EXEC` | `operation, project` | Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. | diff --git a/docs/google-docs/providers/google/compute/global_operations_aggregated/index.md b/docs/google-docs/providers/google/compute/global_operations_aggregated/index.md index 732be00e47..392703e8fb 100644 --- a/docs/google-docs/providers/google/compute/global_operations_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/global_operations_aggregated/index.md @@ -25,8 +25,36 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `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. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | +| `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. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `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. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `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. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | +| `instancesBulkInsertOperationMetadata` | `object` | | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `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. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 048a7305a4..af599ad736 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,32 +30,32 @@ 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. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | | `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. | -| `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. | +| `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. | -| `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`. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `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. | -| `insertTime` | `string` | [Output Only] The time that this operation was requested. 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. | +| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | | `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`. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | | `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | | `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `instancesBulkInsertOperationMetadata` | `object` | | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. 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. | | `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. | -| `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. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | +| `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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation` | Retrieves the specified Operations resource. Gets a list of operations by making a `list()` request. | | `list` | `SELECT` | | Retrieves a list of Operation resources contained within the specified organization. | | `delete` | `DELETE` | `operation` | Deletes the specified Operations resource. | -| `_list` | `EXEC` | | Retrieves a list of Operation resources contained within the specified organization. | 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 c4725e4466..0fc2329ac8 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 @@ -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. | | `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. | -| `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. | -| `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. | +| `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. | -| `isLiveMigration` | `boolean` | If true, the prefix will be live migrated. | +| `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. | -| `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. | +| `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by this public delegated prefix. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists the global PublicDelegatedPrefixes for a project. | | `insert` | `INSERT` | `project` | Creates a global PublicDelegatedPrefix in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `project, publicDelegatedPrefix` | Deletes the specified global PublicDelegatedPrefix. | -| `_list` | `EXEC` | `project` | Lists the global PublicDelegatedPrefixes for a project. | | `patch` | `EXEC` | `project, publicDelegatedPrefix` | Patches the specified global PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | 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 24981919a8..de6b3a29e6 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` | | | `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `httpHealthCheck` | `object` | | -| `grpcHealthCheck` | `object` | | -| `httpsHealthCheck` | `object` | | -| `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. | | `logConfig` | `object` | Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. | -| `sslHealthCheck` | `object` | | -| `tcpHealthCheck` | `object` | | -| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | -| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | -| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | Type of the resource. | | `http2HealthCheck` | `object` | | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | -| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `tcpHealthCheck` | `object` | | +| `sslHealthCheck` | `object` | | +| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | +| `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. | +| `grpcHealthCheck` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,6 +53,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of HealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a HealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `healthCheck, project` | Deletes the specified HealthCheck resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of HealthCheck resources available to the specified project. | | `patch` | `EXEC` | `healthCheck, project` | Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `healthCheck, project` | Updates a HealthCheck resource in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/health_checks_aggregated/index.md b/docs/google-docs/providers/google/compute/health_checks_aggregated/index.md index 7042ed1046..8af5a0dda7 100644 --- a/docs/google-docs/providers/google/compute/health_checks_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/health_checks_aggregated/index.md @@ -25,8 +25,29 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | +| `kind` | `string` | Type of the resource. | +| `grpcHealthCheck` | `object` | | +| `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. | +| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | +| `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. | +| `httpsHealthCheck` | `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. | +| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `http2HealthCheck` | `object` | | +| `tcpHealthCheck` | `object` | | +| `sslHealthCheck` | `object` | | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 0eb2e6b707..86e5c3eb68 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. | -| `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. | -| `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. | | `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `port` | `integer` | The TCP port number for the HTTP health check request. The default value is 80. | | `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. | | `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,6 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of HttpHealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a HttpHealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `httpHealthCheck, project` | Deletes the specified HttpHealthCheck resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of HttpHealthCheck resources available to the specified project. | | `patch` | `EXEC` | `httpHealthCheck, project` | Updates a HttpHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `httpHealthCheck, project` | Updates a HttpHealthCheck resource in the specified project using the data included in the request. | 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 643cda2738..b1eb1ef841 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. | | `requestPath` | `string` | The request path of the HTTPS health check request. The default value is "/". Must comply with RFC3986. | -| `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. | -| `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 HTTPS health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used. | +| `port` | `integer` | The TCP port number for the HTTPS health check request. The default value is 443. | | `kind` | `string` | Type of 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. | +| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | | `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `port` | `integer` | The TCP port number for the HTTPS health check request. The default value is 443. | -| `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 | |:-----|:--------------|:----------------|:------------| @@ -47,6 +47,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of HttpsHealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a HttpsHealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `httpsHealthCheck, project` | Deletes the specified HttpsHealthCheck resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of HttpsHealthCheck resources available to the specified project. | | `patch` | `EXEC` | `httpsHealthCheck, project` | Updates a HttpsHealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `httpsHealthCheck, project` | Updates a HttpsHealthCheck resource in the specified project using the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/images/index.md b/docs/google-docs/providers/google/compute/images/index.md index 80ca7d3e59..df6877a4b6 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. | -| `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 | -| `labels` | `object` | Labels to apply to this image. These can be later modified by the setLabels method. | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `archiveSizeBytes` | `string` | Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). | -| `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. | -| `diskSizeGb` | `string` | Size of the image when restored onto a persistent disk (in GB). | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | -| `imageEncryptionKey` | `object` | | +| `sourceType` | `string` | The type of the image used to create this disk. The default and only valid value is RAW. | +| `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. | +| `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. | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this image. | +| `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 | | `deprecated` | `object` | Deprecation status for a public resource. | -| `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 | -| `rawDisk` | `object` | The parameters of the raw disk image. | +| `storageLocations` | `array` | Cloud Storage bucket storage location of the image (regional or multi-regional). | | `kind` | `string` | [Output Only] Type of the resource. Always compute#image for images. | -| `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. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | | `architecture` | `string` | The architecture of the image. Valid values are ARM64 or X86_64. | -| `sourceType` | `string` | The type of the image used to create this disk. The default and only valid value is RAW. | -| `licenses` | `array` | Any applicable license URI. | | `sourceImageEncryptionKey` | `object` | | -| `sourceSnapshotEncryptionKey` | `object` | | -| `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 | -| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this image. | +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `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. | +| `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 | +| `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 | | `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. | -| `storageLocations` | `array` | Cloud Storage bucket storage location of the image (regional or multi-regional). | +| `sourceSnapshotEncryptionKey` | `object` | | +| `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. | +| `labels` | `object` | Labels to apply to this image. These can be later modified by the setLabels method. | +| `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. | | `sourceDiskEncryptionKey` | `object` | | +| `rawDisk` | `object` | The parameters of the raw disk image. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `archiveSizeBytes` | `string` | Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). | +| `licenses` | `array` | Any applicable license URI. | +| `imageEncryptionKey` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -66,7 +66,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. | | `insert` | `INSERT` | `project` | Creates an image in the specified project using the data included in the request. | | `delete` | `DELETE` | `image, project` | Deletes the specified image. | -| `_list` | `EXEC` | `project` | Retrieves the list of custom images available to the specified project. Custom images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 8. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. | | `deprecate` | `EXEC` | `image, project` | Sets the deprecation status of an image. If an empty request body is given, clears the deprecation status instead. | | `patch` | `EXEC` | `image, project` | Patches the specified image with the data included in the request. Only the following fields can be modified: family, description, deprecation status. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on an image. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/images_from_family/index.md b/docs/google-docs/providers/google/compute/images_from_family/index.md index 6e303e98af..899e922dbd 100644 --- a/docs/google-docs/providers/google/compute/images_from_family/index.md +++ b/docs/google-docs/providers/google/compute/images_from_family/index.md @@ -25,8 +25,41 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `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. | +| `shieldedInstanceInitialState` | `object` | Initial State for shielded instance, these are public keys which are safe to store in public | +| `rawDisk` | `object` | The parameters of the raw disk image. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | +| `sourceImageEncryptionKey` | `object` | | +| `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. | +| `sourceSnapshotEncryptionKey` | `object` | | +| `diskSizeGb` | `string` | Size of the image when restored onto a persistent disk (in GB). | +| `storageLocations` | `array` | Cloud Storage bucket storage location of the image (regional or multi-regional). | +| `archiveSizeBytes` | `string` | Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). | +| `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 | +| `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. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `deprecated` | `object` | Deprecation status for a public resource. | +| `imageEncryptionKey` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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 | +| `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 | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#image for images. | +| `labels` | `object` | Labels to apply to this image. These can be later modified by the setLabels method. | +| `licenses` | `array` | Any applicable license URI. | +| `sourceType` | `string` | The type of the image used to create this disk. The default and only valid value is RAW. | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this image. | +| `architecture` | `string` | The architecture of the image. Valid values are ARM64 or X86_64. | +| `sourceDiskEncryptionKey` | `object` | | +| `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. | +| `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 | |:-----|:--------------|:----------------| -| `get_from_family` | `EXEC` | `family, project` | +| `get_from_family` | `SELECT` | `family, project` | diff --git a/docs/google-docs/providers/google/compute/index.md b/docs/google-docs/providers/google/compute/index.md index 16b9b1170a..608f6fad43 100644 --- a/docs/google-docs/providers/google/compute/index.md +++ b/docs/google-docs/providers/google/compute/index.md @@ -20,8 +20,8 @@ Creates And Runs Virtual Machines On Google Cloud Platform.
total resources: 188
-total selectable resources: 141
-total methods: 821
+total selectable resources: 153
+total methods: 775
@@ -33,7 +33,7 @@ Creates And Runs Virtual Machines On Google Cloud Platform. TypeService TitleCompute Engine API DescriptionCreates And Runs Virtual Machines On Google Cloud Platform. -Idcompute:v23.08.00161 +Idcompute:v23.08.00163 ## Resources 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 176c265b39..28a804dc36 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,37 +30,37 @@ 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. | -| `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. | +| `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` | | -| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | +| `statefulPolicy` | `object` | | +| `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. | +| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | | `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | -| `updatePolicy` | `object` | | -| `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | -| `currentActions` | `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. | -| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | -| `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | -| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | -| `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. | -| `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | | `distributionPolicy` | `object` | | | `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. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | +| `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. | | `status` | `object` | | -| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | -| `statefulPolicy` | `object` | | +| `currentActions` | `object` | | +| `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | | `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. | -| `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. | +| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | +| `updatePolicy` | `object` | | +| `region` | `string` | [Output Only] The URL of the region where the managed instance group resides (for regional resources). | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | +| `namedPorts` | `array` | Named ports configured for the Instance Groups complementary to this Instance Group Manager. | +| `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. | +| `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves the list of managed instance groups and groups them by zone. | | `get` | `SELECT` | `instanceGroupManager, project, zone` | Returns all of the details about the specified managed instance group. | | `list` | `SELECT` | `project, zone` | Retrieves a list of managed instance groups that are contained within the specified project and zone. | | `insert` | `INSERT` | `project, zone` | Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A managed instance group can have up to 1000 VM instances per group. Please contact Cloud Support if you need an increase in this limit. | | `delete` | `DELETE` | `instanceGroupManager, project, zone` | Deletes the specified managed instance group and all of the instances in that group. Note that the instance group must not belong to a backend service. Read Deleting an instance group for more information. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of managed instance groups that are contained within the specified project and zone. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves the list of managed instance groups and groups them by zone. | | `abandon_instances` | `EXEC` | `instanceGroupManager, project, zone` | Flags the specified instances to be removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. | -| `aggregated_list` | `EXEC` | `project` | Retrieves the list of managed instance groups and groups them by zone. | | `apply_updates_to_instances` | `EXEC` | `instanceGroupManager, project, zone` | Applies changes to selected instances on the managed instance group. This method can be used to apply new overrides and/or new versions. | | `patch` | `EXEC` | `instanceGroupManager, project, zone` | Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listManagedInstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. | | `patch_per_instance_configs` | `EXEC` | `instanceGroupManager, project, zone` | Inserts or patches per-instance configurations for the managed instance group. perInstanceConfig.name serves as a key used to distinguish whether to perform insert or patch. | 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 417bf734bf..2b175cba0d 100644 --- a/docs/google-docs/providers/google/compute/instance_groups/index.md +++ b/docs/google-docs/providers/google/compute/instance_groups/index.md @@ -30,23 +30,23 @@ 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. | +| `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. | +| `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). | | `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). | | `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroup for instance groups. | -| `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). | -| `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. | -| `size` | `integer` | [Output Only] The total number of instances in the 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. | | `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance group in RFC3339 text format. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves the list of instance groups and sorts them by zone. | | `get` | `SELECT` | `instanceGroup, project, zone` | Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. | | `list` | `SELECT` | `project, zone` | Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. | | `insert` | `INSERT` | `project, zone` | Creates an instance group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `instanceGroup, project, zone` | Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information. | -| `_list` | `EXEC` | `project, zone` | Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead. | -| `aggregated_list` | `EXEC` | `project` | Retrieves the list of instance groups and sorts them by zone. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves the list of instance groups and sorts them by zone. | | `set_named_ports` | `EXEC` | `instanceGroup, project, zone` | Sets the named ports for the specified instance group. | 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 f5cc7806b3..39d9dba463 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. | -| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | -| `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. | +| `properties` | `object` | | +| `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. | | `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. | -| `properties` | `object` | | +| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. | +| `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 | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of instance templates that are contained within the specified project. | | `insert` | `INSERT` | `project` | Creates an instance template in the specified project using the data that is included in the request. If you are creating a new template to update an existing instance group, your new instance template must use the same network or, if applicable, the same subnetwork as the original template. | | `delete` | `DELETE` | `instanceTemplate, project` | Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. It is not possible to delete templates that are already in use by a managed instance group. | -| `_list` | `EXEC` | `project` | Retrieves a list of instance templates that are contained within the specified project. | diff --git a/docs/google-docs/providers/google/compute/instance_templates_aggregated/index.md b/docs/google-docs/providers/google/compute/instance_templates_aggregated/index.md index 57889d24eb..2e4eaa3330 100644 --- a/docs/google-docs/providers/google/compute/instance_templates_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/instance_templates_aggregated/index.md @@ -25,8 +25,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | +| `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 | +| `properties` | `object` | | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | diff --git a/docs/google-docs/providers/google/compute/instances/index.md b/docs/google-docs/providers/google/compute/instances/index.md index f58be8bd47..c65e0e4805 100644 --- a/docs/google-docs/providers/google/compute/instances/index.md +++ b/docs/google-docs/providers/google/compute/instances/index.md @@ -30,57 +30,57 @@ 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. | -| `deletionProtection` | `boolean` | Whether the resource should be protected against deletion. | -| `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. | -| `cpuPlatform` | `string` | [Output Only] The CPU platform used by this instance. | -| `scheduling` | `object` | Sets the scheduling options for an 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. | -| `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. | -| `labels` | `object` | Labels to apply to this instance. These can be later modified by the setLabels method. | +| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | +| `displayDevice` | `object` | A set of Display Device options | +| `confidentialInstanceConfig` | `object` | A set of Confidential Instance options. | +| `params` | `object` | Additional instance params. | +| `reservationAffinity` | `object` | Specifies the reservations that this instance can consume from. | +| `keyRevocationActionType` | `string` | KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. | +| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | +| `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 . | | `shieldedInstanceIntegrityPolicy` | `object` | The policy describes the baseline against which Instance boot integrity is measured. | -| `lastSuspendedTimestamp` | `string` | [Output Only] Last suspended timestamp in RFC3339 text format. | +| `startRestricted` | `boolean` | [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. | +| `networkPerformanceConfig` | `object` | | | `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. | +| `sourceMachineImageEncryptionKey` | `object` | | +| `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. | | `disks` | `array` | Array of disks associated with this instance. Persistent disks must be created before you can assign them. | -| `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". | -| `networkPerformanceConfig` | `object` | | | `selfLink` | `string` | [Output Only] Server-defined URL for this resource. | -| `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). | -| `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. | | `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. | +| `scheduling` | `object` | Sets the scheduling options for an Instance. | +| `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". | +| `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. | | `guestAccelerators` | `array` | A list of the type and count of accelerator cards attached to the instance. | -| `sourceMachineImage` | `string` | Source machine image | -| `lastStopTimestamp` | `string` | [Output Only] Last stop timestamp in RFC3339 text format. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `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. | -| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | -| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `instanceEncryptionKey` | `object` | | -| `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. | -| `lastStartTimestamp` | `string` | [Output Only] Last start timestamp in RFC3339 text format. | -| `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. | -| `displayDevice` | `object` | A set of Display Device options | +| `deletionProtection` | `boolean` | Whether the resource should be protected against deletion. | | `tags` | `object` | A set of instance tags. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `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. | +| `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. | +| `lastSuspendedTimestamp` | `string` | [Output Only] Last suspended timestamp in RFC3339 text format. | | `resourcePolicies` | `array` | Resource policies applied to this instance. | -| `metadata` | `object` | A metadata key/value entry. | +| `lastStartTimestamp` | `string` | [Output Only] Last start timestamp in RFC3339 text format. | +| `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. | +| `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. | | `privateIpv6GoogleAccess` | `string` | The private IPv6 google access type for the VM. If not specified, use INHERIT_FROM_SUBNETWORK as default. | -| `startRestricted` | `boolean` | [Output Only] Whether a VM has been restricted for start because Compute Engine has detected suspicious activity. | +| `sourceMachineImage` | `string` | Source machine image | +| `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). | +| `instanceEncryptionKey` | `object` | | | `kind` | `string` | [Output Only] Type of the resource. Always compute#instance for instances. | -| `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 . | -| `reservationAffinity` | `object` | Specifies the reservations that this instance can consume from. | -| `confidentialInstanceConfig` | `object` | A set of Confidential Instance options. | -| `sourceMachineImageEncryptionKey` | `object` | | -| `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. | +| `lastStopTimestamp` | `string` | [Output Only] Last stop timestamp in RFC3339 text format. | +| `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. | +| `metadata` | `object` | A metadata key/value entry. | +| `cpuPlatform` | `string` | [Output Only] The CPU platform used by this instance. | +| `labels` | `object` | Labels to apply to this instance. These can be later modified by the setLabels method. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. | | `get` | `SELECT` | `instance, project, zone` | Returns the specified Instance resource. | | `list` | `SELECT` | `project, zone` | Retrieves the list of instances contained within the specified zone. | | `insert` | `INSERT` | `project, zone` | Creates an instance resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `instance, project, zone` | Deletes the specified Instance resource. For more information, see Deleting an instance. | -| `_list` | `EXEC` | `project, zone` | Retrieves the list of instances contained within the specified zone. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of all of the instances in your project across all regions and zones. The performance of this method degrades when a filter is specified on a project that has a very large number of instances. | | `attach_disk` | `EXEC` | `instance, project, zone` | Attaches an existing Disk resource to an instance. You must first create the disk before you can attach it. It is not possible to create and attach a disk at the same time. For more information, read Adding a persistent disk to your instance. | | `bulk_insert` | `EXEC` | `project, zone` | Creates multiple instances. Count specifies the number of instances to create. For more information, see About bulk creation of VMs. | | `detach_disk` | `EXEC` | `deviceName, instance, project, zone` | Detaches a disk from an instance. | 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 97e524d25e..20be864a74 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 | |:-----|:---------|:------------| -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 bf801058f0..dfaa3e205b 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/instances_referrers/index.md b/docs/google-docs/providers/google/compute/instances_referrers/index.md index 67eb1c1660..98ac90a563 100644 --- a/docs/google-docs/providers/google/compute/instances_referrers/index.md +++ b/docs/google-docs/providers/google/compute/instances_referrers/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `referenceType` | `string` | A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF | | `referrer` | `string` | URL of the resource which refers to the target. | | `target` | `string` | URL of the resource to which this reference points. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#reference for references. | +| `referenceType` | `string` | A description of the reference type with no implied semantics. Possible values include: 1. MEMBER_OF | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 fb1adfe291..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 | |:-----|:---------|:------------| -| `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. | | `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 1bd4de517c..ec63c0dc61 100644 --- a/docs/google-docs/providers/google/compute/interconnect_attachments/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_attachments/index.md @@ -30,51 +30,51 @@ 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. | +| `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. | +| `privateInterconnectInfo` | `object` | Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. | +| `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. | +| `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. | +| `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. | +| `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. | | `vlanTag8021q` | `integer` | The IEEE 802.1Q VLAN tag for this attachment, in the range 2-4093. Only specified at creation time. | -| `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. | +| `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. | +| `cloudRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `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. | | `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. | +| `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. | +| `cloudRouterIpv6InterfaceId` | `string` | This field is not available. | +| `cloudRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | +| `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. | | `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. | -| `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. | -| `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. | -| `customerRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | -| `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. | -| `customerRouterIpv6InterfaceId` | `string` | This field is not available. | +| `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. | | `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. | -| `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. | -| `privateInterconnectInfo` | `object` | Information for an interconnect attachment when this belongs to an interconnect of type DEDICATED. | +| `pairingKey` | `string` | [Output only for type PARTNER. Input only for PARTNER_PROVIDER. Not present for DEDICATED]. The opaque identifier of a PARTNER attachment used to initiate provisioning with a selected partner. Of the form "XXXXX/region/domain" | | `configurationConstraints` | `object` | | -| `candidateIpv6Subnets` | `array` | This field is not available. | +| `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. | +| `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 | +| `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. | +| `adminEnabled` | `boolean` | Determines whether this Attachment will carry packets. Not present for PARTNER_PROVIDER. | +| `customerRouterIpv6InterfaceId` | `string` | This field is not available. | +| `interconnect` | `string` | URL of the underlying Interconnect object that this attachment's traffic will traverse through. | +| `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. | | `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `cloudRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | -| `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. | +| `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. | +| `customerRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | +| `customerRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectAttachment for interconnect attachments. | -| `cloudRouterIpv6InterfaceId` | `string` | This field is not available. | -| `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. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | -| `interconnect` | `string` | URL of the underlying Interconnect object that this attachment's traffic will traverse through. | -| `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. | -| `customerRouterIpv6Address` | `string` | [Output Only] IPv6 address + prefix length to be configured on the customer router subinterface for this interconnect attachment. | -| `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. | -| `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. | -| `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 | -| `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. | -| `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. | -| `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. | -| `cloudRouterIpAddress` | `string` | [Output Only] IPv4 address + prefix length to be configured on Cloud Router Interface for this interconnect attachment. | -| `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" | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of interconnect attachments. | | `get` | `SELECT` | `interconnectAttachment, project, region` | Returns the specified interconnect attachment. | | `list` | `SELECT` | `project, region` | Retrieves the list of interconnect attachments contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates an InterconnectAttachment in the specified project using the data included in the request. | | `delete` | `DELETE` | `interconnectAttachment, project, region` | Deletes the specified interconnect attachment. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of interconnect attachments contained within the specified region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of interconnect attachments. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of interconnect attachments. | | `patch` | `EXEC` | `interconnectAttachment, project, region` | Updates the specified interconnect attachment with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on an InterconnectAttachment. To learn more about labels, read the Labeling Resources documentation. | 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 97534cdcf1..4505e6d3e0 100644 --- a/docs/google-docs/providers/google/compute/interconnect_locations/index.md +++ b/docs/google-docs/providers/google/compute/interconnect_locations/index.md @@ -30,22 +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` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of the resource. | -| `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. | +| `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). | +| `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | +| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | | `city` | `string` | [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". | -| `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. | -| `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". | -| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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". | +| `address` | `string` | [Output Only] The postal address of the Point of Presence, each line in the address is separated by a newline character. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnectLocation for interconnect locations. | +| `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). | | `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `interconnectLocation, project` | Returns the details for the specified interconnect location. Gets a list of available interconnect locations by making a list() request. | | `list` | `SELECT` | `project` | Retrieves the list of interconnect locations available to the specified project. | -| `_list` | `EXEC` | `project` | Retrieves the list of interconnect locations available to the specified project. | 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 7611021e70..9021cff4e1 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,26 +30,25 @@ 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. | -| `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). | | `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". | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `facilityProvider` | `string` | [Output Only] The name of the provider for this facility (e.g., EQUINIX). | -| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | +| `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. | | `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. | -| `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. | +| `permittedConnections` | `array` | [Output Only] Permitted connections. | | `constraints` | `object` | | +| `facilityProviderFacilityId` | `string` | [Output Only] A provider-assigned Identifier for this facility (e.g., Ashburn-DC1). | +| `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). | | `continent` | `string` | [Output Only] Continent for this location, which can take one of the following values: - AFRICA - ASIA_PAC - EUROPE - NORTH_AMERICA - SOUTH_AMERICA | -| `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. | -| `attachmentConfigurationConstraints` | `object` | | +| `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#interconnectRemoteLocation for interconnect remote locations. | +| `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. | +| `remoteService` | `string` | [Output Only] Indicates the service provider present at the remote location. Example values: "Amazon Web Services", "Microsoft Azure". | +| `attachmentConfigurationConstraints` | `object` | | +| `peeringdbFacilityId` | `string` | [Output Only] The peeringdb identifier for this facility (corresponding with a netfac type in peeringdb). | +| `lacp` | `string` | [Output Only] Link Aggregation Control Protocol (LACP) constraints, which can take one of the following values: LACP_SUPPORTED, LACP_UNSUPPORTED | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `interconnectRemoteLocation, project` | Returns the details for the specified interconnect remote location. Gets a list of available interconnect remote locations by making a list() request. | | `list` | `SELECT` | `project` | Retrieves the list of interconnect remote locations available to the specified project. | -| `_list` | `EXEC` | `project` | Retrieves the list of interconnect remote locations available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/interconnects/index.md b/docs/google-docs/providers/google/compute/interconnects/index.md index 79190beb3b..6a28de4a0f 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. | +| `location` | `string` | URL of the InterconnectLocation object that represents where this connection is to be provisioned. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `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. | | `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. | | `expectedOutages` | `array` | [Output Only] A list of outages expected for this Interconnect. | -| `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for 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. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `customerName` | `string` | Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. | +| `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. | | `interconnectAttachments` | `array` | [Output Only] A list of the URLs of all InterconnectAttachments configured to use this Interconnect. | -| `googleReferenceId` | `string` | [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. | -| `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. | -| `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. | -| `location` | `string` | URL of the InterconnectLocation object that represents where this connection is to be provisioned. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `customerName` | `string` | Customer name, to put in the Letter of Authorization as the party authorized to request a crossconnect. | +| `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. | +| `googleIpAddress` | `string` | [Output Only] IP address configured on the Google side of the Interconnect link. This can be used only for ping tests. | +| `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. | | `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. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | -| `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. | +| `googleReferenceId` | `string` | [Output Only] Google reference ID to be used when raising support tickets with Google or otherwise to debug backend connectivity issues. | +| `provisionedLinkCount` | `integer` | [Output Only] Number of links actually provisioned in this interconnect. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#interconnect for interconnects. | -| `circuitInfos` | `array` | [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. | | `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. | +| `circuitInfos` | `array` | [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. | | `requestedLinkCount` | `integer` | Target number of physical links in the link bundle, as requested by the customer. | -| `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 | |:-----|:--------------|:----------------|:------------| @@ -60,6 +60,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of Interconnects available to the specified project. | | `insert` | `INSERT` | `project` | Creates an Interconnect in the specified project using the data included in the request. | | `delete` | `DELETE` | `interconnect, project` | Deletes the specified Interconnect. | -| `_list` | `EXEC` | `project` | Retrieves the list of Interconnects available to the specified project. | | `patch` | `EXEC` | `interconnect, project` | Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. | 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 b2c0c0c81e..e904510d1f 100644 --- a/docs/google-docs/providers/google/compute/license_codes/index.md +++ b/docs/google-docs/providers/google/compute/license_codes/index.md @@ -31,11 +31,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `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. | | `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of resource. Always compute#licenseCode for licenses. | +| `state` | `string` | [Output Only] Current state of this 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. | -| `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 306cc65c18..2c9b417968 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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `resourceRequirements` | `object` | | -| `kind` | `string` | [Output Only] Type of resource. Always compute#license for licenses. | -| `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. | | `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. | +| `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. | | `licenseCode` | `string` | [Output Only] The unique code used to attach this license to images, snapshots, and disks. | +| `resourceRequirements` | `object` | | +| `kind` | `string` | [Output Only] Type of resource. Always compute#license for licenses. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | | `insert` | `INSERT` | `project` | Create a License resource in the specified project. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | | `delete` | `DELETE` | `license, project` | Deletes the specified license. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | -| `_list` | `EXEC` | `project` | Retrieves the list of licenses available in the specified project. This method does not get any licenses that belong to other projects, including licenses attached to publicly-available images, like Debian 9. If you want to get a list of publicly-available licenses, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. | diff --git a/docs/google-docs/providers/google/compute/licenses_iam_policies/index.md b/docs/google-docs/providers/google/compute/licenses_iam_policies/index.md index e5cff8e877..c17f012c89 100644 --- a/docs/google-docs/providers/google/compute/licenses_iam_policies/index.md +++ b/docs/google-docs/providers/google/compute/licenses_iam_policies/index.md @@ -27,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 4f15572a8a..59790c5bde 100644 --- a/docs/google-docs/providers/google/compute/machine_images/index.md +++ b/docs/google-docs/providers/google/compute/machine_images/index.md @@ -31,19 +31,19 @@ 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] The URL for this machine image. The server defines this URL. | -| `storageLocations` | `array` | The regional or multi-regional Cloud Storage bucket location where the machine image is stored. | -| `kind` | `string` | [Output Only] The resource type, which is always compute#machineImage for machine image. | +| `machineImageEncryptionKey` | `object` | | | `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 | -| `totalStorageBytes` | `string` | [Output Only] Total size of the storage used by the machine image. | -| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this machine image in RFC3339 text format. | -| `instanceProperties` | `object` | | +| `kind` | `string` | [Output Only] The resource type, which is always compute#machineImage for machine image. | | `guestFlush` | `boolean` | [Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process. | -| `savedDisks` | `array` | An array of Machine Image specific properties for disks attached to the source instance | +| `status` | `string` | [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. | | `sourceInstanceProperties` | `object` | DEPRECATED: Please use compute#instanceProperties instead. New properties will not be added to this field. | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this machine image in RFC3339 text format. | +| `instanceProperties` | `object` | | | `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. | -| `machineImageEncryptionKey` | `object` | | -| `status` | `string` | [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. | +| `storageLocations` | `array` | The regional or multi-regional Cloud Storage bucket location where the machine image is stored. | +| `savedDisks` | `array` | An array of Machine Image specific properties for disks attached to the source instance | | `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `totalStorageBytes` | `string` | [Output Only] Total size of the storage used by the machine image. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -51,4 +51,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves a list of machine images that are contained within the specified project. | | `insert` | `INSERT` | `project` | Creates a machine image in the specified project using the data that is included in the request. If you are creating a new machine image to update an existing instance, your new machine image should use the same network or, if applicable, the same subnetwork as the original instance. | | `delete` | `DELETE` | `machineImage, project` | Deletes the specified machine image. Deleting a machine image is permanent and cannot be undone. | -| `_list` | `EXEC` | `project` | Retrieves a list of machine images that are contained within the specified project. | 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 e6a18aceab..4f5808ab93 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 1da1d911dc..ec3c58543e 100644 --- a/docs/google-docs/providers/google/compute/machine_types/index.md +++ b/docs/google-docs/providers/google/compute/machine_types/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 textual description of the resource. | -| `imageSpaceGb` | `integer` | [Deprecated] This property is deprecated and will never be populated with any relevant values. | +| `accelerators` | `array` | [Output Only] A list of accelerator configurations assigned to this machine type. | +| `kind` | `string` | [Output Only] The type of the resource. Always compute#machineType for machine types. | | `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. | -| `zone` | `string` | [Output Only] The name of the zone where the machine type resides, such as us-central1-a. | -| `maximumPersistentDisks` | `integer` | [Output Only] Maximum persistent disks allowed. | -| `scratchDisks` | `array` | [Output Only] A list of extended scratch disks assigned to the instance. | | `maximumPersistentDisksSizeGb` | `string` | [Output Only] Maximum total persistent disks size (GB) allowed. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `accelerators` | `array` | [Output Only] A list of accelerator configurations assigned to this machine type. | | `isSharedCpu` | `boolean` | [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information. | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#machineType for machine types. | -| `deprecated` | `object` | Deprecation status for a public resource. | +| `imageSpaceGb` | `integer` | [Deprecated] This property is deprecated and will never be populated with any relevant values. | +| `scratchDisks` | `array` | [Output Only] A list of extended scratch disks assigned to the instance. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `maximumPersistentDisks` | `integer` | [Output Only] Maximum persistent disks allowed. | +| `zone` | `string` | [Output Only] The name of the zone where the machine type resides, such as us-central1-a. | +| `deprecated` | `object` | Deprecation status for a public resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the instance, defined in MB. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of machine types. | | `get` | `SELECT` | `machineType, project, zone` | Returns the specified machine type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of machine types available to the specified project. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of machine types available to the specified project. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of machine types. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of machine types. | 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 13d07d3017..a72caf9995 100644 --- a/docs/google-docs/providers/google/compute/network_attachments/index.md +++ b/docs/google-docs/providers/google/compute/network_attachments/index.md @@ -30,24 +30,24 @@ 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. | -| `producerAcceptLists` | `array` | Projects that are allowed to connect to this network attachment. The project can be specified using its id or number. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource's resource id. | +| `producerRejectLists` | `array` | Projects that are not 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. | +| `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | +| `producerAcceptLists` | `array` | Projects that are allowed to connect to this network attachment. The project can be specified using its id or number. | | `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. | | `connectionPreference` | `string` | | -| `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. | -| `producerRejectLists` | `array` | Projects that are not allowed to connect to this network attachment. The project can be specified using its id or number. | -| `connectionEndpoints` | `array` | [Output Only] An array of connections for all the producers connected to this network attachment. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource's resource id. | | `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. | | `get` | `SELECT` | `networkAttachment, project, region` | Returns the specified NetworkAttachment resource in the given scope. | | `list` | `SELECT` | `project, region` | Lists the NetworkAttachments for a project in the given scope. | | `insert` | `INSERT` | `project, region` | Creates a NetworkAttachment in the specified project in the given scope using the parameters that are included in the request. | | `delete` | `DELETE` | `networkAttachment, project, region` | Deletes the specified NetworkAttachment in the given scope | -| `_list` | `EXEC` | `project, region` | Lists the NetworkAttachments for a project in the given scope. | -| `aggregated_list` | `EXEC` | `project` | Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves the list of all NetworkAttachment resources, regional and global, available to the specified project. | 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 c9be6c39c0..585b281198 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 de49abbad6..51ed35bd7b 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 @@ -31,17 +31,18 @@ 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. | | `kind` | `string` | [Output only] Type of the resource. Always compute#networkEdgeSecurityService for NetworkEdgeSecurityServices | -| `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 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. | -| `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. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | | `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `securityPolicy` | `string` | The resource URL for the network edge security service associated with this network edge security service. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. | | `get` | `SELECT` | `networkEdgeSecurityService, project, region` | Gets a specified NetworkEdgeSecurityService. | | `insert` | `INSERT` | `project, region` | Creates a new service in the specified project using the data included in the request. | | `delete` | `DELETE` | `networkEdgeSecurityService, project, region` | Deletes the specified service. | -| `aggregated_list` | `EXEC` | `project` | Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves the list of all NetworkEdgeSecurityService resources available to the specified project. | | `patch` | `EXEC` | `networkEdgeSecurityService, project, region` | Patches the specified policy with the data included in the request. | 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 d28b00734a..9d8d9dc41a 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,30 +30,30 @@ 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. | -| `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | +| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `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" | +| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | +| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | | `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | -| `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. | +| `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. | +| `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | -| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | -| `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" | -| `size` | `integer` | [Output only] Number of network endpoints in the network endpoint group. | | `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. | | `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type 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. | | `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. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves the list of network endpoint groups and sorts them by zone. | | `get` | `SELECT` | `networkEndpointGroup, project, zone` | Returns the specified network endpoint group. | | `list` | `SELECT` | `project, zone` | Retrieves the list of network endpoint groups that are located in the specified project and zone. | | `insert` | `INSERT` | `project, zone` | Creates a network endpoint group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `networkEndpointGroup, project, zone` | Deletes the specified network endpoint group. The network endpoints in the NEG and the VM instances they belong to are not terminated when the NEG is deleted. Note that the NEG cannot be deleted if there are backend services referencing it. | -| `_list` | `EXEC` | `project, zone` | Retrieves the list of network endpoint groups that are located in the specified project and zone. | -| `aggregated_list` | `EXEC` | `project` | Retrieves the list of network endpoint groups and sorts them by zone. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves the list of network endpoint groups and sorts them by zone. | | `attach_network_endpoints` | `EXEC` | `networkEndpointGroup, project, zone` | Attach a list of network endpoints to the specified network endpoint group. | | `detach_network_endpoints` | `EXEC` | `networkEndpointGroup, project, zone` | Detach a list of network endpoints from the specified network endpoint group. | 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 ee48ea8855..eeb10da231 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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | -| `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. | -| `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. | -| `associations` | `array` | A list of associations that belong to this firewall policy. | | `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. | | `ruleTupleCount` | `integer` | [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. | -| `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. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | | `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. | -| `parent` | `string` | [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies | +| `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. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,7 +49,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists all the policies that have been configured for the specified project. | | `insert` | `INSERT` | `project` | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `firewallPolicy, project` | Deletes the specified policy. | -| `_list` | `EXEC` | `project` | Lists all the policies that have been configured for the specified project. | | `clone_rules` | `EXEC` | `firewallPolicy, project` | Copies rules to the specified firewall policy. | | `patch` | `EXEC` | `firewallPolicy, project` | Patches the specified policy with the data included in the request. | | `patch_rule` | `EXEC` | `firewallPolicy, project` | Patches a rule of the specified priority. | 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..7ac75493ee 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. | +| `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/network_firewall_policies_iam_policies/index.md b/docs/google-docs/providers/google/compute/network_firewall_policies_iam_policies/index.md index 963af53dc4..e972ee69de 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 e16e5b682b..6a9239e3bb 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. | -| `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. | -| `direction` | `string` | The direction in which this rule applies. | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules | -| `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. | -| `targetServiceAccounts` | `array` | A list of service accounts indicating the sets of instances that are applied with this rule. | +| `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. | -| `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. | +| `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. | | `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | +| `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. | +| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | | `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. | ## 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 ddb917a3bf..9c8f249edf 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. | -| `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. . | -| `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. | | `selfLinkWithId` | `string` | [Output Only] Server-defined URL for this resource with the resource id. | -| `subnetworks` | `array` | [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. | | `gatewayIPv4` | `string` | [Output Only] The gateway address for default routing out of the network, selected by Google Cloud. | -| `enableUlaInternalIpv6` | `boolean` | Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. . | -| `peerings` | `array` | [Output Only] A list of network peerings for the resource. | | `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. | -| `firewallPolicy` | `string` | [Output Only] URL of the firewall policy the network is associated with. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#network for networks. | | `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. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `peerings` | `array` | [Output Only] A list of network peerings for the resource. | +| `subnetworks` | `array` | [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `firewallPolicy` | `string` | [Output Only] URL of the firewall policy the network is associated with. | +| `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. | | `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. | +| `enableUlaInternalIpv6` | `boolean` | Enable ULA internal ipv6 on this network. Enabling this feature will assign a /48 from google defined ULA prefix fd20::/20. . | +| `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. . | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#network for networks. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -52,6 +52,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of networks available to the specified project. | | `insert` | `INSERT` | `project` | Creates a network in the specified project using the data included in the request. | | `delete` | `DELETE` | `network, project` | Deletes the specified network. | -| `_list` | `EXEC` | `project` | Retrieves the list of networks available to the specified project. | | `patch` | `EXEC` | `network, project` | Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. | | `switch_to_custom_mode` | `EXEC` | `network, project` | Switches the network mode from auto subnet mode to custom subnet mode. | 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/node_groups/index.md b/docs/google-docs/providers/google/compute/node_groups/index.md index 0555380a2c..55d2e0fedd 100644 --- a/docs/google-docs/providers/google/compute/node_groups/index.md +++ b/docs/google-docs/providers/google/compute/node_groups/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 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. | -| `autoscalingPolicy` | `object` | | -| `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeGroup for node group. | -| `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. | -| `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `zone` | `string` | [Output Only] The name of the zone where the node group resides, such as us-central1-a. | -| `maintenanceWindow` | `object` | Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. | -| `size` | `integer` | [Output Only] The total number of nodes in the node group. | | `fingerprint` | `string` | | +| `status` | `string` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `nodeTemplate` | `string` | URL of the node template to create the node group from. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `size` | `integer` | [Output Only] The total number of nodes in the node group. | +| `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. | | `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. | -| `status` | `string` | | +| `autoscalingPolicy` | `object` | | +| `zone` | `string` | [Output Only] The name of the zone where the node group resides, such as us-central1-a. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `maintenanceWindow` | `object` | Time window specified for daily maintenance operations. GCE's internal maintenance will be performed within this window. | +| `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 | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. | | `get` | `SELECT` | `nodeGroup, project, zone` | Returns the specified NodeGroup. Get a list of available NodeGroups by making a list() request. Note: the "nodes" field should not be used. Use nodeGroups.listNodes instead. | | `list` | `SELECT` | `project, zone` | Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. | | `insert` | `INSERT` | `initialNodeCount, project, zone` | Creates a NodeGroup resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `nodeGroup, project, zone` | Deletes the specified NodeGroup resource. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of node groups available to the specified project. Note: use nodeGroups.listNodes for more details about each group. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group. | | `patch` | `EXEC` | `nodeGroup, project, zone` | Updates the specified node group. | | `set_node_template` | `EXEC` | `nodeGroup, project, zone` | Updates the node template of the node group. | | `simulate_maintenance_event` | `EXEC` | `nodeGroup, project, zone` | Simulates maintenance event on specified nodes from the node group. | 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 d2459dd7b6..da90612de2 100644 --- a/docs/google-docs/providers/google/compute/node_templates/index.md +++ b/docs/google-docs/providers/google/compute/node_templates/index.md @@ -30,25 +30,25 @@ 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. | -| `nodeTypeFlexibility` | `object` | | -| `accelerators` | `array` | | -| `cpuOvercommitType` | `string` | CPU overcommit. | -| `nodeAffinityLabels` | `object` | Labels to use for node affinity, which will be used in instance scheduling. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `status` | `string` | [Output Only] The status of the node template. One of the following values: CREATING, READY, and DELETING. | +| `nodeType` | `string` | The node type to use for nodes group that are created from this template. | +| `region` | `string` | [Output Only] The name of the region where the node template resides, such as us-central1. | | `serverBinding` | `object` | | +| `nodeAffinityLabels` | `object` | Labels to use for node affinity, which will be used in instance scheduling. | +| `cpuOvercommitType` | `string` | CPU overcommit. | +| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | | `kind` | `string` | [Output Only] The type of the resource. Always compute#nodeTemplate for node templates. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | -| `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | +| `nodeTypeFlexibility` | `object` | | | `disks` | `array` | | -| `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. | +| `accelerators` | `array` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of node templates. | | `get` | `SELECT` | `nodeTemplate, project, region` | Returns the specified node template. | | `list` | `SELECT` | `project, region` | Retrieves a list of node templates available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a NodeTemplate resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `nodeTemplate, project, region` | Deletes the specified NodeTemplate resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of node templates available to the specified project. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node templates. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node templates. | 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 b26271355d..a507cadc3b 100644 --- a/docs/google-docs/providers/google/compute/node_types/index.md +++ b/docs/google-docs/providers/google/compute/node_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#nodeType for node types. | | `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | | `localSsdGb` | `integer` | [Output Only] Local SSD available to the node type, defined in GB. | | `memoryMb` | `integer` | [Output Only] The amount of physical memory available to the node type, defined in MB. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `guestCpus` | `integer` | [Output Only] The number of virtual CPUs that are available to the node type. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of node types. | | `get` | `SELECT` | `nodeType, project, zone` | Returns the specified node type. | | `list` | `SELECT` | `project, zone` | Retrieves a list of node types available to the specified project. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of node types available to the specified project. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node types. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of node types. | 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 8b3a29bfdf..102c972b4d 100644 --- a/docs/google-docs/providers/google/compute/packet_mirrorings/index.md +++ b/docs/google-docs/providers/google/compute/packet_mirrorings/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. | -| `region` | `string` | [Output Only] URI of the region where the packetMirroring resides. | -| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#packetMirroring for packet mirrorings. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `filter` | `object` | | -| `mirroredResources` | `object` | | | `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `collectorIlb` | `object` | | +| `region` | `string` | [Output Only] URI of the region where the packetMirroring resides. | +| `filter` | `object` | | | `network` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `collectorIlb` | `object` | | +| `mirroredResources` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of packetMirrorings. | | `get` | `SELECT` | `packetMirroring, project, region` | Returns the specified PacketMirroring resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of PacketMirroring resources available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a PacketMirroring resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `packetMirroring, project, region` | Deletes the specified PacketMirroring resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of PacketMirroring resources available to the specified project and region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of packetMirrorings. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of packetMirrorings. | | `patch` | `EXEC` | `packetMirroring, project, region` | Patches the specified PacketMirroring resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | diff --git a/docs/google-docs/providers/google/compute/projects/index.md b/docs/google-docs/providers/google/compute/projects/index.md index ff5003d7f2..3f9b4871ff 100644 --- a/docs/google-docs/providers/google/compute/projects/index.md +++ b/docs/google-docs/providers/google/compute/projects/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. 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. | -| `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. | -| `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. | -| `quotas` | `array` | [Output Only] Quotas assigned to 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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | -| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | -| `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. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `commonInstanceMetadata` | `object` | A metadata key/value entry. | +| `quotas` | `array` | [Output Only] Quotas assigned to this project. | +| `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. | +| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 493bc1ebbc..23763ce30c 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. | -| `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. | -| `dnsVerificationIp` | `string` | The address to be used for reverse DNS verification. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `ipCidrRange` | `string` | The address range, in CIDR format, represented by this public advertised prefix. | -| `sharedSecret` | `string` | [Output Only] The shared secret to be used for reverse DNS verification. | | `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. | | `publicDelegatedPrefixs` | `array` | [Output Only] The list of public delegated prefixes that exist for this public advertised prefix. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `ipCidrRange` | `string` | The address range, in CIDR format, represented by this public advertised prefix. | +| `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. | +| `sharedSecret` | `string` | [Output Only] The shared secret to be used for reverse DNS verification. | +| `dnsVerificationIp` | `string` | The address to be used for reverse DNS verification. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicAdvertisedPrefix for public advertised prefixes. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -46,5 +46,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists the PublicAdvertisedPrefixes for a project. | | `insert` | `INSERT` | `project` | Creates a PublicAdvertisedPrefix in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `project, publicAdvertisedPrefix` | Deletes the specified PublicAdvertisedPrefix | -| `_list` | `EXEC` | `project` | Lists the PublicAdvertisedPrefixes for a project. | | `patch` | `EXEC` | `project, publicAdvertisedPrefix` | Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | 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 0a732aad78..fb9e9de3c5 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 @@ -31,22 +31,22 @@ 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. | | `isLiveMigration` | `boolean` | If true, the prefix will be live migrated. | -| `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 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. | -| `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. | | `parentPrefix` | `string` | The URL of parent prefix. Either PublicAdvertisedPrefix or PublicDelegatedPrefix. | -| `ipCidrRange` | `string` | The IP address range, in CIDR format, represented by 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. | | `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. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#publicDelegatedPrefix for public delegated 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 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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. | | `get` | `SELECT` | `project, publicDelegatedPrefix, region` | Returns the specified PublicDelegatedPrefix resource in the given region. | | `list` | `SELECT` | `project, region` | Lists the PublicDelegatedPrefixes for a project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a PublicDelegatedPrefix in the specified project in the given region using the parameters that are included in the request. | | `delete` | `DELETE` | `project, publicDelegatedPrefix, region` | Deletes the specified PublicDelegatedPrefix in the given region. | -| `_list` | `EXEC` | `project, region` | Lists the PublicDelegatedPrefixes for a project in the given region. | -| `aggregated_list` | `EXEC` | `project` | Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. | +| `_aggregated_list` | `EXEC` | `project` | Lists all PublicDelegatedPrefix resources owned by the specific project across all scopes. | | `patch` | `EXEC` | `project, publicDelegatedPrefix, region` | Patches the specified PublicDelegatedPrefix resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | 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 b4886242d1..dcf2cb7c11 100644 --- a/docs/google-docs/providers/google/compute/region_autoscalers/index.md +++ b/docs/google-docs/providers/google/compute/region_autoscalers/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. | | `autoscalingPolicy` | `object` | Cloud Autoscaler policy. | -| `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. | -| `region` | `string` | [Output Only] URL of the region where the instance group resides (for autoscalers living in regional scope). | +| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `scalingScheduleStatus` | `object` | [Output Only] Status information of existing scaling schedules. | +| `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. | -| `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). | -| `target` | `string` | URL of the managed instance group that this autoscaler will scale. This field is required when creating an autoscaler. | | `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). | +| `zone` | `string` | [Output Only] URL of the zone where the instance group resides (for autoscalers living in zonal scope). | +| `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. | | `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 | @@ -48,6 +48,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of autoscalers contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates an autoscaler in the specified project using the data included in the request. | | `delete` | `DELETE` | `autoscaler, project, region` | Deletes the specified autoscaler. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of autoscalers contained within the specified region. | | `patch` | `EXEC` | `project, region` | Updates an autoscaler in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, region` | Updates an autoscaler in the specified project using the data included in the request. | 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 6a8d03af88..85a8278956 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. | -| `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. | -| `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. | +| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | +| `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). | +| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge 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. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | +| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | | `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. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `connectionDraining` | `object` | Message containing connection draining configuration. | -| `iap` | `object` | Identity-Aware Proxy | -| `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. | -| `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. | -| `backends` | `array` | The list of backends that serve this BackendService. | +| `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). | +| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | +| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | +| `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. | +| `connectionDraining` | `object` | Message containing connection draining configuration. | +| `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. | +| `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. | | `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. | -| `edgeSecurityPolicy` | `string` | [Output Only] The resource URL for the edge security policy associated with this backend service. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#backendService for backend services. | -| `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. | +| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | +| `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. | +| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a 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. | -| `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). | -| `compressionMode` | `string` | Compress text responses using Brotli or gzip compression, based on the client's Accept-Encoding header. | +| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | +| `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. | | `consistentHash` | `object` | This message defines settings for a consistent hash style load balancer. | +| `iap` | `object` | Identity-Aware Proxy | | `metadatas` | `object` | Deployment metadata associated with the resource to be set by a GKE hub controller and read by the backend RCTH | -| `outlierDetection` | `object` | Settings controlling the eviction of unhealthy hosts from the load balancing pool for the backend service. | -| `connectionTrackingPolicy` | `object` | Connection Tracking configuration for this BackendService. | -| `logConfig` | `object` | The available logging options for the load balancer traffic served by this backend service. | -| `circuitBreakers` | `object` | Settings controlling the volume of requests, connections and retries to this backend service. | -| `securitySettings` | `object` | The authentication and authorization settings for a BackendService. | +| `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. | -| `customResponseHeaders` | `array` | Headers that the load balancer adds to proxied responses. See [Creating custom headers](https://cloud.google.com/load-balancing/docs/custom-headers). | -| `securityPolicy` | `string` | [Output Only] The resource URL for the security policy associated with this backend service. | -| `cdnPolicy` | `object` | Message containing Cloud CDN configuration for a 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). | -| `enableCDN` | `boolean` | If true, enables Cloud CDN for the backend service of an external HTTP(S) load balancer. | -| `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. | -| `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). | +| `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. | +| `backends` | `array` | The list of backends that serve this BackendService. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -74,6 +74,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of regional BackendService resources available to the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a regional BackendService resource in the specified project using the data included in the request. For more information, see Backend services overview. | | `delete` | `DELETE` | `backendService, project, region` | Deletes the specified regional BackendService resource. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of regional BackendService resources available to the specified project in the given region. | | `patch` | `EXEC` | `backendService, project, region` | Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `backendService, project, region` | Updates the specified regional BackendService resource with the data included in the request. For more information, see Backend services overview . | 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 deea432662..a35eaa07e6 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 bb92fd8bdb..40d42c4273 100644 --- a/docs/google-docs/providers/google/compute/region_commitments/index.md +++ b/docs/google-docs/providers/google/compute/region_commitments/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. | -| `licenseResource` | `object` | Commitment for a particular license 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). | -| `region` | `string` | [Output Only] URL of the region where this commitment may be used. | -| `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. | -| `splitSourceCommitment` | `string` | Source commitment to be split into a new commitment. | | `statusMessage` | `string` | [Output Only] An optional, human-readable explanation of the status. | -| `startTimestamp` | `string` | [Output Only] Commitment start time in RFC3339 text format. | -| `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. | +| `region` | `string` | [Output Only] URL of the region where this commitment may be used. | | `mergeSourceCommitments` | `array` | List of source commitments to be merged 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. | +| `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). | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `splitSourceCommitment` | `string` | Source commitment to be split into a new commitment. | +| `startTimestamp` | `string` | [Output Only] Commitment start time in RFC3339 text format. | +| `licenseResource` | `object` | Commitment for a particular license 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. | -| `resources` | `array` | A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#commitment for commitments. | +| `resources` | `array` | A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. | +| `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. | +| `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. | | `endTimestamp` | `string` | [Output Only] Commitment end time in RFC3339 text format. | | `reservations` | `array` | List of reservations in this commitment. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of commitments by region. | | `get` | `SELECT` | `commitment, project, region` | Returns the specified commitment resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of commitments contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates a commitment in the specified project using the data included in the request. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of commitments contained within the specified region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of commitments by region. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of commitments by region. | | `update` | `EXEC` | `commitment, project, region` | Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew. | 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 76d2acb2d2..e4e227e570 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,17 +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` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] An optional description of this resource. | +| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | -| `deprecated` | `object` | Deprecation status for a public resource. | -| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `validDiskSize` | `string` | [Output Only] An optional textual description of the valid disk size, such as "10GB-10TB". | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#diskType for disk types. | +| `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. | +| `defaultDiskSizeGb` | `string` | [Output Only] Server-defined default disk size in GB. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `diskType, project, region` | Returns the specified regional disk type. | | `list` | `SELECT` | `project, region` | Retrieves a list of regional disk types available to the specified project. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of regional disk types available to the specified project. | 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 06062b002b..a8745431f4 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. | -| `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. | -| `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. | -| `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. | -| `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 | +| `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. | +| `params` | `object` | Additional disk params. | +| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | +| `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. | | `resourcePolicies` | `array` | Resource policies applied to this disk for automatic snapshot creations. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | +| `options` | `string` | Internal use only. | +| `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. | +| `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 greater than 0. | | `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. | +| `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. | +| `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. | +| `sourceImageEncryptionKey` | `object` | | +| `asyncPrimaryDisk` | `object` | | | `resourceStatus` | `object` | | -| `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#disk for disks. | -| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | -| `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. | -| `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | -| `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. | | `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. | -| `sourceImageEncryptionKey` | `object` | | +| `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. | | `lastDetachTimestamp` | `string` | [Output Only] Last detach 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. | -| `users` | `array` | [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance | -| `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. | -| `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. | -| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | -| `sourceSnapshotEncryptionKey` | `object` | | -| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | -| `asyncPrimaryDisk` | `object` | | +| `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. | | `licenses` | `array` | A list of publicly visible licenses. Reserved for Google's use. | +| `sourceConsistencyGroupPolicy` | `string` | [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `asyncSecondaryDisks` | `object` | [Output Only] A list of disks this disk is asynchronously replicated to. | +| `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. | +| `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. | | `labels` | `object` | Labels to apply to this disk. These can be later modified by the setLabels method. | -| `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. | -| `options` | `string` | Internal use only. | -| `diskEncryptionKey` | `object` | | +| `licenseCodes` | `array` | Integer license codes indicating which licenses are attached to this disk. | | `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 | -| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future 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. | +| `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` | | | `sourceConsistencyGroupPolicyId` | `string` | [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. | +| `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 | | `replicaZones` | `array` | URLs of the zones where the disk should be replicated to. Only applicable for regional resources. | -| `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. | -| `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. | -| `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 | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `params` | `object` | Additional disk params. | -| `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. | +| `lastAttachTimestamp` | `string` | [Output Only] Last attach timestamp in RFC3339 text format. | +| `architecture` | `string` | The architecture of the disk. Valid values are ARM64 or X86_64. | +| `sourceSnapshotEncryptionKey` | `object` | | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -78,7 +78,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of persistent disks contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates a persistent regional disk in the specified project using the data included in the request. | | `delete` | `DELETE` | `disk, project, region` | Deletes the specified regional persistent disk. Deleting a regional disk removes all the replicas of its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of persistent disks contained within the specified region. | | `bulk_insert` | `EXEC` | `project, region` | Bulk create a set of disks. | | `resize` | `EXEC` | `disk, project, region` | Resizes the specified regional persistent disk. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on the target regional disk. | 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 d38a184b12..29d6164105 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 f8c1993ac0..ae7947f0fe 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. | +| `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. | +| `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. | -| `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. | -| `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. | -| `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | +| `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | -| `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. | +| `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 | |:-----|:--------------|:----------------|:------------| @@ -46,5 +46,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists all the HealthCheckService resources that have been configured for the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a regional HealthCheckService resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `healthCheckService, project, region` | Deletes the specified regional HealthCheckService. | -| `_list` | `EXEC` | `project, region` | Lists all the HealthCheckService resources that have been configured for the specified project in the given region. | | `patch` | `EXEC` | `healthCheckService, project, region` | Updates the specified regional HealthCheckService resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | 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 210886c67b..d6fc7dc1be 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. | +| `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. | +| `kind` | `string` | Type of the resource. | +| `sslHealthCheck` | `object` | | +| `checkIntervalSec` | `integer` | How often (in seconds) to send a health check. The default value is 5 seconds. | +| `httpsHealthCheck` | `object` | | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in 3339 text format. | +| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | +| `grpcHealthCheck` | `object` | | +| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | +| `tcpHealthCheck` | `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. | -| `kind` | `string` | Type of the resource. | | `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. | | `http2HealthCheck` | `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. | -| `region` | `string` | [Output Only] Region where the health check resides. Not applicable to global health checks. | | `httpHealthCheck` | `object` | | -| `grpcHealthCheck` | `object` | | -| `httpsHealthCheck` | `object` | | -| `tcpHealthCheck` | `object` | | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `sslHealthCheck` | `object` | | -| `healthyThreshold` | `integer` | A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. | -| `unhealthyThreshold` | `integer` | A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,6 +53,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of HealthCheck resources available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a HealthCheck resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `healthCheck, project, region` | Deletes the specified HealthCheck resource. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of HealthCheck resources available to the specified project. | | `patch` | `EXEC` | `healthCheck, project, region` | Updates a HealthCheck resource in the specified project using the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `healthCheck, project, region` | Updates a HealthCheck resource in the specified project using the data included in the request. | 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 9b65f2cedf..bc10c7e4ba 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. | -| `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. | -| `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. | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | +| `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. | | `statefulPolicy` | `object` | | +| `distributionPolicy` | `object` | | +| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | +| `status` | `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. | | `instanceLifecyclePolicy` | `object` | | +| `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). | -| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | -| `listManagedInstancesResults` | `string` | Pagination behavior of the listManagedInstances API method for this managed instance group. | -| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups. | -| `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. | -| `distributionPolicy` | `object` | | -| `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | +| `currentActions` | `object` | | +| `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | | `updatePolicy` | `object` | | | `creationTimestamp` | `string` | [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. | -| `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. | -| `autoHealingPolicies` | `array` | The autohealing policy for this managed instance group. You can specify only one value. | +| `selfLink` | `string` | [Output Only] The URL for this managed instance group. The server defines this URL. | +| `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. | +| `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. | -| `status` | `object` | | -| `zone` | `string` | [Output Only] The URL of a zone where the managed instance group is located (for zonal resources). | -| `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. | +| `instanceGroup` | `string` | [Output Only] The URL of the Instance Group resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -58,7 +58,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of managed instance groups that are contained within the specified region. | | `insert` | `INSERT` | `project, region` | Creates a managed instance group using the information that you specify in the request. After the group is created, instances in the group are created using the specified instance template. This operation is marked as DONE when the group is created even if the instances in the group have not yet been created. You must separately verify the status of the individual instances with the listmanagedinstances method. A regional managed instance group can contain up to 2000 instances. | | `delete` | `DELETE` | `instanceGroupManager, project, region` | Deletes the specified managed instance group and all of the instances in that group. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of managed instance groups that are contained within the specified region. | | `abandon_instances` | `EXEC` | `instanceGroupManager, project, region` | Flags the specified instances to be immediately removed from the managed instance group. Abandoning an instance does not delete the instance, but it does remove the instance from any target pools that are applied by the managed instance group. This method reduces the targetSize of the managed instance group by the number of instances that you abandon. This operation is marked as DONE when the action is scheduled even if the instances have not yet been removed from the group. You must separately verify the status of the abandoning action with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. You can specify a maximum of 1000 instances with this method per request. | | `apply_updates_to_instances` | `EXEC` | `instanceGroupManager, project, region` | Apply updates to selected instances the managed instance group. | | `patch` | `EXEC` | `instanceGroupManager, project, region` | Updates a managed instance group using the information that you specify in the request. This operation is marked as DONE when the group is patched even if the instances in the group are still in the process of being patched. You must separately verify the status of the individual instances with the listmanagedinstances method. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. If you update your group to specify a new template or instance configuration, it's possible that your intended specification for each VM in the group is different from the current state of that VM. To learn how to apply an updated configuration to the VMs in a MIG, see Updating instances in a MIG. | 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 e314172291..61b34de2e6 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,20 +30,19 @@ 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). | -| `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. | -| `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. | -| `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). | -| `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. | +| `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. | | `size` | `integer` | [Output Only] The total number of instances in the 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). | +| `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). | | `region` | `string` | [Output Only] The URL of the region where the instance group is located (for regional resources). | +| `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. | +| `selfLink` | `string` | [Output Only] The URL for this instance group. The server generates this URL. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `instanceGroup, project, region` | Returns the specified instance group resource. | | `list` | `SELECT` | `project, region` | Retrieves the list of instance group resources contained within the specified region. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of instance group resources contained within the specified region. | | `set_named_ports` | `EXEC` | `instanceGroup, project, region` | Sets the named ports for the specified regional instance group. | 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 392c92196c..8386aa3fe0 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. | -| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. | -| `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. | +| `selfLink` | `string` | [Output Only] The URL for this instance template. The server defines this URL. | | `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 | +| `creationTimestamp` | `string` | [Output Only] The creation timestamp for this instance template in RFC3339 text format. | | `properties` | `object` | | -| `selfLink` | `string` | [Output Only] The URL for this instance template. The server defines this URL. | +| `sourceInstanceParams` | `object` | A specification of the parameters to use when creating the instance template from a source instance. | +| `kind` | `string` | [Output Only] The resource type, which is always compute#instanceTemplate for instance templates. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of instance templates that are contained within the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates an instance template in the specified project and region using the global instance template whose URL is included in the request. | | `delete` | `DELETE` | `instanceTemplate, project, region` | Deletes the specified instance template. Deleting an instance template is permanent and cannot be undone. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of instance templates that are contained within the specified project and region. | 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 9c805d6fa4..dd0285362e 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. | -| `zone` | `string` | [Output Only] The URL of the zone 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. | | `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. | +| `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. | | `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. | +| `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. | +| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#networkEndpointGroup for network endpoint group. | +| `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. | | `annotations` | `object` | Metadata defined as annotations on the network endpoint group. | -| `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. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `zone` | `string` | [Output Only] The URL of the zone where the network endpoint group is located. | | `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. | -| `defaultPort` | `integer` | The default port used if the port number is not specified in the network endpoint. | -| `pscData` | `object` | All data that is specifically relevant to only network endpoint groups of type PRIVATE_SERVICE_CONNECT. | -| `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. | -| `region` | `string` | [Output Only] The URL of the region where the network endpoint group is located. | -| `network` | `string` | The URL of the network to which all network endpoints in the NEG belong. Uses "default" project network if unspecified. | +| `subnetwork` | `string` | Optional URL of the subnetwork to which all network endpoints in the NEG belong. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -53,4 +53,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of regional network endpoint groups available to the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a network endpoint group in the specified project using the parameters that are included in the request. | | `delete` | `DELETE` | `networkEndpointGroup, project, region` | Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of regional network endpoint groups available to the specified project in the given region. | 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 7f0cceb5bc..53f1d351ee 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 @@ -31,17 +31,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `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. | -| `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. | +| `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. | +| `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. | | `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. | | `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 (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. | -| `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. | -| `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 | | `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,7 +49,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists all the network firewall policies that have been configured for the specified project in the given region. | | `insert` | `INSERT` | `project, region` | Creates a new network firewall policy in the specified project and region. | | `delete` | `DELETE` | `firewallPolicy, project, region` | Deletes the specified network firewall policy. | -| `_list` | `EXEC` | `project, region` | Lists all the network firewall policies that have been configured for the specified project in the given region. | | `clone_rules` | `EXEC` | `firewallPolicy, project, region` | Copies rules to the specified network firewall policy. | | `patch` | `EXEC` | `firewallPolicy, project, region` | Patches the specified network firewall policy. | | `patch_rule` | `EXEC` | `firewallPolicy, project, region` | Patches a rule of the specified priority. | 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 f454d9ebc8..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. | -| `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_policies/index.md b/docs/google-docs/providers/google/compute/region_network_firewall_policies_iam_policies/index.md index 27f7650c64..26fbf25ebe 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 545f15f73d..666368da53 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. | -| `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. | -| `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. | -| `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. | -| `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. | | `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. | | `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. | +| `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. | | `ruleTupleCount` | `integer` | [Output Only] Calculation of the complexity of a single firewall policy rule. | -| `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | +| `ruleName` | `string` | An optional name for the rule. This field is not a unique identifier and can be updated. | +| `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. | +| `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. | | `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. | ## 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 4a6371676d..8652167893 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. | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -42,4 +42,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists the NotificationEndpoints for a project in the given region. | | `insert` | `INSERT` | `project, region` | Create a NotificationEndpoint in the specified project in the given region using the parameters that are included in the request. | | `delete` | `DELETE` | `notificationEndpoint, project, region` | Deletes the specified NotificationEndpoint in the given region | -| `_list` | `EXEC` | `project, region` | Lists the NotificationEndpoints for a project in the given region. | 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 259d95c245..10e639bc3e 100644 --- a/docs/google-docs/providers/google/compute/region_operations/index.md +++ b/docs/google-docs/providers/google/compute/region_operations/index.md @@ -30,33 +30,33 @@ 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. | -| `setCommonInstanceMetadataOperationMetadata` | `object` | | -| `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. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `instancesBulkInsertOperationMetadata` | `object` | | | `error` | `object` | [Output Only] If errors 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. | -| `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. | +| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | +| `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. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | | `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | | `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. | | `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. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | | `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. 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`. | | `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. | -| `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. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | -| `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project, region` | Retrieves the specified region-specific Operations resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of Operation resources contained within the specified region. | | `delete` | `DELETE` | `operation, project, region` | Deletes the specified region-specific Operations resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of Operation resources contained within the specified region. | | `wait` | `EXEC` | `operation, project, region` | Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. | 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 3c5e78ca80..8c13216aaf 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. | -| `advancedOptionsConfig` | `object` | | -| `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. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security policies | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `ddosProtectionConfig` | `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. | -| `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | | `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. | +| `ddosProtectionConfig` | `object` | | +| `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | +| `advancedOptionsConfig` | `object` | | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `recaptchaOptionsConfig` | `object` | | | `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. | +| `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | +| `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 | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,5 +50,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | List all the policies that have been configured for the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, region, securityPolicy` | Deletes the specified policy. | -| `_list` | `EXEC` | `project, region` | List all the policies that have been configured for the specified project and region. | | `patch` | `EXEC` | `project, region, securityPolicy` | Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. | 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 56e9c6ee18..60dc39185d 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. | -| `subjectAlternativeNames` | `array` | [Output Only] Domains associated with the certificate via Subject Alternative Name. | | `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global 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. | +| `managed` | `object` | Configuration and status of a managed SSL certificate. | +| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#sslCertificate for SSL certificates. | -| `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | -| `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. | | `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | +| `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. | | `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. | -| `managed` | `object` | Configuration and status of a managed SSL certificate. | -| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | +| `selfManaged` | `object` | Configuration and status of a self-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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -48,4 +48,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of SslCertificate resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a SslCertificate resource in the specified project and region using the data included in the request | | `delete` | `DELETE` | `project, region, sslCertificate` | Deletes the specified SslCertificate resource in the region. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of SslCertificate resources available to the specified project in the specified region. | 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 eb9db98905..97002f4ff0 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 @@ -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. | +| `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. | +| `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. | +| `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. | | `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. | +| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | | `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. | -| `region` | `string` | [Output Only] URL of the region where the regional SSL policy resides. This field is not applicable to global SSL policies. | -| `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. | +| `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. | -| `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. | -| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -47,5 +47,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Lists all the SSL policies that have been configured for the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a new policy in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, sslPolicy` | Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. | -| `_list` | `EXEC` | `project, region` | Lists all the SSL policies that have been configured for the specified project and region. | | `patch` | `EXEC` | `project, region, sslPolicy` | Patches the specified SSL policy with the data included in the request. | 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 6ad626fd54..8ee2392229 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. | +| `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. | | `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. | | `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. | -| `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. | +| `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. | +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,5 +45,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a TargetHttpProxy resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetHttpProxy` | Deletes the specified TargetHttpProxy resource. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of TargetHttpProxy resources available to the specified project in the specified region. | | `set_url_map` | `EXEC` | `project, region, targetHttpProxy` | Changes the URL map for TargetHttpProxy. | 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 f9a8ac2719..b9f69ff0ed 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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | +| `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. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | | `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | -| `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. | -| `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 | -| `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. | | `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. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS 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. | -| `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}. | -| `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. | +| `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. | +| `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. | | `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. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | +| `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. | +| `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}. | +| `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 | |:-----|:--------------|:----------------|:------------| @@ -51,7 +51,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a TargetHttpsProxy resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetHttpsProxy` | Deletes the specified TargetHttpsProxy resource. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of TargetHttpsProxy resources available to the specified project in the specified region. | | `patch` | `EXEC` | `project, region, targetHttpsProxy` | Patches the specified regional TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `set_ssl_certificates` | `EXEC` | `project, region, targetHttpsProxy` | Replaces SslCertificates for TargetHttpsProxy. | | `set_url_map` | `EXEC` | `project, region, targetHttpsProxy` | Changes the URL map for TargetHttpsProxy. | 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 2dce5f07df..e33fe47a85 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 @@ -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. | +| `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. | | `region` | `string` | [Output Only] URL of the region where the regional TCP proxy resides. This field is not applicable to global TCP proxy. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `service` | `string` | URL to the BackendService 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. | | `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,4 +44,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves a list of TargetTcpProxy resources available to the specified project in a given region. | | `insert` | `INSERT` | `project, region` | Creates a TargetTcpProxy resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetTcpProxy` | Deletes the specified TargetTcpProxy resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of TargetTcpProxy resources available to the specified project in a given region. | 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 f5c967ca73..6428a90557 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 @@ -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. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `defaultRouteAction` | `object` | | -| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | +| `hostRules` | `array` | The list of host rules to use against the URL. | +| `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. | | `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | | `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. | -| `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. | | `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. | -| `hostRules` | `array` | The list of host rules to use against the URL. | -| `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. | +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | +| `defaultRouteAction` | `object` | | +| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | @@ -49,7 +49,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project, region` | Retrieves the list of UrlMap resources available to the specified project in the specified region. | | `insert` | `INSERT` | `project, region` | Creates a UrlMap resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, region, urlMap` | Deletes the specified UrlMap resource. | -| `_list` | `EXEC` | `project, region` | Retrieves the list of UrlMap resources available to the specified project in the specified region. | | `patch` | `EXEC` | `project, region, urlMap` | Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, region, urlMap` | Updates the specified UrlMap resource with the data included in the request. | | `validate` | `EXEC` | `project, region, urlMap` | Runs static validation for the UrlMap. In particular, the tests of the provided UrlMap will be run. Calling this method does NOT create the UrlMap. | diff --git a/docs/google-docs/providers/google/compute/regions/index.md b/docs/google-docs/providers/google/compute/regions/index.md index ae07f9a0c3..95f5b4526c 100644 --- a/docs/google-docs/providers/google/compute/regions/index.md +++ b/docs/google-docs/providers/google/compute/regions/index.md @@ -30,17 +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` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] Textual description of the resource. | +| `status` | `string` | [Output Only] Status of the region, either UP or DOWN. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#region for regions. | | `quotas` | `array` | [Output Only] Quotas assigned to this region. | -| `status` | `string` | [Output Only] Status of the region, either UP or DOWN. | +| `zones` | `array` | [Output Only] A list of zones available in this region, in the form of resource URLs. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | | `deprecated` | `object` | Deprecation status for a public resource. | | `selfLink` | `string` | [Output Only] Server-defined URL for 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `project, region` | Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. | | `list` | `SELECT` | `project` | Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. | -| `_list` | `EXEC` | `project` | Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. | diff --git a/docs/google-docs/providers/google/compute/reservations/index.md b/docs/google-docs/providers/google/compute/reservations/index.md index 2539c1ebcc..366971f860 100644 --- a/docs/google-docs/providers/google/compute/reservations/index.md +++ b/docs/google-docs/providers/google/compute/reservations/index.md @@ -30,26 +30,26 @@ 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. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#reservations for reservations. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `resourceStatus` | `object` | [Output Only] Contains output only fields. | | `status` | `string` | [Output Only] The status of the reservation. | | `shareSettings` | `object` | The share setting for reservations and sole tenancy node groups. | -| `zone` | `string` | Zone in which the reservation resides. A zone must be provided if the reservation is created within 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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | -| `resourceStatus` | `object` | [Output Only] Contains output only fields. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | +| `specificReservation` | `object` | This reservation type allows to pre allocate specific instance configuration. Next ID: 6 | | `commitment` | `string` | [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. | +| `zone` | `string` | Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. | | `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. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of reservations. | | `get` | `SELECT` | `project, reservation, zone` | Retrieves information about the specified reservation. | | `list` | `SELECT` | `project, zone` | A list of all the reservations that have been configured for the specified project in specified zone. | | `insert` | `INSERT` | `project, zone` | Creates a new reservation. For more information, read Reserving zonal resources. | | `delete` | `DELETE` | `project, reservation, zone` | Deletes the specified reservation. | -| `_list` | `EXEC` | `project, zone` | A list of all the reservations that have been configured for the specified project in specified zone. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of reservations. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of reservations. | | `resize` | `EXEC` | `project, reservation, zone` | Resizes the reservation (applicable to standalone reservations only). For more information, read Modifying reservations. | | `update` | `EXEC` | `project, reservation, zone` | Update share settings of the reservation. | 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 fb4d020b53..d79fa2a531 100644 --- a/docs/google-docs/providers/google/compute/resource_policies/index.md +++ b/docs/google-docs/providers/google/compute/resource_policies/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` | 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` | | -| `status` | `string` | [Output Only] The status of resource policy creation. | | `groupPlacementPolicy` | `object` | A GroupPlacementPolicy specifies resource placement configuration. It specifies the failure bucket separation as well as network locality | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | | `diskConsistencyGroupPolicy` | `object` | Resource policy for disk consistency groups. | -| `instanceSchedulePolicy` | `object` | An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. | | `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. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#resource_policies for resource policies. | | `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `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. | +| `instanceSchedulePolicy` | `object` | An InstanceSchedulePolicy specifies when and how frequent certain operations are performed on the instance. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of resource policies. | | `get` | `SELECT` | `project, region, resourcePolicy` | Retrieves all information of the specified resource policy. | | `list` | `SELECT` | `project, region` | A list all the resource policies that have been configured for the specified project in specified region. | | `insert` | `INSERT` | `project, region` | Creates a new resource policy. | | `delete` | `DELETE` | `project, region, resourcePolicy` | Deletes the specified resource policy. | -| `_list` | `EXEC` | `project, region` | A list all the resource policies that have been configured for the specified project in specified region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of resource policies. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of resource policies. | | `patch` | `EXEC` | `project, region, resourcePolicy` | Modify the specified resource policy. | diff --git a/docs/google-docs/providers/google/compute/routers/index.md b/docs/google-docs/providers/google/compute/routers/index.md index 95660b7c07..5337ef8fdd 100644 --- a/docs/google-docs/providers/google/compute/routers/index.md +++ b/docs/google-docs/providers/google/compute/routers/index.md @@ -31,25 +31,25 @@ 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. | -| `md5AuthenticationKeys` | `array` | Keys used for MD5 authentication. | | `bgp` | `object` | | -| `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. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#router for routers. | -| `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. | -| `nats` | `array` | A list of NAT services created in this router. | -| `encryptedInterconnectRouter` | `boolean` | Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). | -| `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. | +| `nats` | `array` | A list of NAT services created in this router. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#router for routers. | +| `md5AuthenticationKeys` | `array` | Keys used for MD5 authentication. | +| `network` | `string` | URI of the network to which this router belongs. | +| `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. | +| `encryptedInterconnectRouter` | `boolean` | Indicates if a router is dedicated for use with encrypted VLAN attachments (interconnectAttachments). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of routers. | | `get` | `SELECT` | `project, region, router` | Returns the specified Router resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of Router resources available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a Router resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, router` | Deletes the specified Router resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of Router resources available to the specified project. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of routers. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of routers. | | `patch` | `EXEC` | `project, region, router` | Patches the specified Router resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `preview` | `EXEC` | `project, region, router` | Preview fields auto-generated during router create and update operations. Calling this method does NOT create or update the router. | | `update` | `EXEC` | `project, region, router` | Updates the specified Router resource with the data included in the request. This method conforms to PUT semantics, which requests that the state of the target resource be created or replaced with the state defined by the representation enclosed in the request message payload. | 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 d325aad70b..45e55d401f 100644 --- a/docs/google-docs/providers/google/compute/routes/index.md +++ b/docs/google-docs/providers/google/compute/routes/index.md @@ -30,25 +30,25 @@ 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. | -| `routeStatus` | `string` | [Output only] The status of the route. | -| `nextHopNetwork` | `string` | The URL of the local network if it should handle matching packets. | -| `kind` | `string` | [Output Only] Type of this resource. Always compute#routes for Route resources. | +| `nextHopHub` | `string` | [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. | +| `asPaths` | `array` | [Output Only] AS path. | +| `nextHopIp` | `string` | The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address. | | `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. | +| `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 | | `tags` | `array` | A list of instance tags to which this route applies. | -| `asPaths` | `array` | [Output Only] AS path. | -| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. | -| `nextHopHub` | `string` | [Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `destRange` | `string` | The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed 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. | | `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/ | -| `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 | -| `nextHopIp` | `string` | The network IP address of an instance that should handle matching packets. Only IPv4 is supported. | -| `destRange` | `string` | The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. | +| `nextHopVpnTunnel` | `string` | The URL to a VpnTunnel that should handle matching packets. | | `network` | `string` | Fully-qualified URL of the network that this route applies to. | -| `selfLink` | `string` | [Output Only] Server-defined fully-qualified URL for this resource. | +| `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 | +| `routeStatus` | `string` | [Output only] The status of the route. | +| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages. | +| `nextHopPeering` | `string` | [Output Only] The network peering name that should handle matching packets, which should conform to RFC1035. | +| `kind` | `string` | [Output Only] Type of this resource. Always compute#routes for Route resources. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -56,4 +56,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of Route resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a Route resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, route` | Deletes the specified Route resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of Route resources available to the specified project. | 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 fb28fb70d2..f2e2a2a97d 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. | -| `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. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor 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. | +| `advancedOptionsConfig` | `object` | | | `recaptchaOptionsConfig` | `object` | | -| `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. | -| `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. | | `ddosProtectionConfig` | `object` | | | `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | +| `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. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security 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 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. | -| `advancedOptionsConfig` | `object` | | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output Only] Server-defined URL for 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. | +| `region` | `string` | [Output Only] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -50,7 +50,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | List all the policies that have been configured for the specified project. | | `insert` | `INSERT` | `project` | Creates a new policy in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, securityPolicy` | Deletes the specified policy. | -| `_list` | `EXEC` | `project` | List all the policies that have been configured for the specified project. | | `patch` | `EXEC` | `project, securityPolicy` | Patches the specified policy with the data included in the request. To clear fields in the policy, leave the fields empty and specify them in the updateMask. This cannot be used to be update the rules in the policy. Please use the per rule methods like addRule, patchRule, and removeRule instead. | | `patch_rule` | `EXEC` | `project, securityPolicy` | Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on a security policy. To learn more about labels, read the Labeling Resources documentation. | diff --git a/docs/google-docs/providers/google/compute/security_policies_aggregated/index.md b/docs/google-docs/providers/google/compute/security_policies_aggregated/index.md index 19115afa46..4b406d2cbf 100644 --- a/docs/google-docs/providers/google/compute/security_policies_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/security_policies_aggregated/index.md @@ -25,8 +25,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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] URL of the region where the regional security policy resides. This field is not applicable to global security policies. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `adaptiveProtectionConfig` | `object` | Configuration options for Cloud Armor Adaptive Protection (CAAP). | +| `selfLink` | `string` | [Output Only] Server-defined URL for 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 security policy. | +| `advancedOptionsConfig` | `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. | +| `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` | | +| `ddosProtectionConfig` | `object` | | +| `kind` | `string` | [Output only] Type of the resource. Always compute#securityPolicyfor security policies | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 4b1342e4ae..c2dd5d4f84 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,15 +28,15 @@ 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` | | +| `preconfiguredWafConfig` | `object` | | | `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. | +| `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 | -| `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` | | -| `headerAction` | `object` | | | `redirectOptions` | `object` | | +| `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. | +| `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. | | `match` | `object` | Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. | -| `preview` | `boolean` | If set to true, the specified action is not enforced. | ## 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 0d3d3b7c6b..5069a6b20b 100644 --- a/docs/google-docs/providers/google/compute/service_attachments/index.md +++ b/docs/google-docs/providers/google/compute/service_attachments/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 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. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `connectedEndpoints` | `array` | [Output Only] An array of connections for all the consumers connected to this service attachment. | +| `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. | +| `consumerAcceptLists` | `array` | Projects that are allowed to connect to this service attachment. | +| `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. | +| `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. | +| `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. | -| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#serviceAttachment for service attachments. | -| `consumerRejectLists` | `array` | Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number. | | `producerForwardingRule` | `string` | The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by 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. | | `pscServiceAttachmentId` | `object` | | -| `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. | -| `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. | -| `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. | +| `consumerRejectLists` | `array` | Projects that are not allowed to connect to this service attachment. The project can be specified using its id or number. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. | | `get` | `SELECT` | `project, region, serviceAttachment` | Returns the specified ServiceAttachment resource in the given scope. | | `list` | `SELECT` | `project, region` | Lists the ServiceAttachments for a project in the given scope. | | `insert` | `INSERT` | `project, region` | Creates a ServiceAttachment in the specified project in the given scope using the parameters that are included in the request. | | `delete` | `DELETE` | `project, region, serviceAttachment` | Deletes the specified ServiceAttachment in the given scope | -| `_list` | `EXEC` | `project, region` | Lists the ServiceAttachments for a project in the given scope. | -| `aggregated_list` | `EXEC` | `project` | Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves the list of all ServiceAttachment resources, regional and global, available to the specified project. | | `patch` | `EXEC` | `project, region, serviceAttachment` | Patches the specified ServiceAttachment resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | 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 0d81c9e828..f8a1f6485e 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/compute/snapshots/index.md b/docs/google-docs/providers/google/compute/snapshots/index.md index 7c765dc1bf..9ebc61602e 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. | -| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `autoCreated` | `boolean` | [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. | +| `labels` | `object` | Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. | +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. | | `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. | -| `sourceSnapshotSchedulePolicy` | `string` | [Output Only] URL of the resource policy which created this scheduled snapshot. | +| `snapshotType` | `string` | Indicates the type of the snapshot. | | `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. | -| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | -| `downloadBytes` | `string` | [Output Only] Number of bytes downloaded to restore a snapshot to a disk. | | `architecture` | `string` | [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. | -| `autoCreated` | `boolean` | [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. | -| `storageLocations` | `array` | Cloud Storage bucket storage location of the snapshot (regional or multi-regional). | +| `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. | | `sourceDisk` | `string` | The source disk used to create this snapshot. | -| `snapshotEncryptionKey` | `object` | | +| `storageLocations` | `array` | Cloud Storage bucket storage location of the snapshot (regional or multi-regional). | +| `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). | +| `creationSizeBytes` | `string` | [Output Only] Size in bytes of the snapshot at creation time. | +| `licenseCodes` | `array` | [Output Only] Integer license codes indicating which licenses are attached to this snapshot. | +| `downloadBytes` | `string` | [Output Only] Number of bytes downloaded to restore a snapshot to a disk. | +| `status` | `string` | [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. | +| `sourceSnapshotSchedulePolicy` | `string` | [Output Only] URL of the resource policy which created this scheduled snapshot. | | `diskSizeGb` | `string` | [Output Only] Size of the source disk, specified in GB. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `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. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. | +| `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. | +| `satisfiesPzs` | `boolean` | [Output Only] Reserved for future use. | | `sourceDiskEncryptionKey` | `object` | | | `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. | -| `creationSizeBytes` | `string` | [Output Only] Size in bytes of the snapshot at creation time. | -| `labels` | `object` | Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. | -| `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). | -| `snapshotType` | `string` | Indicates the type of the snapshot. | -| `status` | `string` | [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -63,5 +63,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of Snapshot resources contained within the specified project. | | `insert` | `INSERT` | `project` | Creates a snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project. | | `delete` | `DELETE` | `project, snapshot` | Deletes the specified Snapshot resource. Keep in mind that deleting a single snapshot might not necessarily delete all the data on that snapshot. If any data on the snapshot that is marked for deletion is needed for subsequent snapshots, the data will be moved to the next corresponding snapshot. For more information, see Deleting snapshots. | -| `_list` | `EXEC` | `project` | Retrieves the list of Snapshot resources contained within the specified project. | | `set_labels` | `EXEC` | `project, resource` | Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. | 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 d8110d3a34..7431825ba8 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 8b36f47c48..db0f672eca 100644 --- a/docs/google-docs/providers/google/compute/ssl_certificates/index.md +++ b/docs/google-docs/providers/google/compute/ssl_certificates/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. | -| `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. | -| `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. | | `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. | -| `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. | | `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | -| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | +| `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. | +| `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global 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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `selfLink` | `string` | [Output only] Server-defined URL for 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. | | `expireTime` | `string` | [Output Only] Expire time of the certificate. RFC3339 | ## Methods | Name | Accessible by | Required Params | Description | @@ -48,4 +48,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of SslCertificate resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a SslCertificate resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, sslCertificate` | Deletes the specified SslCertificate resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of SslCertificate resources available to the specified project. | diff --git a/docs/google-docs/providers/google/compute/ssl_certificates_aggregated/index.md b/docs/google-docs/providers/google/compute/ssl_certificates_aggregated/index.md index 2be8c4f9d8..500f1dcdcd 100644 --- a/docs/google-docs/providers/google/compute/ssl_certificates_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/ssl_certificates_aggregated/index.md @@ -25,8 +25,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `region` | `string` | [Output Only] URL of the region where the regional SSL Certificate resides. This field is not applicable to global 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. | +| `selfManaged` | `object` | Configuration and status of a self-managed SSL certificate. | +| `managed` | `object` | Configuration and status of a managed 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. | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 cebef59225..04d41f8fd9 100644 --- a/docs/google-docs/providers/google/compute/ssl_policies/index.md +++ b/docs/google-docs/providers/google/compute/ssl_policies/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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `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. | +| `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. | | `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. | -| `kind` | `string` | [Output only] Type of the resource. Always compute#sslPolicyfor SSL policies. | | `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | -| `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. | | `enabledFeatures` | `array` | [Output Only] The list of features enabled in the SSL policy. | -| `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. | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | @@ -47,5 +47,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists all the SSL policies that have been configured for the specified project. | | `insert` | `INSERT` | `project` | Returns the specified SSL policy resource. | | `delete` | `DELETE` | `project, sslPolicy` | Deletes the specified SSL policy. The SSL policy resource can be deleted only if it is not in use by any TargetHttpsProxy or TargetSslProxy resources. | -| `_list` | `EXEC` | `project` | Lists all the SSL policies that have been configured for the specified project. | | `patch` | `EXEC` | `project, sslPolicy` | Patches the specified SSL policy with the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/ssl_policies_aggregated/index.md b/docs/google-docs/providers/google/compute/ssl_policies_aggregated/index.md index 278def31db..8f48ef6fe1 100644 --- a/docs/google-docs/providers/google/compute/ssl_policies_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/ssl_policies_aggregated/index.md @@ -25,8 +25,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `warnings` | `array` | [Output Only] If potential misconfigurations are detected for this SSL policy, this field will be populated with warning messages. | +| `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. | +| `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. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | diff --git a/docs/google-docs/providers/google/compute/subnetworks/index.md b/docs/google-docs/providers/google/compute/subnetworks/index.md index f29a41a405..dfb9d2adb8 100644 --- a/docs/google-docs/providers/google/compute/subnetworks/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks/index.md @@ -30,36 +30,36 @@ 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. | +| `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 | +| `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. | +| `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. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. | +| `region` | `string` | URL of the region where the Subnetwork resides. This field can be set only at resource creation time. | | `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. | -| `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. | | `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. | -| `privateIpv6GoogleAccess` | `string` | This field is for internal use. This field can be both set at resource creation time and updated using patch. | -| `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. | -| `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. | -| `region` | `string` | URL of the region where the Subnetwork resides. 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. | +| `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. | | `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | -| `ipv6CidrRange` | `string` | [Output Only] This field is for internal use. | -| `logConfig` | `object` | The available logging options for 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. | +| `logConfig` | `object` | The available logging options for this subnetwork. | +| `ipv6CidrRange` | `string` | [Output Only] This field is for internal use. | +| `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. | | `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. | -| `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. | -| `gatewayAddress` | `string` | [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. | +| `privateIpv6GoogleAccess` | `string` | This field is for internal use. This field can be both set at resource creation time and updated using patch. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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 | -| `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. | -| `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. | +| `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. | +| `externalIpv6Prefix` | `string` | The external IPv6 address range that is owned by 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of subnetworks. | | `get` | `SELECT` | `project, region, subnetwork` | Returns the specified subnetwork. | | `list` | `SELECT` | `project, region` | Retrieves a list of subnetworks available to the specified project. | | `insert` | `INSERT` | `project, region` | Creates a subnetwork in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, region, subnetwork` | Deletes the specified subnetwork. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of subnetworks available to the specified project. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of subnetworks. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of subnetworks. | | `expand_ip_cidr_range` | `EXEC` | `project, region, subnetwork` | Expands the IP CIDR range of the subnetwork to a specified value. | | `patch` | `EXEC` | `project, region, subnetwork` | Patches the specified subnetwork with the data included in the request. Only certain fields can be updated with a patch request as indicated in the field descriptions. You must specify the current fingerprint of the subnetwork resource being patched. | | `set_private_ip_google_access` | `EXEC` | `project, region, subnetwork` | Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. | 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 946015d64b..d1074cf6fd 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,10 +27,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 00879ae4e5..ea5e560a08 100644 --- a/docs/google-docs/providers/google/compute/subnetworks_usable/index.md +++ b/docs/google-docs/providers/google/compute/subnetworks_usable/index.md @@ -27,15 +27,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `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. | -| `secondaryIpRanges` | `array` | Secondary IP ranges. | | `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. | | `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. | -| `ipCidrRange` | `string` | The range of internal addresses that are 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. | | `subnetwork` | `string` | Subnetwork URL. | | `network` | `string` | Network URL. | -| `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. | | `internalIpv6Prefix` | `string` | [Output Only] The internal IPv6 address range that is assigned to this subnetwork. | +| `ipCidrRange` | `string` | The range of internal addresses that are owned by this subnetwork. | +| `secondaryIpRanges` | `array` | Secondary IP ranges. | | `externalIpv6Prefix` | `string` | [Output Only] The external IPv6 address range that is assigned to this subnetwork. | ## 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 a60db2bc8b..1f83f2bdf6 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 @@ -30,13 +30,13 @@ 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. | +| `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. | +| `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. | +| `selfLinkWithId` | `string` | [Output Only] Server-defined URL with id 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. | | `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. | | `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 | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,5 +44,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Lists the TargetGrpcProxies for a project in the given scope. | | `insert` | `INSERT` | `project` | Creates a TargetGrpcProxy in the specified project in the given scope using the parameters that are included in the request. | | `delete` | `DELETE` | `project, targetGrpcProxy` | Deletes the specified TargetGrpcProxy in the given scope | -| `_list` | `EXEC` | `project` | Lists the TargetGrpcProxies for a project in the given scope. | | `patch` | `EXEC` | `project, targetGrpcProxy` | Patches the specified TargetGrpcProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | 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 d7789bbab6..52d358510b 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. | +| `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. | | `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `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. | +| `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. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,6 +45,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetHttpProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetHttpProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetHttpProxy` | Deletes the specified TargetHttpProxy resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of TargetHttpProxy resources available to the specified project. | | `patch` | `EXEC` | `project, targetHttpProxy` | Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `set_url_map` | `EXEC` | `project, targetHttpProxy` | Changes the URL map for TargetHttpProxy. | diff --git a/docs/google-docs/providers/google/compute/target_http_proxies_aggregated/index.md b/docs/google-docs/providers/google/compute/target_http_proxies_aggregated/index.md index 2501cace3f..2f132e10bd 100644 --- a/docs/google-docs/providers/google/compute/target_http_proxies_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/target_http_proxies_aggregated/index.md @@ -25,8 +25,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | +| `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 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. | +| `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. | +| `urlMap` | `string` | URL to the UrlMap resource that defines the mapping from URL to the BackendService. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 9e30f5f474..5706ac0f8f 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 @@ -31,19 +31,19 @@ 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. | | `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. | -| `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. | -| `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. | -| `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. | +| `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. | | `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. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | -| `selfLink` | `string` | [Output Only] Server-defined URL for 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. | | `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}. | -| `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 | +| `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. | +| `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. | +| `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. | +| `kind` | `string` | [Output Only] Type of resource. Always compute#targetHttpsProxy for target HTTPS proxies. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -51,7 +51,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetHttpsProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetHttpsProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetHttpsProxy` | Deletes the specified TargetHttpsProxy resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of TargetHttpsProxy resources available to the specified project. | | `patch` | `EXEC` | `project, targetHttpsProxy` | Patches the specified TargetHttpsProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules. | | `set_certificate_map` | `EXEC` | `project, targetHttpsProxy` | Changes the Certificate Map for TargetHttpsProxy. | | `set_quic_override` | `EXEC` | `project, targetHttpsProxy` | Sets the QUIC override policy for TargetHttpsProxy. | diff --git a/docs/google-docs/providers/google/compute/target_https_proxies_aggregated/index.md b/docs/google-docs/providers/google/compute/target_https_proxies_aggregated/index.md index 1d61c6002e..eba4c58b28 100644 --- a/docs/google-docs/providers/google/compute/target_https_proxies_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/target_https_proxies_aggregated/index.md @@ -25,8 +25,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `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. | +| `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. | +| `region` | `string` | [Output Only] URL of the region where the regional TargetHttpsProxy resides. This field is not applicable to global TargetHttpsProxies. | +| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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 | +| `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. | +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 ca137e767e..d4e43636e0 100644 --- a/docs/google-docs/providers/google/compute/target_instances/index.md +++ b/docs/google-docs/providers/google/compute/target_instances/index.md @@ -31,18 +31,18 @@ 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. | | `kind` | `string` | [Output Only] The type of the resource. Always compute#targetInstance for target instances. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | | `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `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. | | `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. | -| `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 | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of target instances. | | `get` | `SELECT` | `project, targetInstance, zone` | Returns the specified TargetInstance resource. | | `list` | `SELECT` | `project, zone` | Retrieves a list of TargetInstance resources available to the specified project and zone. | | `insert` | `INSERT` | `project, zone` | Creates a TargetInstance resource in the specified project and zone using the data included in the request. | | `delete` | `DELETE` | `project, targetInstance, zone` | Deletes the specified TargetInstance resource. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of TargetInstance resources available to the specified project and zone. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target instances. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target instances. | 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 8a411f2473..e0440a6399 100644 --- a/docs/google-docs/providers/google/compute/target_pools/index.md +++ b/docs/google-docs/providers/google/compute/target_pools/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] URL of the region where the target pool resides. | -| `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. | | `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. | -| `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. | | `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. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#targetPool for target pools. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `region` | `string` | [Output Only] URL of the region where the target pool resides. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of target pools. | | `get` | `SELECT` | `project, region, targetPool` | Returns the specified target pool. | | `list` | `SELECT` | `project, region` | Retrieves a list of target pools available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a target pool in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetPool` | Deletes the specified target pool. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of target pools available to the specified project and region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target pools. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target pools. | | `set_backup` | `EXEC` | `project, region, targetPool` | Changes a backup target pool's configurations. | 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 49dd1a32d9..880a869890 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 @@ -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. | +| `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. | +| `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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `service` | `string` | URL to the BackendService resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#targetSslProxy for target SSL proxies. | | `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}. | | `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. | -| `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. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,7 +45,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetSslProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetSslProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetSslProxy` | Deletes the specified TargetSslProxy resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of TargetSslProxy resources available to the specified project. | | `set_backend_service` | `EXEC` | `project, targetSslProxy` | Changes the BackendService for TargetSslProxy. | | `set_certificate_map` | `EXEC` | `project, targetSslProxy` | Changes the Certificate Map for TargetSslProxy. | | `set_proxy_header` | `EXEC` | `project, targetSslProxy` | Changes the ProxyHeaderType for TargetSslProxy. | 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 690f7ff57a..62c7621971 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. | +| `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. | +| `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. | | `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. | -| `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. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#targetTcpProxy for target TCP proxies. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -44,6 +44,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of TargetTcpProxy resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a TargetTcpProxy resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, targetTcpProxy` | Deletes the specified TargetTcpProxy resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of TargetTcpProxy resources available to the specified project. | | `set_backend_service` | `EXEC` | `project, targetTcpProxy` | Changes the BackendService for TargetTcpProxy. | | `set_proxy_header` | `EXEC` | `project, targetTcpProxy` | Changes the ProxyHeaderType for TargetTcpProxy. | diff --git a/docs/google-docs/providers/google/compute/target_tcp_proxies_aggregated/index.md b/docs/google-docs/providers/google/compute/target_tcp_proxies_aggregated/index.md index 075987ec95..806ebe753d 100644 --- a/docs/google-docs/providers/google/compute/target_tcp_proxies_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/target_tcp_proxies_aggregated/index.md @@ -25,8 +25,20 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `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. | +| `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 | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 77ca4eb937..6eb51f50ba 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,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. | -| `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. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | | `kind` | `string` | [Output Only] Type of resource. Always compute#targetVpnGateway for target VPN gateways. | -| `status` | `string` | [Output Only] The status of the VPN gateway, which can be one of the following: CREATING, READY, FAILED, or DELETING. | +| `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. | | `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. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of target VPN gateways. | | `get` | `SELECT` | `project, region, targetVpnGateway` | Returns the specified target VPN gateway. | | `list` | `SELECT` | `project, region` | Retrieves a list of target VPN gateways available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a target VPN gateway in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, targetVpnGateway` | Deletes the specified target VPN gateway. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of target VPN gateways available to the specified project and region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target VPN gateways. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of target VPN gateways. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on a TargetVpnGateway. To learn more about labels, read the Labeling Resources documentation. | 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 00f3292701..ea924b1426 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. | +| `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. | -| `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | +| `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. | | `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. | +| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `defaultRouteAction` | `object` | | | `pathMatchers` | `array` | The list of named PathMatchers 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. | +| `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. | | `hostRules` | `array` | The list of host rules to use against the URL. | -| `defaultRouteAction` | `object` | | -| `headerAction` | `object` | The request and response header transformations that take effect before the request is passed along to the selected backendService. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -49,7 +49,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `project` | Retrieves the list of UrlMap resources available to the specified project. | | `insert` | `INSERT` | `project` | Creates a UrlMap resource in the specified project using the data included in the request. | | `delete` | `DELETE` | `project, urlMap` | Deletes the specified UrlMap resource. | -| `_list` | `EXEC` | `project` | Retrieves the list of UrlMap resources available to the specified project. | | `invalidate_cache` | `EXEC` | `project, urlMap` | Initiates a cache invalidation operation, invalidating the specified path, scoped to the specified UrlMap. For more information, see [Invalidating cached content](/cdn/docs/invalidating-cached-content). | | `patch` | `EXEC` | `project, urlMap` | Patches the specified UrlMap resource with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. | | `update` | `EXEC` | `project, urlMap` | Updates the specified UrlMap resource with the data included in the request. | diff --git a/docs/google-docs/providers/google/compute/url_maps_aggregated/index.md b/docs/google-docs/providers/google/compute/url_maps_aggregated/index.md index e305fc7c50..0d26e8e573 100644 --- a/docs/google-docs/providers/google/compute/url_maps_aggregated/index.md +++ b/docs/google-docs/providers/google/compute/url_maps_aggregated/index.md @@ -25,8 +25,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `hostRules` | `array` | The list of host rules to use against the URL. | +| `defaultUrlRedirect` | `object` | Specifies settings for an HTTP redirect. | +| `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. | +| `defaultRouteAction` | `object` | | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#urlMaps for url maps. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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. | +| `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. | +| `pathMatchers` | `array` | The list of named PathMatchers to use against the URL. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `aggregated_list` | `EXEC` | `project` | +| `aggregated_list` | `SELECT` | `project` | +| `_aggregated_list` | `EXEC` | `project` | 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 87c7b2b656..1c5b8a3d24 100644 --- a/docs/google-docs/providers/google/compute/vpn_gateways/index.md +++ b/docs/google-docs/providers/google/compute/vpn_gateways/index.md @@ -31,21 +31,21 @@ 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. | -| `vpnInterfaces` | `array` | The list of VPN interfaces associated with this VPN gateway. | | `kind` | `string` | [Output Only] Type of resource. Always compute#vpnGateway for VPN gateways. | -| `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | +| `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. | | `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 VPN gateway resides. | +| `vpnInterfaces` | `array` | The list of VPN interfaces associated with this VPN gateway. | | `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. | -| `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. | +| `region` | `string` | [Output Only] URL of the region where the VPN gateway resides. | | `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `network` | `string` | URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of VPN gateways. | | `get` | `SELECT` | `project, region, vpnGateway` | Returns the specified VPN gateway. | | `list` | `SELECT` | `project, region` | Retrieves a list of VPN gateways available to the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a VPN gateway in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, vpnGateway` | Deletes the specified VPN gateway. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of VPN gateways available to the specified project and region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of VPN gateways. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of VPN gateways. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on a VpnGateway. To learn more about labels, read the Labeling Resources documentation. | 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 4dd268172b..d8de7c9a0a 100644 --- a/docs/google-docs/providers/google/compute/vpn_tunnels/index.md +++ b/docs/google-docs/providers/google/compute/vpn_tunnels/index.md @@ -30,34 +30,34 @@ 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] 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. | | `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. | -| `detailedStatus` | `string` | [Output Only] Detailed status message for the VPN tunnel. | | `sharedSecretHash` | `string` | Hash of the shared secret. | | `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. | -| `sharedSecret` | `string` | Shared secret used to set the secure session between the Cloud VPN gateway and the peer VPN gateway. | -| `vpnGatewayInterface` | `integer` | The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. | -| `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. | +| `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. | +| `detailedStatus` | `string` | [Output Only] Detailed status message for the VPN tunnel. | +| `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. | | `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. | -| `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. | -| `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. | -| `router` | `string` | URL of the router resource to be used for dynamic routing. | -| `peerIp` | `string` | IP address of the peer VPN gateway. Only IPv4 is supported. | -| `kind` | `string` | [Output Only] Type of resource. Always compute#vpnTunnel for VPN tunnels. | | `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. | -| `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. | +| `peerGcpGateway` | `string` | URL of the peer side HA 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 Google Cloud 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. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `peerIp` | `string` | IP address of the peer VPN gateway. Only IPv4 is supported. | +| `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. | +| `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. | +| `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. | +| `vpnGatewayInterface` | `integer` | The interface ID of the VPN gateway with which this VPN tunnel is associated. Possible values are: `0`, `1`. | +| `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. | +| `router` | `string` | URL of the router resource to be used for dynamic routing. | | `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. | -| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `aggregated_list` | `SELECT` | `project` | Retrieves an aggregated list of VPN tunnels. | | `get` | `SELECT` | `project, region, vpnTunnel` | Returns the specified VpnTunnel resource. | | `list` | `SELECT` | `project, region` | Retrieves a list of VpnTunnel resources contained in the specified project and region. | | `insert` | `INSERT` | `project, region` | Creates a VpnTunnel resource in the specified project and region using the data included in the request. | | `delete` | `DELETE` | `project, region, vpnTunnel` | Deletes the specified VpnTunnel resource. | -| `_list` | `EXEC` | `project, region` | Retrieves a list of VpnTunnel resources contained in the specified project and region. | -| `aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of VPN tunnels. | +| `_aggregated_list` | `EXEC` | `project` | Retrieves an aggregated list of VPN tunnels. | | `set_labels` | `EXEC` | `project, region, resource` | Sets the labels on a VpnTunnel. To learn more about labels, read the Labeling Resources documentation. | 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 7f557efa7e..e0279f0c4d 100644 --- a/docs/google-docs/providers/google/compute/xpn_host/index.md +++ b/docs/google-docs/providers/google/compute/xpn_host/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. 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. | -| `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. | | `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | -| `usageExportLocation` | `object` | The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. | -| `defaultServiceAccount` | `string` | [Output Only] Default service account used by VMs running in this project. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | | `vmDnsSetting` | `string` | [Output Only] Default internal DNS setting used by VMs running in this project. | | `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `defaultServiceAccount` | `string` | [Output Only] Default service account 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. | +| `quotas` | `array` | [Output Only] Quotas assigned to this project. | +| `enabledFeatures` | `array` | Restricted features enabled for use on this project. | | `commonInstanceMetadata` | `object` | A metadata key/value entry. | +| `kind` | `string` | [Output Only] Type of the resource. Always compute#project for projects. | +| `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. | ## 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 8558aec854..3cf46d5546 100644 --- a/docs/google-docs/providers/google/compute/zone_operations/index.md +++ b/docs/google-docs/providers/google/compute/zone_operations/index.md @@ -30,33 +30,33 @@ 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. | -| `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. | -| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | -| `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. | -| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | -| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | -| `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. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `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. | -| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | | `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `error` | `object` | [Output Only] If errors 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. | +| `instancesBulkInsertOperationMetadata` | `object` | | | `httpErrorMessage` | `string` | [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. | +| `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. | +| `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. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | | `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. | -| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | | `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `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. | +| `region` | `string` | [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | +| `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | +| `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. | +| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | | `setCommonInstanceMetadataOperationMetadata` | `object` | | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `operation, project, zone` | Retrieves the specified zone-specific Operations resource. | | `list` | `SELECT` | `project, zone` | Retrieves a list of Operation resources contained within the specified zone. | | `delete` | `DELETE` | `operation, project, zone` | Deletes the specified zone-specific Operations resource. | -| `_list` | `EXEC` | `project, zone` | Retrieves a list of Operation resources contained within the specified zone. | | `wait` | `EXEC` | `operation, project, zone` | Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method waits for no more than the 2 minutes and then returns the current state of the operation, which might be `DONE` or still in progress. This method is called on a best-effort basis. Specifically: - In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds. - If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`. | diff --git a/docs/google-docs/providers/google/compute/zones/index.md b/docs/google-docs/providers/google/compute/zones/index.md index d1365a7802..7b40637255 100644 --- a/docs/google-docs/providers/google/compute/zones/index.md +++ b/docs/google-docs/providers/google/compute/zones/index.md @@ -30,17 +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` | [Output Only] Name of the resource. | | `description` | `string` | [Output Only] Textual description of the resource. | -| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | | `deprecated` | `object` | Deprecation status for a public resource. | | `kind` | `string` | [Output Only] Type of the resource. Always compute#zone for zones. | -| `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. | | `region` | `string` | [Output Only] Full URL reference to the region which hosts the zone. | +| `supportsPzs` | `boolean` | [Output Only] Reserved for future use. | +| `status` | `string` | [Output Only] Status of the zone, either UP or DOWN. | +| `creationTimestamp` | `string` | [Output Only] Creation timestamp in RFC3339 text format. | +| `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 | |:-----|:--------------|:----------------|:------------| | `get` | `SELECT` | `project, zone` | Returns the specified Zone resource. | | `list` | `SELECT` | `project` | Retrieves the list of Zone resources available to the specified project. | -| `_list` | `EXEC` | `project` | Retrieves the list of Zone resources available to the specified project. | diff --git a/docs/google-docs/providers/google/connectors/actions/index.md b/docs/google-docs/providers/google/connectors/actions/index.md index 1d0f6563c8..69ce0801b3 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. | -| `resultMetadata` | `array` | List containing the metadata of result fields. | | `inputParameters` | `array` | List containing input parameter metadata. | +| `resultMetadata` | `array` | List containing the metadata of result fields. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/connectors/index.md b/docs/google-docs/providers/google/connectors/index.md index 67e2b9fb9a..d55d5ee5c4 100644 --- a/docs/google-docs/providers/google/connectors/index.md +++ b/docs/google-docs/providers/google/connectors/index.md @@ -33,7 +33,7 @@ Enables Users To Create And Manage Connections To Google Cloud Services And Thir TypeService TitleConnectors API DescriptionEnables Users To Create And Manage Connections To Google Cloud Services And Third-Party Business Applications Using The Connectors Interface. -Idconnectors:v23.08.00161 +Idconnectors:v23.08.00163 ## Resources 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 43a0963673..dba8d47f79 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 | -| `createTime` | `string` | Output only. [Output only] Create time stamp | +| `samlParams` | `object` | Message storing SAML params to enable Google as IDP. | +| `ccaipManagedUsers` | `boolean` | Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity | +| `instanceConfig` | `object` | Message storing the instance configuration. | +| `displayName` | `string` | Required. A user friendly name for the ContactCenter. | | `labels` | `object` | Labels as key value pairs | +| `kmsKey` | `string` | Immutable. The KMS key name to encrypt the user input (`ContactCenter`). | +| `userEmail` | `string` | Optional. Email address of the first admin user. | +| `updateTime` | `string` | Output only. [Output only] Update time stamp | | `state` | `string` | Output only. The state of this contact center. | | `customerDomainPrefix` | `string` | Required. Immutable. At least 2 and max 16 char long, must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). | -| `samlParams` | `object` | Message storing SAML params to enable Google as IDP. | | `uris` | `object` | Message storing the URIs of the ContactCenter. | +| `createTime` | `string` | Output only. [Output only] Create time stamp | | `adminUser` | `object` | Message storing info about the first admin user. Next ID: 3 | -| `userEmail` | `string` | Optional. Email address of the first admin user. | -| `updateTime` | `string` | Output only. [Output only] Update time stamp | -| `instanceConfig` | `object` | Message storing the instance configuration. | -| `ccaipManagedUsers` | `boolean` | Optional. Whether to enable users to be created in the CCAIP-instance concurrently to having users in Cloud identity | -| `displayName` | `string` | Required. A user friendly name for the ContactCenter. | -| `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/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/index.md index 7df45c7220..7e92373e05 100644 --- a/docs/google-docs/providers/google/contactcenteraiplatform/index.md +++ b/docs/google-docs/providers/google/contactcenteraiplatform/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleContact Center AI Platform API Description -Idcontactcenteraiplatform:v23.08.00161 +Idcontactcenteraiplatform:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md b/docs/google-docs/providers/google/contactcenteraiplatform/locations/index.md index ef165f1769..b4c54b8339 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"` | -| `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/contactcenterinsights/analyses/index.md b/docs/google-docs/providers/google/contactcenterinsights/analyses/index.md index bb3e1f3fef..fdd4e081be 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} | +| `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 3401d2f28d..69aae73ec9 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} | -| `obfuscatedUserId` | `string` | Obfuscated user ID which the customer sent to us. | -| `latestAnalysis` | `object` | The analysis resource. | -| `turnCount` | `integer` | Output only. The number of turns in the conversation. | -| `createTime` | `string` | Output only. The time at which the conversation was created. | -| `latestSummary` | `object` | Conversation summarization suggestion data. | -| `expireTime` | `string` | The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. | -| `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} | | `duration` | `string` | Output only. The duration of the conversation. | -| `updateTime` | `string` | Output only. The most recent time at which the conversation was updated. | -| `languageCode` | `string` | A user-specified language code for the conversation. | | `startTime` | `string` | The time at which the conversation started. | -| `transcript` | `object` | A message representing the transcript of a conversation. | -| `runtimeAnnotations` | `array` | Output only. The annotations that were generated during the customer and agent interaction. | -| `callMetadata` | `object` | Call-specific metadata. | +| `languageCode` | `string` | A user-specified language code for the conversation. | +| `latestSummary` | `object` | Conversation summarization suggestion data. | | `dataSource` | `object` | The conversation source, which is a combination of transcript and audio. | -| `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. | | `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. | +| `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. | +| `updateTime` | `string` | Output only. The most recent time at which the conversation was updated. | +| `obfuscatedUserId` | `string` | Obfuscated user ID which the customer sent to us. | +| `expireTime` | `string` | The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted. | +| `turnCount` | `integer` | Output only. The number of turns in the conversation. | +| `transcript` | `object` | A message representing the transcript of a conversation. | +| `latestAnalysis` | `object` | The analysis resource. | | `ttl` | `string` | Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time. | +| `createTime` | `string` | Output only. The time at which the conversation was created. | +| `runtimeAnnotations` | `array` | Output only. The annotations that were generated during the customer and agent interaction. | +| `medium` | `string` | Immutable. The conversation medium, if unspecified will default to PHONE_CALL. | +| `callMetadata` | `object` | Call-specific metadata. | +| `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} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/index.md b/docs/google-docs/providers/google/contactcenterinsights/index.md index 26c99b7b5f..208a831536 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/index.md @@ -20,7 +20,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 9
-total selectable resources: 7
+total selectable resources: 8
total methods: 46
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleContact Center AI Insights API Description -Idcontactcenterinsights:v23.08.00161 +Idcontactcenterinsights:v23.08.00163 ## Resources 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/operations/index.md b/docs/google-docs/providers/google/contactcenterinsights/operations/index.md index 503dd3d3f6..190d85c652 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}`. | -| `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/contactcenterinsights/phrase_matchers/index.md b/docs/google-docs/providers/google/contactcenterinsights/phrase_matchers/index.md index 5748c26dd7..432ca6eacf 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} | +| `activationUpdateTime` | `string` | Output only. The most recent time at which the activation status was updated. | +| `active` | `boolean` | Applies the phrase matcher only when it is active. | +| `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. | +| `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. | +| `versionTag` | `string` | The customized version tag to use for the phrase matcher. If not specified, it will default to `revision_id`. | | `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 | | `type` | `string` | Required. The type of this phrase matcher. | -| `phraseMatchRuleGroups` | `array` | A list of phase match rule groups that are included in this matcher. | | `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. | | `revisionCreateTime` | `string` | Output only. The timestamp of when the revision was created. It is also the create time when a new matcher is added. | -| `displayName` | `string` | The human-readable name of the phrase matcher. | -| `active` | `boolean` | Applies the phrase matcher only when it is active. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contactcenterinsights/settings/index.md b/docs/google-docs/providers/google/contactcenterinsights/settings/index.md index 452f854ff9..4ae881d27a 100644 --- a/docs/google-docs/providers/google/contactcenterinsights/settings/index.md +++ b/docs/google-docs/providers/google/contactcenterinsights/settings/index.md @@ -25,9 +25,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. The resource name of the settings resource. Format: projects/{project}/locations/{location}/settings | +| `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. | +| `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} | +| `redactionConfig` | `object` | DLP resources used for redaction while ingesting conversations. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `get_settings` | `EXEC` | `locationsId, projectsId` | Gets project-level settings. | +| `get_settings` | `SELECT` | `locationsId, projectsId` | Gets project-level settings. | | `update_settings` | `EXEC` | `locationsId, projectsId` | Updates project-level settings. | diff --git a/docs/google-docs/providers/google/contactcenterinsights/views/index.md b/docs/google-docs/providers/google/contactcenterinsights/views/index.md index 37da402f83..4f992b9e8e 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} | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/container/clusters/index.md b/docs/google-docs/providers/google/container/clusters/index.md index 84effa3969..9e279666ea 100644 --- a/docs/google-docs/providers/google/container/clusters/index.md +++ b/docs/google-docs/providers/google/container/clusters/index.md @@ -27,12 +27,78 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `clusters` | `array` | A list of clusters in the project in the specified zone, or across all ones. | -| `missingZones` | `array` | If any zones are listed here, the list of clusters returned may be missing those zones. | +| `id` | `string` | Output only. Unique id for the cluster. | +| `name` | `string` | The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter. | +| `description` | `string` | An optional description of this cluster. | +| `resourceUsageExportConfig` | `object` | Configuration for exporting cluster resource usages. | +| `authenticatorGroupsConfig` | `object` | Configuration for returning group information from authenticators. | +| `autoscaling` | `object` | ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs. | +| `databaseEncryption` | `object` | Configuration of etcd encryption. | +| `monitoringService` | `string` | The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * `monitoring.googleapis.com` - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * `none` - No metrics will be exported from the cluster. If left as an empty string,`monitoring.googleapis.com/kubernetes` will be used for GKE 1.14+ or `monitoring.googleapis.com` for earlier versions. | +| `network` | `string` | The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. | +| `labelFingerprint` | `string` | The fingerprint of the set of labels for this cluster. | +| `costManagementConfig` | `object` | Configuration for fine-grained cost management feature. | +| `securityPostureConfig` | `object` | SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. | +| `identityServiceConfig` | `object` | IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API | +| `privateClusterConfig` | `object` | Configuration options for private clusters. | +| `nodeIpv4CidrSize` | `integer` | [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. | +| `locations` | `array` | The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. | +| `initialClusterVersion` | `string` | The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version | +| `conditions` | `array` | Which conditions caused the current cluster state. | +| `networkConfig` | `object` | NetworkConfig reports the relative names of network & subnetwork. | +| `autopilot` | `object` | Autopilot is the configuration for Autopilot settings on the cluster. | +| `monitoringConfig` | `object` | MonitoringConfig is cluster monitoring configuration. | +| `currentMasterVersion` | `string` | [Output only] The current software version of the master endpoint. | +| `ipAllocationPolicy` | `object` | Configuration for controlling how IPs are allocated in the cluster. | +| `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. | +| `nodePoolDefaults` | `object` | Subset of Nodepool message that has defaults. | +| `binaryAuthorization` | `object` | Configuration for Binary Authorization. | +| `resourceLabels` | `object` | The resource labels for the cluster to use to annotate any related Google Compute Engine resources. | +| `subnetwork` | `string` | The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. | +| `initialNodeCount` | `integer` | The number of nodes to create in this cluster. 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. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. | +| `maintenancePolicy` | `object` | MaintenancePolicy defines the maintenance policy to be used for the cluster. | +| `addonsConfig` | `object` | Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. | +| `workloadIdentityConfig` | `object` | Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. | +| `loggingService` | `string` | The logging service the cluster should use to write logs. Currently available options: * `logging.googleapis.com/kubernetes` - The Cloud Logging service with a Kubernetes-native resource model * `logging.googleapis.com` - The legacy Cloud Logging service (no longer available as of GKE 1.15). * `none` - no logs will be exported from the cluster. If left as an empty string,`logging.googleapis.com/kubernetes` will be used for GKE 1.14+ or `logging.googleapis.com` for earlier versions. | +| `defaultMaxPodsConstraint` | `object` | Constraints applied to pods. | +| `nodePools` | `array` | The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. | +| `verticalPodAutoscaling` | `object` | VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. | +| `zone` | `string` | [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. | +| `loggingConfig` | `object` | LoggingConfig is cluster logging configuration. | +| `servicesIpv4Cidr` | `string` | [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. | +| `confidentialNodes` | `object` | ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. | +| `createTime` | `string` | [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `selfLink` | `string` | [Output only] Server-defined URL for the resource. | +| `meshCertificates` | `object` | Configuration for issuance of mTLS keys and certificates to Kubernetes pods. | +| `etag` | `string` | This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. | +| `nodePoolAutoConfig` | `object` | Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. | +| `statusMessage` | `string` | [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. | +| `currentNodeVersion` | `string` | [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. | +| `fleet` | `object` | Fleet is the fleet configuration for the cluster. | +| `networkPolicy` | `object` | Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ | +| `tpuIpv4CidrBlock` | `string` | [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). | +| `enableK8sBetaApis` | `object` | K8sBetaAPIConfig , configuration for beta APIs | +| `legacyAbac` | `object` | Configuration for the legacy Attribute Based Access Control authorization mode. | +| `endpoint` | `string` | [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. | +| `expireTime` | `string` | [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `instanceGroupUrls` | `array` | Deprecated. Use node_pools.instance_group_urls. | +| `nodeConfig` | `object` | Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. | +| `notificationConfig` | `object` | NotificationConfig is the configuration of notifications. | +| `masterAuthorizedNetworksConfig` | `object` | Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs. | +| `clusterIpv4Cidr` | `string` | The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`). Leave blank to have one automatically chosen or specify a `/14` block in `10.0.0.0/8`. | +| `currentNodeCount` | `integer` | [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. | +| `enableKubernetesAlpha` | `boolean` | Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. | +| `shieldedNodes` | `object` | Configuration of Shielded Nodes feature. | +| `enableTpu` | `boolean` | Enable the ability to use Cloud TPUs in this cluster. | +| `status` | `string` | [Output only] The current status of this cluster. | +| `releaseChannel` | `object` | ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled. | +| `masterAuth` | `object` | The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_clusters_get` | `SELECT` | `clustersId, locationsId, projectsId` | Gets the details of a specific cluster. | | `projects_locations_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists all clusters owned by a project in either the specified zone or all zones. | +| `projects_zones_clusters_get` | `SELECT` | `clusterId, projectId, zone` | Gets the details of a specific cluster. | | `projects_zones_clusters_list` | `SELECT` | `projectId, zone` | Lists all clusters owned by a project in either the specified zone or all zones. | | `projects_locations_clusters_create` | `INSERT` | `locationsId, projectsId` | Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. | | `projects_zones_clusters_create` | `INSERT` | `projectId, zone` | Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using. | @@ -40,7 +106,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_zones_clusters_delete` | `DELETE` | `clusterId, projectId, zone` | Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created. | | `projects_locations_clusters_check_autopilot_compatibility` | `EXEC` | `clustersId, locationsId, projectsId` | Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues. | | `projects_locations_clusters_complete_ip_rotation` | `EXEC` | `clustersId, locationsId, projectsId` | Completes master IP rotation. | -| `projects_locations_clusters_get` | `EXEC` | `clustersId, locationsId, projectsId` | Gets the details of a specific cluster. | | `projects_locations_clusters_set_addons` | `EXEC` | `clustersId, locationsId, projectsId` | Sets the addons for a specific cluster. | | `projects_locations_clusters_set_legacy_abac` | `EXEC` | `clustersId, locationsId, projectsId` | Enables or disables the ABAC authorization mechanism on a cluster. | | `projects_locations_clusters_set_locations` | `EXEC` | `clustersId, locationsId, projectsId` | Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. | @@ -53,7 +118,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_clusters_start_ip_rotation` | `EXEC` | `clustersId, locationsId, projectsId` | Starts master IP rotation. | | `projects_locations_clusters_update` | `EXEC` | `clustersId, locationsId, projectsId` | Updates the settings of a specific cluster. | | `projects_zones_clusters_complete_ip_rotation` | `EXEC` | `clusterId, projectId, zone` | Completes master IP rotation. | -| `projects_zones_clusters_get` | `EXEC` | `clusterId, projectId, zone` | Gets the details of a specific cluster. | | `projects_zones_clusters_legacy_abac` | `EXEC` | `clusterId, projectId, zone` | Enables or disables the ABAC authorization mechanism on a cluster. | | `projects_zones_clusters_locations` | `EXEC` | `clusterId, projectId, zone` | Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters/update) instead. | | `projects_zones_clusters_logging` | `EXEC` | `clusterId, projectId, zone` | Sets the logging service for a specific cluster. | 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 665e12dc83..e6627ebe87 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 | |:-----|:---------|:------------| -| `keys` | `array` | The public component of the keys used by the cluster to sign token requests. | | `cacheHeader` | `object` | RFC-2616: cache control support | +| `keys` | `array` | The public component of the keys used by the cluster to sign token requests. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/container/index.md b/docs/google-docs/providers/google/container/index.md index b7f61b5dce..caf16a2fa1 100644 --- a/docs/google-docs/providers/google/container/index.md +++ b/docs/google-docs/providers/google/container/index.md @@ -33,7 +33,7 @@ Builds And Manages Container-Based Applications, Powered By The Open Source Kube TypeService TitleKubernetes Engine API DescriptionBuilds And Manages Container-Based Applications, Powered By The Open Source Kubernetes Technology. -Idcontainer:v23.08.00161 +Idcontainer:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/container/operations/index.md b/docs/google-docs/providers/google/container/operations/index.md index d4742b6ad8..cdcb5720e9 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. | -| `statusMessage` | `string` | Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. | -| `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). | -| `endTime` | `string` | [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `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` | | `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. | | `progress` | `object` | Information about operation (or operation stage) progress. | +| `statusMessage` | `string` | Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. | +| `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). | +| `status` | `string` | The current status of the operation. | | `clusterConditions` | `array` | Which conditions caused the current cluster state. Deprecated. Use field error instead. | -| `detail` | `string` | Detailed operation progress, if available. | | `startTime` | `string` | [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | -| `operationType` | `string` | The operation type. | -| `selfLink` | `string` | Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. | -| `nodepoolConditions` | `array` | Which conditions caused the current node pool 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` | | `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. | -| `status` | `string` | The current status of the operation. | +| `nodepoolConditions` | `array` | Which conditions caused the current node pool state. Deprecated. Use field error instead. | +| `endTime` | `string` | [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | +| `selfLink` | `string` | Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. | +| `detail` | `string` | Detailed operation progress, if available. | +| `operationType` | `string` | The operation type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/container/server_config/index.md b/docs/google-docs/providers/google/container/server_config/index.md index ba807334b6..29be125126 100644 --- a/docs/google-docs/providers/google/container/server_config/index.md +++ b/docs/google-docs/providers/google/container/server_config/index.md @@ -27,12 +27,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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..8304dd92e1 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 | |:-----|:---------|:------------| +| `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. | | `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. | ## 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 82d9e2a158..37e7813876 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,7 +27,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `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 | @@ -35,6 +34,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `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/index.md b/docs/google-docs/providers/google/containeranalysis/index.md index cb511f8b1d..a275c36d54 100644 --- a/docs/google-docs/providers/google/containeranalysis/index.md +++ b/docs/google-docs/providers/google/containeranalysis/index.md @@ -33,7 +33,7 @@ An Implementation Of The Grafeas API, Which Stores, And Enables Querying And Ret TypeService TitleContainer Analysis API DescriptionAn Implementation Of The Grafeas API, Which Stores, And Enables Querying And Retrieval Of Critical Metadata About All Of Your Software Artifacts. -Idcontaineranalysis:v23.08.00161 +Idcontaineranalysis:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/containeranalysis/notes/index.md b/docs/google-docs/providers/google/containeranalysis/notes/index.md index 06b40c8b72..2c9d0f34bc 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]`. | +| `relatedUrl` | `array` | URLs associated with this note. | +| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | | `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. | +| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | +| `package` | `object` | PackageNote represents a particular package version. | +| `compliance` | `object` | | +| `sbomReference` | `object` | The note representing an SBOM reference. | +| `deployment` | `object` | An artifact that can be deployed in some runtime. | +| `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. | | `shortDescription` | `string` | A one sentence description of 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. | -| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | -| `dsseAttestation` | `object` | | -| `relatedUrl` | `array` | URLs associated with this note. | -| `longDescription` | `string` | A detailed 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. | | `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. | | `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. | -| `compliance` | `object` | | -| `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. | -| `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. | -| `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | -| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | +| `dsseAttestation` | `object` | | +| `longDescription` | `string` | A detailed description of this note. | | `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | -| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | +| `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_iam_policies/index.md b/docs/google-docs/providers/google/containeranalysis/notes_iam_policies/index.md index 3d5ea59c95..c52ebf92a5 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 | |:-----|:---------|:------------| -| `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/index.md b/docs/google-docs/providers/google/containeranalysis/occurrences/index.md index c96d2c431c..258c75b375 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]`. | +| `deployment` | `object` | The period during which some deployable was active in a runtime. | +| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | +| `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. | +| `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. | | `build` | `object` | Details of a build occurrence. | -| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | +| `remediation` | `string` | A description of actions that can be taken to remedy the note. | | `updateTime` | `string` | Output only. The time this occurrence was last updated. | -| `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | | `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | -| `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. | -| `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. | | `createTime` | `string` | Output only. The time this occurrence was created. | +| `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. | -| `remediation` | `string` | A description of actions that can be taken to remedy the note. | -| `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. | -| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | -| `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. | -| `deployment` | `object` | The period during which some deployable was active in a runtime. | -| `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. | -| `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | +| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | | `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. | +| `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. | | `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | +| `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | +| `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | ## 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 4be28edcad..d1324aa8d5 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]`. | -| `sbomReference` | `object` | The note representing an SBOM reference. | -| `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | -| `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | +| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | +| `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. | | `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. | | `vulnerability` | `object` | A security vulnerability that can be found in resources. | -| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | -| `vulnerabilityAssessment` | `object` | A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. | +| `compliance` | `object` | | +| `createTime` | `string` | Output only. The time this note was created. This field can be used as a filter in list requests. | | `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. | -| `relatedNoteNames` | `array` | Other notes related to this note. | | `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. | -| `dsseAttestation` | `object` | | +| `relatedNoteNames` | `array` | Other notes related to this note. | +| `updateTime` | `string` | Output only. The time this note was last updated. This field can be used as a filter in list requests. | +| `build` | `object` | Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. | +| `shortDescription` | `string` | A one sentence description of this note. | +| `deployment` | `object` | An artifact that can be deployed in some runtime. | +| `kind` | `string` | Output only. The type of analysis. This field can be used as a filter in list requests. | +| `relatedUrl` | `array` | URLs associated with this note. | | `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. | +| `sbomReference` | `object` | The note representing an SBOM reference. | +| `dsseAttestation` | `object` | | | `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. | | `expirationTime` | `string` | Time of expiration for this note. Empty if note does not expire. | -| `compliance` | `object` | | -| `relatedUrl` | `array` | URLs associated with this note. | -| `shortDescription` | `string` | A one sentence description of this note. | -| `deployment` | `object` | An artifact that can be deployed in some runtime. | ## 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 4ab78c9761..6e5b8f71a0 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. | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/contentwarehouse/index.md b/docs/google-docs/providers/google/contentwarehouse/index.md index f040901e52..e96957197f 100644 --- a/docs/google-docs/providers/google/contentwarehouse/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/index.md @@ -20,7 +20,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 12
-total selectable resources: 4
+total selectable resources: 5
total methods: 39
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleDocument AI Warehouse API Description -Idcontentwarehouse:v23.08.00161 +Idcontentwarehouse:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/contentwarehouse/operations/index.md b/docs/google-docs/providers/google/contentwarehouse/operations/index.md index d4f31bc777..6a07eab54d 100644 --- a/docs/google-docs/providers/google/contentwarehouse/operations/index.md +++ b/docs/google-docs/providers/google/contentwarehouse/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.contentwarehouse.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}`. | +| `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 | |:-----|:--------------|:----------------| 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 23a1467cbb..1b54832179 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. | -| `rules` | `array` | List of rules given by the customer. | | `source` | `string` | Source of the rules i.e., customer name. | +| `rules` | `array` | List of rules given by the customer. | ## 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 f4a294a4bc..98d88a3906 100644 --- a/docs/google-docs/providers/google/datacatalog/entries/index.md +++ b/docs/google-docs/providers/google/datacatalog/entries/index.md @@ -29,42 +29,42 @@ 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. | -| `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. | -| `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. | -| `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. | -| `businessContext` | `object` | Business Context of the entry. | -| `cloudBigtableSystemSpec` | `object` | Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type) | | `filesetSpec` | `object` | Specification that applies to a fileset. Valid only for entries with the 'FILESET' type. | +| `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. | +| `sqlDatabaseSystemSpec` | `object` | Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_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). | | `schema` | `object` | Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. | -| `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. | | `modelSpec` | `object` | Specification that applies to a model. Valid only for entries with the `MODEL` type. | -| `lookerSystemSpec` | `object` | Specification that applies to entries that are part `LOOKER` system (user_specified_type) | -| `serviceSpec` | `object` | Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type. | -| `datasetSpec` | `object` | Specification that applies to a dataset. Valid only for entries with the `DATASET` type. | +| `databaseTableSpec` | `object` | Specification that applies to a table resource. Valid only for entries with the `TABLE` type. | +| `dataSource` | `object` | Physical location of an entry. | | `routineSpec` | `object` | Specification that applies to a routine. Valid only for entries with the `ROUTINE` type. | -| `sourceSystemTimestamps` | `object` | Timestamps associated with this resource in a particular system. | -| `sqlDatabaseSystemSpec` | `object` | Specification that applies to entries that are part `SQL_DATABASE` system (user_specified_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. | -| `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. | +| `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. | +| `displayName` | `string` | Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. | +| `cloudBigtableSystemSpec` | `object` | Specification that applies to all entries that are part of `CLOUD_BIGTABLE` system (user_specified_type) | | `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. | -| `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). | +| `businessContext` | `object` | Business Context of the entry. | +| `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. | | `bigqueryTableSpec` | `object` | Describes a BigQuery table. | -| `databaseTableSpec` | `object` | Specification that applies to a table resource. Valid only for entries with the `TABLE` type. | -| `displayName` | `string` | Display name of an entry. The maximum size is 500 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. | -| `personalDetails` | `object` | Entry metadata relevant only to the user and private to them. | +| `serviceSpec` | `object` | Specification that applies to a Service resource. Valid only for entries with the `SERVICE` type. | +| `sourceSystemTimestamps` | `object` | Timestamps associated with this resource in a particular system. | | `type` | `string` | The type of the entry. For details, see [`EntryType`](#entrytype). | -| `integratedSystem` | `string` | Output only. Indicates the entry's source system that Data Catalog integrates with, such as BigQuery, Pub/Sub, or Dataproc Metastore. | +| `lookerSystemSpec` | `object` | Specification that applies to entries that are part `LOOKER` system (user_specified_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. | +| `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. | +| `datasetSpec` | `object` | Specification that applies to a dataset. Valid only for entries with the `DATASET` type. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_entry_groups_entries_get` | `SELECT` | `entriesId, entryGroupsId, locationsId, projectsId` | Gets an entry. | | `projects_locations_entry_groups_entries_list` | `SELECT` | `entryGroupsId, locationsId, projectsId` | Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog. | | `projects_locations_entry_groups_entries_create` | `INSERT` | `entryGroupsId, locationsId, projectsId` | Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). An entry group can have a maximum of 100,000 entries. | | `projects_locations_entry_groups_entries_delete` | `DELETE` | `entriesId, entryGroupsId, locationsId, projectsId` | Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). | | `_projects_locations_entry_groups_entries_list` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog. | | `entries_lookup` | `EXEC` | | Gets an entry by its target resource name. The resource name comes from the source Google Cloud Platform service. | -| `projects_locations_entry_groups_entries_get` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | Gets an entry. | | `projects_locations_entry_groups_entries_import` | `EXEC` | `entryGroupsId, locationsId, projectsId` | Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog. `ImportEntries` accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type. `ImportEntries` returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message. | | `projects_locations_entry_groups_entries_modify_entry_contacts` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | Modifies contacts, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateContacts` IAM permission on the corresponding project. | | `projects_locations_entry_groups_entries_modify_entry_overview` | `EXEC` | `entriesId, entryGroupsId, locationsId, projectsId` | Modifies entry overview, part of the business context of an Entry. To call this method, you must have the `datacatalog.entries.updateOverview` IAM permission on the corresponding project. | 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 d0b5a29ebf..a7b4510833 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/index.md b/docs/google-docs/providers/google/datacatalog/index.md index 3a08e980bf..ca0f0e1257 100644 --- a/docs/google-docs/providers/google/datacatalog/index.md +++ b/docs/google-docs/providers/google/datacatalog/index.md @@ -20,7 +20,7 @@ A Fully Managed And Highly Scalable Data Discovery And Metadata Management Servi
total resources: 15
-total selectable resources: 11
+total selectable resources: 12
total methods: 73
@@ -33,7 +33,7 @@ A Fully Managed And Highly Scalable Data Discovery And Metadata Management Servi TypeService TitleGoogle Cloud Data Catalog API DescriptionA Fully Managed And Highly Scalable Data Discovery And Metadata Management Service. -Iddatacatalog:v23.08.00161 +Iddatacatalog:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datacatalog/operations/index.md b/docs/google-docs/providers/google/datacatalog/operations/index.md index ace634a146..933bab0f32 100644 --- a/docs/google-docs/providers/google/datacatalog/operations/index.md +++ b/docs/google-docs/providers/google/datacatalog/operations/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, 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/datacatalog/policy_tags/index.md b/docs/google-docs/providers/google/datacatalog/policy_tags/index.md index 8f2d296c72..99b161c186 100644 --- a/docs/google-docs/providers/google/datacatalog/policy_tags/index.md +++ b/docs/google-docs/providers/google/datacatalog/policy_tags/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Resource name of this policy tag in the URL format. The policy tag manager generates unique taxonomy IDs and policy tag IDs. | | `description` | `string` | Description of this policy tag. 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. | -| `displayName` | `string` | Required. User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8. | | `parentPolicyTag` | `string` | Resource name of this policy tag's parent policy tag. If empty, this is a top level tag. If not set, defaults to an empty string. For example, for the "LatLong" policy tag in the example above, this field contains the resource name of the "Geolocation" policy tag, and, for "Geolocation", this field is empty. | | `childPolicyTags` | `array` | Output only. Resource names of child policy tags of this policy tag. | +| `displayName` | `string` | Required. User-defined name of this policy tag. The name can't start or end with spaces and must be unique within the parent taxonomy, contain only Unicode letters, numbers, underscores, dashes and spaces, and be at most 200 bytes long when encoded in UTF-8. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datacatalog/tag_templates/index.md b/docs/google-docs/providers/google/datacatalog/tag_templates/index.md index 90ab67903d..7c3e6a10bb 100644 --- a/docs/google-docs/providers/google/datacatalog/tag_templates/index.md +++ b/docs/google-docs/providers/google/datacatalog/tag_templates/index.md @@ -25,11 +25,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The resource name of the tag template in URL format. Note: The tag template itself and its child resources might not be stored in the location specified in its name. | +| `fields` | `object` | Required. Map of tag template field IDs to the settings for the field. This map is an exhaustive list of the allowed fields. The map must contain at least one field and at most 500 fields. The keys to this map are tag template field IDs. The IDs have the following limitations: * Can contain uppercase and lowercase letters, numbers (0-9) and underscores (_). * Must be at least 1 character and at most 64 characters long. * Must start with a letter or underscore. | +| `isPubliclyReadable` | `boolean` | Indicates whether tags created with this template are public. Public tags do not require tag template access to appear in ListTags API response. Additionally, you can search for a public tag by value with a simple search query in addition to using a ``tag:`` predicate. | +| `displayName` | `string` | Display name for this template. Defaults to an empty string. The name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), and can't start or end with spaces. The maximum length is 200 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_tag_templates_get` | `SELECT` | `locationsId, projectsId, tagTemplatesId` | Gets a tag template. | | `projects_locations_tag_templates_create` | `INSERT` | `locationsId, projectsId` | Creates a tag template. You must enable the Data Catalog API in the project identified by the `parent` parameter. For more information, see [Data Catalog resource project] (https://cloud.google.com/data-catalog/docs/concepts/resource-project). | | `projects_locations_tag_templates_delete` | `DELETE` | `locationsId, projectsId, tagTemplatesId` | Deletes a tag template and all tags that use it. You must enable the Data Catalog API in the project identified by the `name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). | -| `projects_locations_tag_templates_get` | `EXEC` | `locationsId, projectsId, tagTemplatesId` | Gets a tag template. | | `projects_locations_tag_templates_patch` | `EXEC` | `locationsId, projectsId, tagTemplatesId` | Updates a tag template. You can't update template fields with this method. These fields are separate resources with their own create, update, and delete methods. You must enable the Data Catalog API in the project identified by the `tag_template.name` parameter. For more information, see [Data Catalog resource project](https://cloud.google.com/data-catalog/docs/concepts/resource-project). | diff --git a/docs/google-docs/providers/google/datacatalog/tags/index.md b/docs/google-docs/providers/google/datacatalog/tags/index.md index eced20aa06..1449151e5e 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. | -| `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. | | `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. | ## 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 d7a2145079..6a1a9c568a 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. | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataflow/index.md b/docs/google-docs/providers/google/dataflow/index.md index 4307cca154..e313c2ff31 100644 --- a/docs/google-docs/providers/google/dataflow/index.md +++ b/docs/google-docs/providers/google/dataflow/index.md @@ -33,7 +33,7 @@ Manages Google Cloud Dataflow Projects On Google Cloud Platform. TypeService TitleDataflow API DescriptionManages Google Cloud Dataflow Projects On Google Cloud Platform. -Iddataflow:v23.08.00161 +Iddataflow:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/dataflow/jobs/index.md b/docs/google-docs/providers/google/dataflow/jobs/index.md index b4899bda0b..8f6360b212 100644 --- a/docs/google-docs/providers/google/dataflow/jobs/index.md +++ b/docs/google-docs/providers/google/dataflow/jobs/index.md @@ -29,43 +29,43 @@ 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])?` | -| `environment` | `object` | Describes the environment in which a Dataflow Job runs. | -| `type` | `string` | The type of Cloud Dataflow 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} | +| `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. | | `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. | -| `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. | -| `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. | -| `jobMetadata` | `object` | Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. | -| `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. | -| `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. | -| `stepsLocation` | `string` | The Cloud Storage location where the steps are stored. | -| `executionInfo` | `object` | Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. | -| `projectId` | `string` | The ID of the Cloud Platform project that the job belongs to. | | `location` | `string` | The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. | -| `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. | -| `createTime` | `string` | The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. | -| `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. | | `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. | -| `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. | +| `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. | +| `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. | | `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. | +| `type` | `string` | The type of Cloud Dataflow job. | +| `projectId` | `string` | The ID of the Cloud Platform project that the job belongs to. | +| `environment` | `object` | Describes the environment in which a Dataflow Job runs. | | `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. | -| `transformNameMapping` | `object` | The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. | -| `currentStateTime` | `string` | The timestamp associated with the current state. | -| `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} | +| `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. | +| `createTime` | `string` | The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. | +| `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. | +| `jobMetadata` | `object` | Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. | +| `executionInfo` | `object` | Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. | | `stageStates` | `array` | This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. | +| `stepsLocation` | `string` | The Cloud Storage location where the steps are stored. | +| `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. | +| `currentStateTime` | `string` | The timestamp associated with the current state. | +| `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. | +| `transformNameMapping` | `object` | The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_jobs_get` | `SELECT` | `jobId, projectId` | Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. | | `projects_jobs_list` | `SELECT` | `projectId` | List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. | +| `projects_locations_jobs_get` | `SELECT` | `jobId, location, projectId` | Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. | | `projects_locations_jobs_list` | `SELECT` | `location, projectId` | List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. | | `projects_jobs_create` | `INSERT` | `projectId` | Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. Do not enter confidential information when you supply string values using the API. | | `projects_locations_jobs_create` | `INSERT` | `location, projectId` | Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. Do not enter confidential information when you supply string values using the API. | | `_projects_jobs_list` | `EXEC` | `projectId` | List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. | | `_projects_locations_jobs_list` | `EXEC` | `location, projectId` | List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, because you can only get the list of jobs that are running in `us-central1`. `projects.locations.jobs.list` and `projects.jobs.list` support filtering the list of jobs by name. Filtering by name isn't supported by `projects.jobs.aggregated`. | | `projects_jobs_aggregated` | `EXEC` | `projectId` | List the jobs of a project across all regions. **Note:** This method doesn't support filtering the list of jobs by name. | -| `projects_jobs_get` | `EXEC` | `jobId, projectId` | Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. | | `projects_jobs_snapshot` | `EXEC` | `jobId, projectId` | Snapshot the state of a streaming job. | | `projects_jobs_update` | `EXEC` | `jobId, projectId` | Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. | -| `projects_locations_jobs_get` | `EXEC` | `jobId, location, projectId` | Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. | | `projects_locations_jobs_snapshot` | `EXEC` | `jobId, location, projectId` | Snapshot the state of a streaming job. | | `projects_locations_jobs_update` | `EXEC` | `jobId, location, projectId` | Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. | 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 f16dfcef86..d702163818 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 | |:-----|:---------|:------------| -| `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. | +| `state` | `string` | State of this stage. | +| `stragglerSummary` | `object` | Summarized straggler identification details. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dataflow/jobs_metrics/index.md b/docs/google-docs/providers/google/dataflow/jobs_metrics/index.md index 2f16724957..1c2a202efb 100644 --- a/docs/google-docs/providers/google/dataflow/jobs_metrics/index.md +++ b/docs/google-docs/providers/google/dataflow/jobs_metrics/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `metrics` | `array` | All metrics for this job. | | `metricTime` | `string` | Timestamp as of which metric values are current. | +| `metrics` | `array` | All metrics for this job. | ## 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/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 bc2c3e3614..a0b616abae 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 | |:-----|:---------|:------------| -| `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. | +| `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. | ## 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 545b2c74da..081004dc42 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. | +| `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. | | `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/index.md b/docs/google-docs/providers/google/dataform/index.md index 35b4b87155..a1767a6f75 100644 --- a/docs/google-docs/providers/google/dataform/index.md +++ b/docs/google-docs/providers/google/dataform/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleDataform API Description -Iddataform:v23.08.00161 +Iddataform:v23.08.00163 ## Resources 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 22316524b2..3b93be84c1 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. | +| `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. | | `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. | ## 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 30de2d6659..db155d9c3a 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. | +| `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. | | `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. | ## 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 da1dd17519..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. | +| `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/*`. | -| `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. | ## 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 70408a12a1..79125c1a24 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. | -| `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. | | `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/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md b/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md index 40e95f6f15..ee9b55f1fd 100644 --- a/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataform/workspaces_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/index.md b/docs/google-docs/providers/google/datafusion/index.md index c772a72b84..1cc5e19069 100644 --- a/docs/google-docs/providers/google/datafusion/index.md +++ b/docs/google-docs/providers/google/datafusion/index.md @@ -33,7 +33,7 @@ Cloud Data Fusion Is A Fully-Managed, Cloud Native, Enterprise Data Integration TypeService TitleCloud Data Fusion API DescriptionCloud Data Fusion Is A Fully-Managed, Cloud Native, Enterprise Data Integration Service For Quickly Building And Managing Data Pipelines. It Provides A Graphical Interface To Increase Time Efficiency And Reduce Complexity, And Allows Business Users, Developers, And Data Scientists To Easily And Reliably Build Scalable Data Integration Solutions To Cleanse, Prepare, Blend, Transfer And Transform Data Without Having To Wrestle With Infrastructure. -Iddatafusion:v23.08.00161 +Iddatafusion:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datafusion/instances/index.md b/docs/google-docs/providers/google/datafusion/instances/index.md index d40852691a..a8fed71d86 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. | +| `enableRbac` | `boolean` | Option to enable granular role-based access control. | +| `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. | +| `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. | +| `updateTime` | `string` | Output only. The time the instance was last updated. | +| `enableZoneSeparation` | `boolean` | Option to enable granular zone separation. | | `displayName` | `string` | Display name for an instance. | +| `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. | +| `serviceEndpoint` | `string` | Output only. Endpoint on which the Data Fusion UI is accessible. | +| `serviceAccount` | `string` | Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. | +| `eventPublishConfig` | `object` | Confirguration of PubSubEventWriter. | | `p4ServiceAccount` | `string` | Output only. P4 service account for the customer project. | +| `type` | `string` | Required. Instance type. | +| `options` | `object` | Map of additional options used to configure the behavior of Data Fusion instance. | +| `accelerators` | `array` | Output only. List of accelerators enabled for this CDF instance. | +| `disabledReason` | `array` | Output only. If the instance state is DISABLED, the reason for disabling the instance. | +| `cryptoKeyConfig` | `object` | The crypto key configuration. This field is used by the Customer-managed encryption keys (CMEK) feature. | +| `tenantProjectId` | `string` | Output only. The name of the tenant project. | | `availableVersion` | `array` | Output only. Available versions that the instance can be upgraded to using UpdateInstanceRequest. | -| `enableZoneSeparation` | `boolean` | Option to enable granular zone separation. | +| `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. | | `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `enableStackdriverLogging` | `boolean` | Option to enable Stackdriver Logging. | -| `stateMessage` | `string` | Output only. Additional information about the current state of this Data Fusion instance if available. | | `enableStackdriverMonitoring` | `boolean` | Option to enable Stackdriver Monitoring. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `enableStackdriverLogging` | `boolean` | Option to enable Stackdriver Logging. | | `apiEndpoint` | `string` | Output only. Endpoint on which the REST APIs is accessible. | -| `zone` | `string` | Name of the zone in which the Data Fusion instance will be created. Only DEVELOPER instances use this field. | -| `type` | `string` | Required. Instance type. | -| `options` | `object` | Map of additional options used to configure the behavior of Data Fusion instance. | -| `updateTime` | `string` | Output only. The time the instance was last updated. | +| `stateMessage` | `string` | Output only. Additional information about the current state of this Data Fusion instance if available. | | `version` | `string` | Current version of the Data Fusion. Only specifiable in Update. | | `gcsBucket` | `string` | Output only. Cloud Storage bucket generated by Data Fusion in the customer project. | -| `tenantProjectId` | `string` | Output only. The name of the tenant project. | -| `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. | -| `eventPublishConfig` | `object` | Confirguration of PubSubEventWriter. | -| `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. | -| `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. | -| `serviceAccount` | `string` | Output only. Deprecated. Use tenant_project_id instead to extract the tenant project ID. | | `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. | -| `createTime` | `string` | Output only. The time the instance was created. | -| `state` | `string` | Output only. The current state of this Data Fusion instance. | -| `accelerators` | `array` | Output only. List of accelerators enabled for this CDF instance. | -| `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. | -| `serviceEndpoint` | `string` | Output only. Endpoint on which the Data Fusion UI is accessible. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datafusion/locations/index.md b/docs/google-docs/providers/google/datafusion/locations/index.md index 6ea79549bc..e845ab0735 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"` | +| `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/datafusion/versions/index.md b/docs/google-docs/providers/google/datafusion/versions/index.md index cb1aafdc9b..9bafd52689 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 | |:-----|:---------|:------------| +| `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 | | `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. | ## 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 d3ec07135e..9fb58fc15d 100644 --- a/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md +++ b/docs/google-docs/providers/google/datalabeling/annotated_datasets/index.md @@ -29,15 +29,15 @@ 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. | -| `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. | | `exampleCount` | `string` | Output only. Number of examples in the annotated dataset. | -| `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. | | `metadata` | `object` | Metadata on AnnotatedDataset. | | `annotationSource` | `string` | Output only. Source of the annotation. | +| `blockingResources` | `array` | Output only. The names of any related resources that are blocking changes to the annotated dataset. | | `createTime` | `string` | Output only. Time the AnnotatedDataset was created. | -| `labelStats` | `object` | Statistics about annotation specs. | | `annotationType` | `string` | Output only. Type of the annotation. It is specified when starting labeling task. | +| `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. | +| `labelStats` | `object` | Statistics about annotation specs. | ## 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 d913bd122d..491e844720 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/data_items/index.md b/docs/google-docs/providers/google/datalabeling/data_items/index.md index 185e7a0fb8..43ae470c30 100644 --- a/docs/google-docs/providers/google/datalabeling/data_items/index.md +++ b/docs/google-docs/providers/google/datalabeling/data_items/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 data item, in format of: projects/{project_id}/datasets/{dataset_id}/dataItems/{data_item_id} | +| `textPayload` | `object` | Container of information about a piece of text. | | `videoPayload` | `object` | Container of information of a video. | | `imagePayload` | `object` | Container of information about an image. | -| `textPayload` | `object` | Container of information about a piece of text. | ## 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 e6d82479b8..7f9b9c3197 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. | -| `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. | +| `displayName` | `string` | Required. The display name of the dataset. Maximum of 64 characters. | ## 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 e2e8497246..9ec07d9385 100644 --- a/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md +++ b/docs/google-docs/providers/google/datalabeling/evaluation_jobs/index.md @@ -29,14 +29,14 @@ 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. | -| `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. | -| `state` | `string` | Output only. Describes the current state of the job. | -| `attempts` | `array` | Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array. | -| `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}" | | `createTime` | `string` | Output only. Timestamp of when this evaluation job was created. | +| `state` | `string` | Output only. Describes the current state of the job. | | `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. | +| `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}" | +| `evaluationJobConfig` | `object` | Configures specific details of how a continuous evaluation job works. Provide this configuration when you create an EvaluationJob. | +| `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. | +| `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`. | +| `attempts` | `array` | Output only. Every time the evaluation job runs and an error occurs, the failed attempt is appended to this array. | ## 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 9b2fcc94ab..d409153a1b 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}' | -| `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` | | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/examples/index.md b/docs/google-docs/providers/google/datalabeling/examples/index.md index 288aa5ba31..1bc2d0ef5c 100644 --- a/docs/google-docs/providers/google/datalabeling/examples/index.md +++ b/docs/google-docs/providers/google/datalabeling/examples/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Name of the example, in format of: projects/{project_id}/datasets/{dataset_id}/annotatedDatasets/ {annotated_dataset_id}/examples/{example_id} | +| `imagePayload` | `object` | Container of information about an image. | | `textPayload` | `object` | Container of information about a piece of text. | | `videoPayload` | `object` | Container of information of a video. | | `annotations` | `array` | Output only. Annotations for the piece of data in Example. One piece of data can have multiple annotations. | -| `imagePayload` | `object` | Container of information about an image. | ## 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 5ddb2ce513..c15170401a 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}' | -| `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. | +| `image` | `string` | The image storing this feedback if the feedback is an image representing operator's comments. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalabeling/index.md b/docs/google-docs/providers/google/datalabeling/index.md index b5a0bab500..b89045ad95 100644 --- a/docs/google-docs/providers/google/datalabeling/index.md +++ b/docs/google-docs/providers/google/datalabeling/index.md @@ -33,7 +33,7 @@ Public API For Google Cloud AI Data Labeling Service. TypeService TitleData Labeling API DescriptionPublic API For Google Cloud AI Data Labeling Service. -Iddatalabeling:v23.08.00161 +Iddatalabeling:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datalabeling/instructions/index.md b/docs/google-docs/providers/google/datalabeling/instructions/index.md index e9cea3688b..4ec4b751a5 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. | -| `updateTime` | `string` | Output only. Last update time of instruction. | -| `dataType` | `string` | Required. The data type of this 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. | +| `updateTime` | `string` | Output only. Last update time of instruction. | +| `displayName` | `string` | Required. The display name of the instruction. Maximum of 64 characters. | +| `csvInstruction` | `object` | Deprecated: this instruction format is not supported any more. Instruction from a CSV file. | | `createTime` | `string` | Output only. Creation 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 4e4eb11a0d..d3c3e664a7 100644 --- a/docs/google-docs/providers/google/datalabeling/operations/index.md +++ b/docs/google-docs/providers/google/datalabeling/operations/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, 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 | |:-----|:--------------|:----------------|:------------| +| `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. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_operations_delete` | `DELETE` | `operationsId, projectsId` | 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`. | | `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `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. 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`. | -| `projects_operations_get` | `EXEC` | `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. | diff --git a/docs/google-docs/providers/google/datalineage/index.md b/docs/google-docs/providers/google/datalineage/index.md index 4f93660a26..00e9963efa 100644 --- a/docs/google-docs/providers/google/datalineage/index.md +++ b/docs/google-docs/providers/google/datalineage/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 5
total selectable resources: 4
-total methods: 24
+total methods: 25
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleData Lineage API Description -Iddatalineage:v23.08.00161 +Iddatalineage:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datalineage/lineage_events/index.md b/docs/google-docs/providers/google/datalineage/lineage_events/index.md index b136660155..19947cd7f0 100644 --- a/docs/google-docs/providers/google/datalineage/lineage_events/index.md +++ b/docs/google-docs/providers/google/datalineage/lineage_events/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 event. Format: `projects/{project}/locations/{location}/processes/{process}/runs/{run}/lineageEvents/{lineage_event}`. Can be specified or auto-assigned. {lineage_event} must be not longer than 200 characters and only contain characters in a set: `a-zA-Z0-9_-:.` | +| `startTime` | `string` | Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported. | | `endTime` | `string` | Optional. The end of the transformation which resulted in this lineage event. For streaming scenarios, it should be the end of the period from which the lineage is being reported. | | `links` | `array` | Optional. List of source-target pairs. Can't contain more than 100 tuples. | -| `startTime` | `string` | Required. The beginning of the transformation which resulted in this lineage event. For streaming scenarios, it should be the beginning of the period from which the lineage is being reported. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datalineage/locations/index.md b/docs/google-docs/providers/google/datalineage/locations/index.md index 3efeeaf0cf..b2bf1da6c6 100644 --- a/docs/google-docs/providers/google/datalineage/locations/index.md +++ b/docs/google-docs/providers/google/datalineage/locations/index.md @@ -30,4 +30,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `batch_search_link_processes` | `EXEC` | `locationsId, projectsId` | Retrieve information about LineageProcesses associated with specific links. LineageProcesses are transformation pipelines that result in data flowing from **source** to **target** assets. Links between assets represent this operation. If you have specific link names, you can use this method to verify which LineageProcesses contribute to creating those links. See the SearchLinks method for more information on how to retrieve link name. You can retrieve the LineageProcess information in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota. | +| `process_open_lineage_run_event` | `EXEC` | `locationsId, projectsId` | Creates new lineage events together with their parents: process and run. Updates the process and run if they already exist. Mapped from Open Lineage specification: https://github.com/OpenLineage/OpenLineage/blob/main/spec/OpenLineage.json. | | `search_links` | `EXEC` | `locationsId, projectsId` | Retrieve a list of links connected to a specific asset. Links represent the data flow between **source** (upstream) and **target** (downstream) assets in transformation pipelines. Links are stored in the same project as the Lineage Events that create them. You can retrieve links in every project where you have the `datalineage.events.get` permission. The project provided in the URL is used for Billing and Quota. | diff --git a/docs/google-docs/providers/google/datalineage/operations/index.md b/docs/google-docs/providers/google/datalineage/operations/index.md index 624ee2f5fe..de9696c292 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}`. | +| `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 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/datalineage/processes/index.md b/docs/google-docs/providers/google/datalineage/processes/index.md index 03c61f8ace..3afcf249d8 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_-:.` | +| `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. | | `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 `_-:&.` | ## 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 02ad110ed9..169e1c5a1d 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}. | +| `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". | +| `cloudsql` | `object` | Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. | +| `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" }`. | +| `alloydb` | `object` | Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. | | `oracle` | `object` | Specifies connection parameters required specifically for Oracle databases. | -| `postgresql` | `object` | Specifies connection parameters required specifically for PostgreSQL databases. | | `state` | `string` | The current connection profile state (e.g. DRAFT, READY, or FAILED). | | `mysql` | `object` | Specifies connection parameters required specifically for MySQL databases. | -| `cloudsql` | `object` | Specifies required connection parameters, and, optionally, the parameters required to create a Cloud SQL destination database instance. | -| `provider` | `string` | The database provider. | | `displayName` | `string` | The connection profile display name. | -| `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". | -| `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". | -| `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" }`. | +| `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). | -| `alloydb` | `object` | Specifies required connection parameters, and the parameters required to create an AlloyDB destination cluster. | +| `provider` | `string` | The database provider. | +| `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/conversion_workspaces/index.md b/docs/google-docs/providers/google/datamigration/conversion_workspaces/index.md index 9feacbda4e..c08cc23bcb 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}. | -| `latestCommitId` | `string` | Output only. The latest commit ID. | -| `source` | `object` | The type and version of a source or destination database. | -| `latestCommitTime` | `string` | Output only. The timestamp when the workspace was committed. | | `hasUncommittedChanges` | `boolean` | Output only. Whether the workspace has uncommitted changes (changes which were made after the workspace was committed). | -| `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 | | `destination` | `object` | The type and version of a source or destination database. | -| `updateTime` | `string` | Output only. The timestamp when the workspace resource was last updated. | +| `source` | `object` | The type and version of a source or destination database. | +| `latestCommitTime` | `string` | Output only. The timestamp when the workspace was committed. | +| `latestCommitId` | `string` | Output only. The latest commit ID. | | `createTime` | `string` | Output only. The timestamp when the workspace resource was created. | | `displayName` | `string` | Optional. The display name for the workspace. | +| `updateTime` | `string` | Output only. The timestamp when the workspace resource was last updated. | +| `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 | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/index.md b/docs/google-docs/providers/google/datamigration/index.md index 0de2ae96da..455cec4700 100644 --- a/docs/google-docs/providers/google/datamigration/index.md +++ b/docs/google-docs/providers/google/datamigration/index.md @@ -33,7 +33,7 @@ Manage Cloud Database Migration Service Resources On Google Cloud Platform. TypeService TitleDatabase Migration API DescriptionManage Cloud Database Migration Service Resources On Google Cloud Platform. -Iddatamigration:v23.08.00161 +Iddatamigration:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datamigration/locations/index.md b/docs/google-docs/providers/google/datamigration/locations/index.md index 5989115392..232d9dc129 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"` | -| `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/datamigration/mapping_rules/index.md b/docs/google-docs/providers/google/datamigration/mapping_rules/index.md index 0a34ed9262..cb7ffbf188 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}. | -| `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. | -| `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 | -| `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. | -| `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. | +| `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. | +| `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). | | `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. | +| `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 | | `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 | +| `state` | `string` | Optional. The mapping rule state | | `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. | +| `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 | | `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.. | +| `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. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | | `displayName` | `string` | Optional. A human readable name | -| `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 | | `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). | -| `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. | -| `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 | -| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `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. | | `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. | +| `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. | ## 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 fd3c60385f..195a84082b 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}. | -| `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. | -| `sourceDatabase` | `object` | A message defining the database engine and provider. | -| `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. | -| `endTime` | `string` | Output only. If the migration job is completed, the time when it was completed. | -| `performanceConfig` | `object` | Performance configuration definition. | -| `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". | -| `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. | -| `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] | -| `conversionWorkspace` | `object` | A conversion workspace's version. | +| `type` | `string` | Required. The migration job type. | | `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". | +| `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" }`. | +| `phase` | `string` | Output only. The current migration job phase. | +| `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. | | `dumpFlags` | `object` | Dump flags definition. | -| `state` | `string` | The current migration job state. | +| `destinationDatabase` | `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). | +| `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". | | `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. | -| `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. | | `displayName` | `string` | The migration job display name. | -| `source` | `string` | Required. The resource name (URI) of the source connection profile. | -| `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" }`. | -| `destinationDatabase` | `object` | A message defining the database engine and provider. | -| `phase` | `string` | Output only. The current migration job phase. | -| `type` | `string` | Required. The migration job type. | +| `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. | | `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. | +| `endTime` | `string` | Output only. If the migration job is completed, the time when it was completed. | +| `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] | | `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". | +| `source` | `string` | Required. The resource name (URI) of the source connection profile. | +| `sourceDatabase` | `object` | A message defining the database engine and provider. | +| `conversionWorkspace` | `object` | A conversion workspace's version. | +| `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. | +| `performanceConfig` | `object` | Performance configuration definition. | +| `state` | `string` | The current migration job state. | +| `destination` | `string` | Required. The resource name (URI) of the destination connection profile. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datamigration/migration_jobs_iam_policies/index.md b/docs/google-docs/providers/google/datamigration/migration_jobs_iam_policies/index.md index e375619f6a..d503aafbb7 100644 --- a/docs/google-docs/providers/google/datamigration/migration_jobs_iam_policies/index.md +++ b/docs/google-docs/providers/google/datamigration/migration_jobs_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | 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 06834d107e..15d7ae3954 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. | ## 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 0334a4dddf..b58915b26a 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datapipelines/index.md b/docs/google-docs/providers/google/datapipelines/index.md index 064ae2a249..ad929d0765 100644 --- a/docs/google-docs/providers/google/datapipelines/index.md +++ b/docs/google-docs/providers/google/datapipelines/index.md @@ -33,7 +33,7 @@ Data Pipelines Provides An Interface For Creating, Updating, And Managing Recurr TypeService TitleData Pipelines API DescriptionData Pipelines Provides An Interface For Creating, Updating, And Managing Recurring Data Analytics Jobs. -Iddatapipelines:v23.08.00161 +Iddatapipelines:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datapipelines/jobs/index.md b/docs/google-docs/providers/google/datapipelines/jobs/index.md index 6e7323097a..b96fdaa7a8 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. | -| `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). | | `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. | ## 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 f85c8aec0e..78f0c75300 100644 --- a/docs/google-docs/providers/google/datapipelines/pipelines/index.md +++ b/docs/google-docs/providers/google/datapipelines/pipelines/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `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. | -| `displayName` | `string` | Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). | +| `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. | | `lastUpdateTime` | `string` | Output only. Immutable. The timestamp when the pipeline was last modified. Set by the Data Pipelines service. | +| `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. | | `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. | -| `workload` | `object` | Workload details for creating the pipeline jobs. | | `scheduleInfo` | `object` | Details of the schedule the pipeline runs on. | -| `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. | | `createTime` | `string` | Output only. Immutable. The timestamp when the pipeline was initially created. Set by the Data Pipelines service. | -| `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. | -| `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. | +| `workload` | `object` | Workload details for creating the pipeline jobs. | +| `displayName` | `string` | Required. The display name of the pipeline. It can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), and underscores (_). | +| `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. | ## 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 d944bebfa1..a4d4c68366 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}. | +| `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). | | `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. | | `issue` | `string` | Detailed description of the issue requiring action. | -| `lake` | `string` | Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. | -| `invalidDataFormat` | `object` | Action details for invalid or unsupported data files detected by discovery. | +| `missingResource` | `object` | Action details for resource references in assets that cannot be located. | +| `incompatibleDataSchema` | `object` | Action details for incompatible schemas 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}. | -| `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). | -| `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}. | -| `invalidDataPartition` | `object` | Action details for invalid or unsupported partitions 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. | | `missingData` | `object` | Action details for absence of data detected by discovery. | | `category` | `string` | The category of issue associated with the 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. | -| `missingResource` | `object` | Action details for resource references in assets that cannot be located. | | `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. | +| `invalidDataFormat` | `object` | Action details for invalid or unsupported data files detected by discovery. | +| `lake` | `string` | Output only. The relative resource name of the lake, of the form: projects/{project_number}/locations/{location_id}/lakes/{lake_id}. | +| `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. | +| `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}. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md index c817d323dd..63b18bc07c 100644 --- a/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/aspect_types_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | | `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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | ## 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 6e558321f0..236fd3940a 100644 --- a/docs/google-docs/providers/google/dataplex/assets/index.md +++ b/docs/google-docs/providers/google/dataplex/assets/index.md @@ -29,23 +29,23 @@ 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. | -| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing for an asset. | +| `updateTime` | `string` | Output only. The time when the asset was last updated. | +| `resourceStatus` | `object` | Status of the resource referenced by an asset. | +| `displayName` | `string` | Optional. User friendly display name. | | `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. | +| `resourceSpec` | `object` | Identifies the cloud resource that is referenced by this 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. | -| `state` | `string` | Output only. Current state of the asset. | +| `discoveryStatus` | `object` | Status of discovery for an asset. | +| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing for an asset. | | `labels` | `object` | Optional. User defined labels for the asset. | -| `resourceStatus` | `object` | Status of the resource referenced by an asset. | -| `updateTime` | `string` | Output only. The time when the asset was last updated. | | `createTime` | `string` | Output only. The time when the asset was created. | -| `discoveryStatus` | `object` | Status of discovery for an asset. | -| `displayName` | `string` | Optional. User friendly display name. | -| `resourceSpec` | `object` | Identifies the cloud resource that is referenced by this asset. | +| `state` | `string` | Output only. Current state of the asset. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_lakes_zones_assets_get` | `SELECT` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Retrieves an asset resource. | | `projects_locations_lakes_zones_assets_list` | `SELECT` | `lakesId, locationsId, projectsId, zonesId` | Lists asset resources in a zone. | | `projects_locations_lakes_zones_assets_create` | `INSERT` | `lakesId, locationsId, projectsId, zonesId` | Creates an asset resource. | | `projects_locations_lakes_zones_assets_delete` | `DELETE` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Deletes an asset resource. The referenced storage resource is detached (default) or deleted based on the associated Lifecycle policy. | | `_projects_locations_lakes_zones_assets_list` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | Lists asset resources in a zone. | -| `projects_locations_lakes_zones_assets_get` | `EXEC` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Retrieves an asset resource. | | `projects_locations_lakes_zones_assets_patch` | `EXEC` | `assetsId, lakesId, locationsId, projectsId, zonesId` | Updates an asset resource. | diff --git a/docs/google-docs/providers/google/dataplex/attributes/index.md b/docs/google-docs/providers/google/dataplex/attributes/index.md index 583a2dca4e..480cdc1569 100644 --- a/docs/google-docs/providers/google/dataplex/attributes/index.md +++ b/docs/google-docs/providers/google/dataplex/attributes/index.md @@ -29,22 +29,22 @@ 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. | -| `attributeCount` | `integer` | Output only. The number of child attributes present for this attribute. | -| `createTime` | `string` | Output only. The time when the DataAttribute was created. | | `displayName` | `string` | Optional. User friendly display name. | -| `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. | +| `labels` | `object` | Optional. User-defined labels for the DataAttribute. | +| `updateTime` | `string` | Output only. The time when the DataAttribute was last updated. | | `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 | | `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. | +| `createTime` | `string` | Output only. The time when the DataAttribute was created. | +| `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. | | `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 DataAttribute was last updated. | -| `labels` | `object` | Optional. User-defined labels for the DataAttribute. | +| `attributeCount` | `integer` | Output only. The number of child attributes present for this attribute. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_data_taxonomies_attributes_get` | `SELECT` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | Retrieves a Data Attribute resource. | | `projects_locations_data_taxonomies_attributes_list` | `SELECT` | `dataTaxonomiesId, locationsId, projectsId` | Lists Data Attribute resources in a DataTaxonomy. | | `projects_locations_data_taxonomies_attributes_create` | `INSERT` | `dataTaxonomiesId, locationsId, projectsId` | Create a DataAttribute resource. | | `projects_locations_data_taxonomies_attributes_delete` | `DELETE` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | Deletes a Data Attribute resource. | | `_projects_locations_data_taxonomies_attributes_list` | `EXEC` | `dataTaxonomiesId, locationsId, projectsId` | Lists Data Attribute resources in a DataTaxonomy. | -| `projects_locations_data_taxonomies_attributes_get` | `EXEC` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | Retrieves a Data Attribute resource. | | `projects_locations_data_taxonomies_attributes_patch` | `EXEC` | `attributesId, dataTaxonomiesId, locationsId, projectsId` | Updates a DataAttribute resource. | diff --git a/docs/google-docs/providers/google/dataplex/content/index.md b/docs/google-docs/providers/google/dataplex/content/index.md index 2cbd903009..5920bf2199 100644 --- a/docs/google-docs/providers/google/dataplex/content/index.md +++ b/docs/google-docs/providers/google/dataplex/content/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 content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} | | `description` | `string` | Optional. Description of the content. | -| `createTime` | `string` | Output only. Content creation time. | -| `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. | | `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. | -| `labels` | `object` | Optional. User defined labels for the content. | -| `notebook` | `object` | Configuration for Notebook content. | | `updateTime` | `string` | Output only. The time when the content was last updated. | -| `dataText` | `string` | Required. Content data in string format. | +| `createTime` | `string` | Output only. Content creation time. | +| `notebook` | `object` | Configuration for Notebook content. | | `sqlScript` | `object` | Configuration for the Sql Script content. | +| `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. | +| `dataText` | `string` | Required. Content data in string format. | +| `labels` | `object` | Optional. User defined labels for the content. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_lakes_content_get` | `SELECT` | `contentId, lakesId, locationsId, projectsId` | Get a content resource. | | `projects_locations_lakes_content_list` | `SELECT` | `lakesId, locationsId, projectsId` | List content. | | `projects_locations_lakes_content_create` | `INSERT` | `lakesId, locationsId, projectsId` | Create a content. | | `projects_locations_lakes_content_delete` | `DELETE` | `contentId, lakesId, locationsId, projectsId` | Delete a content. | | `_projects_locations_lakes_content_list` | `EXEC` | `lakesId, locationsId, projectsId` | List content. | -| `projects_locations_lakes_content_get` | `EXEC` | `contentId, lakesId, locationsId, projectsId` | Get a content resource. | | `projects_locations_lakes_content_patch` | `EXEC` | `contentId, lakesId, locationsId, projectsId` | Update a content. Only supports full resource update. | diff --git a/docs/google-docs/providers/google/dataplex/content_iam_policies/index.md b/docs/google-docs/providers/google/dataplex/content_iam_policies/index.md index 87b4838182..1e2c021649 100644 --- a/docs/google-docs/providers/google/dataplex/content_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataplex/content_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | | `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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/contentitems/index.md b/docs/google-docs/providers/google/dataplex/contentitems/index.md index 575d335192..fd86f97f4a 100644 --- a/docs/google-docs/providers/google/dataplex/contentitems/index.md +++ b/docs/google-docs/providers/google/dataplex/contentitems/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 content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/content/{content_id} | | `description` | `string` | Optional. Description of the content. | -| `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. | -| `sqlScript` | `object` | Configuration for the Sql Script content. | | `notebook` | `object` | Configuration for Notebook content. | +| `createTime` | `string` | Output only. Content creation time. | +| `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. | | `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. | -| `createTime` | `string` | Output only. Content creation time. | | `dataText` | `string` | Required. Content data in string format. | | `labels` | `object` | Optional. User defined labels for the content. | +| `sqlScript` | `object` | Configuration for the Sql Script content. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_lakes_contentitems_get` | `SELECT` | `contentitemsId, lakesId, locationsId, projectsId` | Get a content resource. | | `projects_locations_lakes_contentitems_list` | `SELECT` | `lakesId, locationsId, projectsId` | List content. | | `projects_locations_lakes_contentitems_create` | `INSERT` | `lakesId, locationsId, projectsId` | Create a content. | | `projects_locations_lakes_contentitems_delete` | `DELETE` | `contentitemsId, lakesId, locationsId, projectsId` | Delete a content. | | `_projects_locations_lakes_contentitems_list` | `EXEC` | `lakesId, locationsId, projectsId` | List content. | -| `projects_locations_lakes_contentitems_get` | `EXEC` | `contentitemsId, lakesId, locationsId, projectsId` | Get a content resource. | | `projects_locations_lakes_contentitems_patch` | `EXEC` | `contentitemsId, lakesId, locationsId, projectsId` | Update a content. Only supports full resource update. | 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 c226173157..1944839351 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,21 +29,21 @@ 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. | -| `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. | -| `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} | +| `paths` | `array` | Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings. | | `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. | | `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. | -| `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. | +| `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} | | `updateTime` | `string` | Output only. The time when the DataAttributeBinding 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. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method. | +| `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. | | `createTime` | `string` | Output only. The time when the DataAttributeBinding was created. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_data_attribute_bindings_get` | `SELECT` | `dataAttributeBindingsId, locationsId, projectsId` | Retrieves a DataAttributeBinding resource. | | `projects_locations_data_attribute_bindings_list` | `SELECT` | `locationsId, projectsId` | Lists DataAttributeBinding resources in a project and location. | | `projects_locations_data_attribute_bindings_create` | `INSERT` | `locationsId, projectsId` | Create a DataAttributeBinding resource. | | `projects_locations_data_attribute_bindings_delete` | `DELETE` | `dataAttributeBindingsId, locationsId, projectsId` | Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted. | | `_projects_locations_data_attribute_bindings_list` | `EXEC` | `locationsId, projectsId` | Lists DataAttributeBinding resources in a project and location. | -| `projects_locations_data_attribute_bindings_get` | `EXEC` | `dataAttributeBindingsId, locationsId, projectsId` | Retrieves a DataAttributeBinding resource. | | `projects_locations_data_attribute_bindings_patch` | `EXEC` | `dataAttributeBindingsId, locationsId, projectsId` | Updates a DataAttributeBinding resource. | 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 f1d22bfbd5..82a3699ae3 100644 --- a/docs/google-docs/providers/google/dataplex/data_scans/index.md +++ b/docs/google-docs/providers/google/dataplex/data_scans/index.md @@ -29,27 +29,27 @@ 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. | -| `createTime` | `string` | Output only. The time when the scan was created. | -| `dataProfileSpec` | `object` | DataProfileScan related setting. | -| `executionSpec` | `object` | DataScan execution settings. | -| `dataQualityResult` | `object` | The output of a DataQualityScan. | -| `dataProfileResult` | `object` | DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. | | `executionStatus` | `object` | Status of the data scan execution. | -| `data` | `object` | The data source for DataScan. | +| `createTime` | `string` | Output only. The time when the scan was created. | | `type` | `string` | Output only. The type of DataScan. | -| `updateTime` | `string` | Output only. The time when the scan was last updated. | +| `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. | -| `dataQualitySpec` | `object` | DataQualityScan related setting. | -| `displayName` | `string` | Optional. User friendly display name. Must be between 1-256 characters. | +| `dataQualityResult` | `object` | The output of a DataQualityScan. | | `labels` | `object` | Optional. User-defined labels for the scan. | +| `data` | `object` | The data source for DataScan. | +| `state` | `string` | Output only. Current state of the DataScan. | +| `displayName` | `string` | Optional. User friendly display name. Must be between 1-256 characters. | +| `dataQualitySpec` | `object` | DataQualityScan related setting. | +| `updateTime` | `string` | Output only. The time when the scan was last updated. | +| `dataProfileSpec` | `object` | DataProfileScan related setting. | +| `executionSpec` | `object` | DataScan execution settings. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_data_scans_get` | `SELECT` | `dataScansId, locationsId, projectsId` | Gets a DataScan resource. | | `projects_locations_data_scans_list` | `SELECT` | `locationsId, projectsId` | Lists DataScans. | | `projects_locations_data_scans_create` | `INSERT` | `locationsId, projectsId` | Creates a DataScan resource. | | `projects_locations_data_scans_delete` | `DELETE` | `dataScansId, locationsId, projectsId` | Deletes a DataScan resource. | | `_projects_locations_data_scans_list` | `EXEC` | `locationsId, projectsId` | Lists DataScans. | -| `projects_locations_data_scans_get` | `EXEC` | `dataScansId, locationsId, projectsId` | Gets a DataScan resource. | | `projects_locations_data_scans_patch` | `EXEC` | `dataScansId, locationsId, projectsId` | Updates a DataScan resource. | | `projects_locations_data_scans_run` | `EXEC` | `dataScansId, locationsId, projectsId` | Runs an on-demand execution of a DataScan | 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 41646928af..8cb564529e 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | | `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 | 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 5935e72624..b24f2636e3 100644 --- a/docs/google-docs/providers/google/dataplex/data_taxonomies/index.md +++ b/docs/google-docs/providers/google/dataplex/data_taxonomies/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 DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}. | | `description` | `string` | Optional. Description of the DataTaxonomy. | -| `classCount` | `integer` | Output only. The number of classes in the DataTaxonomy. | +| `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. | -| `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. | -| `createTime` | `string` | Output only. The time when the DataTaxonomy was created. | | `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. | | `labels` | `object` | Optional. User-defined labels for the DataTaxonomy. | +| `classCount` | `integer` | Output only. The number of classes in the DataTaxonomy. | +| `createTime` | `string` | Output only. The time when the DataTaxonomy was created. | | `attributeCount` | `integer` | Output only. The number of attributes 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_data_taxonomies_get` | `SELECT` | `dataTaxonomiesId, locationsId, projectsId` | Retrieves a DataTaxonomy resource. | | `projects_locations_data_taxonomies_list` | `SELECT` | `locationsId, projectsId` | Lists DataTaxonomy resources in a project and location. | | `projects_locations_data_taxonomies_create` | `INSERT` | `locationsId, projectsId` | Create a DataTaxonomy resource. | | `projects_locations_data_taxonomies_delete` | `DELETE` | `dataTaxonomiesId, locationsId, projectsId` | Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted. | | `_projects_locations_data_taxonomies_list` | `EXEC` | `locationsId, projectsId` | Lists DataTaxonomy resources in a project and location. | -| `projects_locations_data_taxonomies_get` | `EXEC` | `dataTaxonomiesId, locationsId, projectsId` | Retrieves a DataTaxonomy resource. | | `projects_locations_data_taxonomies_patch` | `EXEC` | `dataTaxonomiesId, locationsId, projectsId` | Updates a DataTaxonomy resource. | 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 c53a634400..947a391270 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/entities/index.md b/docs/google-docs/providers/google/dataplex/entities/index.md index 2569e995d5..847a59983c 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. | -| `etag` | `string` | Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests. | -| `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. | -| `catalogEntry` | `string` | Output only. The name of the associated Data Catalog entry. | -| `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. | -| `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. | -| `format` | `object` | Describes the format of the data within its storage location. | | `compatibility` | `object` | Provides compatibility information for various metadata stores. | | `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. | -| `access` | `object` | Describes the access mechanism of the data within its storage location. | -| `createTime` | `string` | Output only. The time when the entity was created. | +| `schema` | `object` | Schema information describing the structure and layout of the data. | | `system` | `string` | Required. Immutable. Identifies the storage system of the entity data. | | `updateTime` | `string` | Output only. The time when the entity was last updated. | | `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. | +| `createTime` | `string` | Output only. The time when the entity was created. | +| `etag` | `string` | Optional. The etag associated with the entity, which can be retrieved with a GetEntity request. Required for update and delete requests. | +| `displayName` | `string` | Optional. Display name must be shorter than or equal to 256 characters. | +| `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. | +| `format` | `object` | Describes the format of the data within its storage location. | +| `catalogEntry` | `string` | Output only. The name of the associated Data Catalog entry. | +| `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. | | `type` | `string` | Required. Immutable. The type of entity. | +| `access` | `object` | Describes the access mechanism of the data within its storage location. | ## 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 48f30f440c..93d405e518 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/environments/index.md b/docs/google-docs/providers/google/dataplex/environments/index.md index 51a9fb9e37..17b4b14e8c 100644 --- a/docs/google-docs/providers/google/dataplex/environments/index.md +++ b/docs/google-docs/providers/google/dataplex/environments/index.md @@ -29,22 +29,22 @@ 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. | +| `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. | +| `createTime` | `string` | Output only. Environment creation time. | | `labels` | `object` | Optional. User defined labels for the environment. | | `sessionStatus` | `object` | Status of sessions created for this environment. | -| `endpoints` | `object` | URI Endpoints to access sessions associated with the 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. | -| `state` | `string` | Output only. Current state of the environment. | | `infrastructureSpec` | `object` | Configuration for the underlying infrastructure used to run workloads. | -| `sessionSpec` | `object` | Configuration for sessions created for this environment. | -| `createTime` | `string` | Output only. Environment creation time. | +| `endpoints` | `object` | URI Endpoints to access sessions associated with the Environment. | | `displayName` | `string` | Optional. User friendly display name. | +| `sessionSpec` | `object` | Configuration for sessions created for this environment. | +| `state` | `string` | Output only. Current state of the environment. | | `updateTime` | `string` | Output only. The time when the environment was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_lakes_environments_get` | `SELECT` | `environmentsId, lakesId, locationsId, projectsId` | Get environment resource. | | `projects_locations_lakes_environments_list` | `SELECT` | `lakesId, locationsId, projectsId` | Lists environments under the given lake. | | `projects_locations_lakes_environments_create` | `INSERT` | `lakesId, locationsId, projectsId` | Create an environment resource. | | `projects_locations_lakes_environments_delete` | `DELETE` | `environmentsId, lakesId, locationsId, projectsId` | Delete the environment resource. All the child resources must have been deleted before environment deletion can be initiated. | | `_projects_locations_lakes_environments_list` | `EXEC` | `lakesId, locationsId, projectsId` | Lists environments under the given lake. | -| `projects_locations_lakes_environments_get` | `EXEC` | `environmentsId, lakesId, locationsId, projectsId` | Get environment resource. | | `projects_locations_lakes_environments_patch` | `EXEC` | `environmentsId, lakesId, locationsId, projectsId` | Update the environment resource. | diff --git a/docs/google-docs/providers/google/dataplex/index.md b/docs/google-docs/providers/google/dataplex/index.md index 95d3a6463f..bf0f245c3b 100644 --- a/docs/google-docs/providers/google/dataplex/index.md +++ b/docs/google-docs/providers/google/dataplex/index.md @@ -33,7 +33,7 @@ Dataplex API Is Used To Manage The Lifecycle Of Data Lakes. TypeService TitleCloud Dataplex API DescriptionDataplex API Is Used To Manage The Lifecycle Of Data Lakes. -Iddataplex:v23.08.00161 +Iddataplex:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/dataplex/jobs/index.md b/docs/google-docs/providers/google/dataplex/jobs/index.md index 89e83acdaf..dcc2052b19 100644 --- a/docs/google-docs/providers/google/dataplex/jobs/index.md +++ b/docs/google-docs/providers/google/dataplex/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 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. | -| `startTime` | `string` | Output only. The time when the DataScanJob was started. | -| `state` | `string` | Output only. Execution state for the DataScanJob. | +| `dataQualitySpec` | `object` | DataQualityScan related setting. | | `type` | `string` | Output only. The type of the parent DataScan. | -| `uid` | `string` | Output only. System generated globally unique ID for the DataScanJob. | | `endTime` | `string` | Output only. The time when the DataScanJob ended. | -| `dataProfileResult` | `object` | DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. | +| `startTime` | `string` | Output only. The time when the DataScanJob was started. | +| `message` | `string` | Output only. Additional information about the current state. | +| `uid` | `string` | Output only. System generated globally unique ID for the DataScanJob. | | `dataProfileSpec` | `object` | DataProfileScan related setting. | -| `dataQualitySpec` | `object` | DataQualityScan related setting. | +| `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. | | `dataQualityResult` | `object` | The output of a DataQualityScan. | -| `message` | `string` | Output only. Additional information about the current state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_data_scans_jobs_get` | `SELECT` | `dataScansId, jobsId, locationsId, projectsId` | Gets a DataScanJob resource. | | `projects_locations_data_scans_jobs_list` | `SELECT` | `dataScansId, locationsId, projectsId` | Lists DataScanJobs under the given DataScan. | +| `projects_locations_lakes_tasks_jobs_get` | `SELECT` | `jobsId, lakesId, locationsId, projectsId, tasksId` | Get job resource. | | `projects_locations_lakes_tasks_jobs_list` | `SELECT` | `lakesId, locationsId, projectsId, tasksId` | Lists Jobs under the given task. | | `_projects_locations_data_scans_jobs_list` | `EXEC` | `dataScansId, locationsId, projectsId` | Lists DataScanJobs under the given DataScan. | | `_projects_locations_lakes_tasks_jobs_list` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Lists Jobs under the given task. | | `projects_locations_lakes_tasks_jobs_cancel` | `EXEC` | `jobsId, lakesId, locationsId, projectsId, tasksId` | Cancel jobs running for the task resource. | -| `projects_locations_lakes_tasks_jobs_get` | `EXEC` | `jobsId, lakesId, locationsId, projectsId, tasksId` | Get job resource. | diff --git a/docs/google-docs/providers/google/dataplex/lakes/index.md b/docs/google-docs/providers/google/dataplex/lakes/index.md index a79848f878..0f45e7d14c 100644 --- a/docs/google-docs/providers/google/dataplex/lakes/index.md +++ b/docs/google-docs/providers/google/dataplex/lakes/index.md @@ -29,22 +29,22 @@ 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. | -| `state` | `string` | Output only. Current state of the lake. | -| `displayName` | `string` | Optional. User friendly display name. | | `metastoreStatus` | `object` | Status of Lake and Dataproc Metastore service instance association. | -| `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. | -| `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. | | `updateTime` | `string` | Output only. The time when the lake was last updated. | -| `labels` | `object` | Optional. User-defined labels for 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. | +| `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. | +| `state` | `string` | Output only. Current state of the lake. | +| `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. | +| `displayName` | `string` | Optional. User friendly display name. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_lakes_get` | `SELECT` | `lakesId, locationsId, projectsId` | Retrieves a lake resource. | | `projects_locations_lakes_list` | `SELECT` | `locationsId, projectsId` | Lists lake resources in a project and location. | | `projects_locations_lakes_create` | `INSERT` | `locationsId, projectsId` | Creates a lake resource. | | `projects_locations_lakes_delete` | `DELETE` | `lakesId, locationsId, projectsId` | Deletes a lake resource. All zones within the lake must be deleted before the lake can be deleted. | | `_projects_locations_lakes_list` | `EXEC` | `locationsId, projectsId` | Lists lake resources in a project and location. | -| `projects_locations_lakes_get` | `EXEC` | `lakesId, locationsId, projectsId` | Retrieves a lake resource. | | `projects_locations_lakes_patch` | `EXEC` | `lakesId, locationsId, projectsId` | Updates a lake resource. | 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 de2e41c0c2..7b623e7984 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | -| `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 | 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..19a9dee85e 100644 --- a/docs/google-docs/providers/google/dataplex/locations/index.md +++ b/docs/google-docs/providers/google/dataplex/locations/index.md @@ -28,13 +28,13 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/dataplex/operations/index.md b/docs/google-docs/providers/google/dataplex/operations/index.md index 338437d8ca..f3eb030c46 100644 --- a/docs/google-docs/providers/google/dataplex/operations/index.md +++ b/docs/google-docs/providers/google/dataplex/operations/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, 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. | +| `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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/dataplex/partitions/index.md b/docs/google-docs/providers/google/dataplex/partitions/index.md index 1814f13a75..eaacf7d288 100644 --- a/docs/google-docs/providers/google/dataplex/partitions/index.md +++ b/docs/google-docs/providers/google/dataplex/partitions/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Partition values used in the HTTP URL must be double encoded. For example, url_encode(url_encode(value)) can be used to encode "US:CA/CA#Sunnyvale so that the request URL ends with "/partitions/US%253ACA/CA%2523Sunnyvale". The name field in the response retains the encoded format. | +| `location` | `string` | Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/ | | `values` | `array` | Required. Immutable. The set of values representing the partition, which correspond to the partition schema defined in the parent entity. | | `etag` | `string` | Optional. The etag for this partition. | -| `location` | `string` | Required. Immutable. The location of the entity data within the partition, for example, gs://bucket/path/to/entity/key1=value1/key2=value2. Or projects//datasets//tables/ | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dataplex/sessions/index.md b/docs/google-docs/providers/google/dataplex/sessions/index.md index f93a91263b..71be16816e 100644 --- a/docs/google-docs/providers/google/dataplex/sessions/index.md +++ b/docs/google-docs/providers/google/dataplex/sessions/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The relative resource name of the content, of the form: projects/{project_id}/locations/{location_id}/lakes/{lake_id}/environment/{environment_id}/sessions/{session_id} | +| `state` | `string` | Output only. State of Session | | `userId` | `string` | Output only. Email of user running the session. | | `createTime` | `string` | Output only. Session start time. | -| `state` | `string` | Output only. State of Session | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dataplex/tasks/index.md b/docs/google-docs/providers/google/dataplex/tasks/index.md index 213952d4f8..174bd73451 100644 --- a/docs/google-docs/providers/google/dataplex/tasks/index.md +++ b/docs/google-docs/providers/google/dataplex/tasks/index.md @@ -29,24 +29,24 @@ 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. | -| `executionStatus` | `object` | Status of the task execution (e.g. Jobs). | -| `updateTime` | `string` | Output only. The time when the task was last updated. | +| `triggerSpec` | `object` | Task scheduling and trigger settings. | +| `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. | -| `displayName` | `string` | Optional. User friendly display name. | -| `labels` | `object` | Optional. User-defined labels for the task. | +| `executionSpec` | `object` | Execution related settings, like retry and service_account. | | `spark` | `object` | User-specified config for running a Spark task. | -| `triggerSpec` | `object` | Task scheduling and trigger settings. | | `state` | `string` | Output only. Current state of the task. | -| `executionSpec` | `object` | Execution related settings, like retry and service_account. | +| `updateTime` | `string` | Output only. The time when the task was last updated. | +| `executionStatus` | `object` | Status of the task execution (e.g. Jobs). | +| `labels` | `object` | Optional. User-defined labels for the task. | +| `displayName` | `string` | Optional. User friendly display name. | | `notebook` | `object` | Config for running scheduled notebooks. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_lakes_tasks_get` | `SELECT` | `lakesId, locationsId, projectsId, tasksId` | Get task resource. | | `projects_locations_lakes_tasks_list` | `SELECT` | `lakesId, locationsId, projectsId` | Lists tasks under the given lake. | | `projects_locations_lakes_tasks_create` | `INSERT` | `lakesId, locationsId, projectsId` | Creates a task resource within a lake. | | `projects_locations_lakes_tasks_delete` | `DELETE` | `lakesId, locationsId, projectsId, tasksId` | Delete the task resource. | | `_projects_locations_lakes_tasks_list` | `EXEC` | `lakesId, locationsId, projectsId` | Lists tasks under the given lake. | -| `projects_locations_lakes_tasks_get` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Get task resource. | | `projects_locations_lakes_tasks_patch` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Update the task resource. | | `projects_locations_lakes_tasks_run` | `EXEC` | `lakesId, locationsId, projectsId, tasksId` | Run an on demand execution of a Task. | diff --git a/docs/google-docs/providers/google/dataplex/zones/index.md b/docs/google-docs/providers/google/dataplex/zones/index.md index 38e711a5f3..b7695456d4 100644 --- a/docs/google-docs/providers/google/dataplex/zones/index.md +++ b/docs/google-docs/providers/google/dataplex/zones/index.md @@ -29,22 +29,22 @@ 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. | -| `type` | `string` | Required. Immutable. The type of the zone. | | `resourceSpec` | `object` | Settings for resources attached as assets within a zone. | +| `displayName` | `string` | Optional. User friendly display name. | +| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing in a zone. | +| `labels` | `object` | Optional. User defined labels for the zone. | +| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | | `updateTime` | `string` | Output only. The time when the zone was last updated. | | `createTime` | `string` | Output only. The time when the zone was created. | | `state` | `string` | Output only. Current state of the zone. | -| `discoverySpec` | `object` | Settings to manage the metadata discovery and publishing in a zone. | -| `labels` | `object` | Optional. User defined labels for the zone. | -| `displayName` | `string` | Optional. User friendly display name. | +| `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. | -| `assetStatus` | `object` | Aggregated status of the underlying assets of a lake or zone. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_lakes_zones_get` | `SELECT` | `lakesId, locationsId, projectsId, zonesId` | Retrieves a zone resource. | | `projects_locations_lakes_zones_list` | `SELECT` | `lakesId, locationsId, projectsId` | Lists zone resources in a lake. | | `projects_locations_lakes_zones_create` | `INSERT` | `lakesId, locationsId, projectsId` | Creates a zone resource within a lake. | | `projects_locations_lakes_zones_delete` | `DELETE` | `lakesId, locationsId, projectsId, zonesId` | Deletes a zone resource. All assets within a zone must be deleted before the zone can be deleted. | | `_projects_locations_lakes_zones_list` | `EXEC` | `lakesId, locationsId, projectsId` | Lists zone resources in a lake. | -| `projects_locations_lakes_zones_get` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | Retrieves a zone resource. | | `projects_locations_lakes_zones_patch` | `EXEC` | `lakesId, locationsId, projectsId, zonesId` | Updates a zone resource. | 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 e5dbd5c71e..0972686289 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | | `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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | ## 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..86bf14c8db 100644 --- a/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/autoscaling_policies/index.md @@ -29,14 +29,16 @@ 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} | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_autoscaling_policies_get` | `SELECT` | `autoscalingPoliciesId, locationsId, projectsId` | Retrieves autoscaling policy. | | `projects_locations_autoscaling_policies_list` | `SELECT` | `locationsId, projectsId` | Lists autoscaling policies in the project. | +| `projects_regions_autoscaling_policies_get` | `SELECT` | `autoscalingPoliciesId, projectsId, regionsId` | Retrieves autoscaling policy. | | `projects_regions_autoscaling_policies_list` | `SELECT` | `projectsId, regionsId` | Lists autoscaling policies in the project. | | `projects_locations_autoscaling_policies_create` | `INSERT` | `locationsId, projectsId` | Creates new autoscaling policy. | | `projects_regions_autoscaling_policies_create` | `INSERT` | `projectsId, regionsId` | Creates new autoscaling policy. | @@ -44,7 +46,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_regions_autoscaling_policies_delete` | `DELETE` | `autoscalingPoliciesId, projectsId, regionsId` | Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters. | | `_projects_locations_autoscaling_policies_list` | `EXEC` | `locationsId, projectsId` | Lists autoscaling policies in the project. | | `_projects_regions_autoscaling_policies_list` | `EXEC` | `projectsId, regionsId` | Lists autoscaling policies in the project. | -| `projects_locations_autoscaling_policies_get` | `EXEC` | `autoscalingPoliciesId, locationsId, projectsId` | Retrieves autoscaling policy. | | `projects_locations_autoscaling_policies_update` | `EXEC` | `autoscalingPoliciesId, locationsId, projectsId` | Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. | -| `projects_regions_autoscaling_policies_get` | `EXEC` | `autoscalingPoliciesId, projectsId, regionsId` | Retrieves autoscaling policy. | | `projects_regions_autoscaling_policies_update` | `EXEC` | `autoscalingPoliciesId, projectsId, regionsId` | Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements. | 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 a8f48533f2..fec6c4316c 100644 --- a/docs/google-docs/providers/google/dataproc/batches/index.md +++ b/docs/google-docs/providers/google/dataproc/batches/index.md @@ -28,27 +28,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource name of the batch. | -| `stateMessage` | `string` | Output only. Batch state details, such as a failure description if the state is FAILED. | -| `runtimeInfo` | `object` | Runtime information about workload execution. | -| `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. | +| `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. | | `state` | `string` | Output only. The state of the batch. | -| `creator` | `string` | Output only. The email address of the user who created the batch. | -| `sparkBatch` | `object` | A configuration for running an Apache Spark (https://spark.apache.org/) batch workload. | -| `sparkRBatch` | `object` | A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload. | +| `stateMessage` | `string` | Output only. Batch state details, such as a failure description if the state is FAILED. | | `environmentConfig` | `object` | Environment configuration for a workload. | +| `runtimeInfo` | `object` | Runtime information about workload execution. | | `runtimeConfig` | `object` | Runtime configuration for a workload. | -| `stateHistory` | `array` | Output only. Historical state information for the batch. | -| `sparkSqlBatch` | `object` | A configuration for running Apache Spark SQL (https://spark.apache.org/sql/) queries as a batch workload. | | `operation` | `string` | Output only. The resource name of the operation associated with this batch. | -| `pysparkBatch` | `object` | A configuration for running an Apache PySpark (https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html) batch workload. | | `uuid` | `string` | Output only. A batch UUID (Unique Universal Identifier). The service generates this value when it creates the batch. | -| `createTime` | `string` | Output only. The time when the batch was created. | +| `sparkBatch` | `object` | A configuration for running an Apache Spark (https://spark.apache.org/) batch workload. | +| `stateHistory` | `array` | Output only. Historical state information for the batch. | +| `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. | +| `sparkSqlBatch` | `object` | A configuration for running Apache Spark SQL (https://spark.apache.org/sql/) queries as a batch workload. | | `stateTime` | `string` | Output only. The time when the batch entered a current state. | +| `sparkRBatch` | `object` | A configuration for running an Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) batch workload. | +| `creator` | `string` | Output only. The email address of the user who created the batch. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_batches_get` | `SELECT` | `batchesId, locationsId, projectsId` | Gets the batch workload resource representation. | | `projects_locations_batches_list` | `SELECT` | `locationsId, projectsId` | Lists batch workloads. | | `projects_locations_batches_create` | `INSERT` | `locationsId, projectsId` | Creates a batch workload that executes asynchronously. | | `projects_locations_batches_delete` | `DELETE` | `batchesId, locationsId, projectsId` | Deletes the batch workload resource. If the batch is not in a CANCELLED, SUCCEEDED or FAILED State, the delete operation fails and the response returns FAILED_PRECONDITION. | | `_projects_locations_batches_list` | `EXEC` | `locationsId, projectsId` | Lists batch workloads. | -| `projects_locations_batches_get` | `EXEC` | `batchesId, locationsId, projectsId` | Gets the batch workload resource representation. | diff --git a/docs/google-docs/providers/google/dataproc/clusters/index.md b/docs/google-docs/providers/google/dataproc/clusters/index.md index ee1b37b078..a1ba8a98f8 100644 --- a/docs/google-docs/providers/google/dataproc/clusters/index.md +++ b/docs/google-docs/providers/google/dataproc/clusters/index.md @@ -28,23 +28,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `statusHistory` | `array` | Output only. The previous cluster status. | +| `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. | +| `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. | -| `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). | | `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. | -| `clusterUuid` | `string` | Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_regions_clusters_get` | `SELECT` | `clusterName, projectId, region` | Gets the resource representation for a cluster in a project. | | `projects_regions_clusters_list` | `SELECT` | `projectId, region` | Lists all regions/{region}/clusters in a project alphabetically. | | `projects_regions_clusters_create` | `INSERT` | `projectId, region` | Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). | | `projects_regions_clusters_delete` | `DELETE` | `clusterName, projectId, region` | Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). | | `_projects_regions_clusters_list` | `EXEC` | `projectId, region` | Lists all regions/{region}/clusters in a project alphabetically. | | `projects_regions_clusters_diagnose` | `EXEC` | `clusterName, projectId, region` | Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults). | -| `projects_regions_clusters_get` | `EXEC` | `clusterName, projectId, region` | Gets the resource representation for a cluster in a project. | | `projects_regions_clusters_inject_credentials` | `EXEC` | `clustersId, projectsId, regionsId` | Inject encrypted credentials into all of the VMs in a cluster.The target cluster must be a personal auth cluster assigned to the user who is issuing the RPC. | | `projects_regions_clusters_patch` | `EXEC` | `clusterName, projectId, region` | Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). The cluster must be in a RUNNING state or an error is returned. | | `projects_regions_clusters_repair` | `EXEC` | `clusterName, projectId, region` | Repairs a cluster. | diff --git a/docs/google-docs/providers/google/dataproc/index.md b/docs/google-docs/providers/google/dataproc/index.md index 26cca43be0..b02ae83a35 100644 --- a/docs/google-docs/providers/google/dataproc/index.md +++ b/docs/google-docs/providers/google/dataproc/index.md @@ -19,9 +19,9 @@ Manages Hadoop-Based Clusters And Jobs On Google Cloud Platform.
-total resources: 12
-total selectable resources: 11
-total methods: 86
+total resources: 14
+total selectable resources: 14
+total methods: 99
@@ -33,7 +33,7 @@ Manages Hadoop-Based Clusters And Jobs On Google Cloud Platform. TypeService TitleCloud Dataproc API DescriptionManages Hadoop-Based Clusters And Jobs On Google Cloud Platform. -Iddataproc:v23.08.00161 +Iddataproc:v23.08.00163 ## Resources @@ -45,12 +45,14 @@ Manages Hadoop-Based Clusters And Jobs On Google Cloud Platform. clusters
clusters_iam_policies
jobs
+jobs_iam_policies
-jobs_iam_policies
node_groups
operations
operations_iam_policies
+session_templates
+sessions
workflow_templates
workflow_templates_iam_policies
diff --git a/docs/google-docs/providers/google/dataproc/jobs/index.md b/docs/google-docs/providers/google/dataproc/jobs/index.md index d937cf756f..761d7533aa 100644 --- a/docs/google-docs/providers/google/dataproc/jobs/index.md +++ b/docs/google-docs/providers/google/dataproc/jobs/index.md @@ -27,36 +27,36 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `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. | | `status` | `object` | Dataproc 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. | -| `sparkRJob` | `object` | A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. | -| `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. | -| `scheduling` | `object` | Job scheduling options. | -| `sparkSqlJob` | `object` | A Dataproc job for running Apache Spark SQL (https://spark.apache.org/sql/) queries. | -| `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. | -| `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. | | `placement` | `object` | Dataproc job config. | -| `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. | -| `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. | -| `pysparkJob` | `object` | A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. | -| `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. | -| `flinkJob` | `object` | A Dataproc job for running Apache Flink (https://flink.apache.org/) applications on YARN. | | `driverSchedulingConfig` | `object` | Driver scheduling configuration. | -| `statusHistory` | `array` | Output only. The previous job status. | -| `driverOutputResourceUri` | `string` | Output only. A URI pointing to the location of the stdout of the job's driver program. | -| `hiveJob` | `object` | A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. | | `pigJob` | `object` | A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. | | `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. | +| `pysparkJob` | `object` | A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. | +| `flinkJob` | `object` | A Dataproc job for running Apache Flink (https://flink.apache.org/) applications on YARN. | +| `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. | +| `driverOutputResourceUri` | `string` | Output only. A URI pointing to the location of the stdout of the job's driver program. | +| `scheduling` | `object` | Job scheduling options. | +| `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. | +| `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. | +| `statusHistory` | `array` | Output only. The previous job status. | +| `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. | +| `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. | +| `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. | +| `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. | +| `reference` | `object` | Encapsulates the full scoping used to reference a job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_regions_jobs_get` | `SELECT` | `jobId, projectId, region` | Gets the resource representation for a job in a project. | | `projects_regions_jobs_list` | `SELECT` | `projectId, region` | Lists regions/{region}/jobs in a project. | | `projects_regions_jobs_delete` | `DELETE` | `jobId, projectId, region` | Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION. | | `_projects_regions_jobs_list` | `EXEC` | `projectId, region` | Lists regions/{region}/jobs in a project. | | `projects_regions_jobs_cancel` | `EXEC` | `jobId, projectId, region` | Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get). | -| `projects_regions_jobs_get` | `EXEC` | `jobId, projectId, region` | Gets the resource representation for a job in a project. | | `projects_regions_jobs_patch` | `EXEC` | `jobId, projectId, region` | Updates a job in a project. | | `projects_regions_jobs_submit` | `EXEC` | `projectId, region` | Submits a job to a cluster. | | `projects_regions_jobs_submit_as_operation` | `EXEC` | `projectId, region` | Submits job to a cluster. | diff --git a/docs/google-docs/providers/google/dataproc/node_groups/index.md b/docs/google-docs/providers/google/dataproc/node_groups/index.md index 4f3937a9d1..ce7e8d4585 100644 --- a/docs/google-docs/providers/google/dataproc/node_groups/index.md +++ b/docs/google-docs/providers/google/dataproc/node_groups/index.md @@ -25,10 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The Node group resource name (https://aip.dev/122). | +| `nodeGroupConfig` | `object` | The config settings for Compute Engine resources in an instance group, such as a master or worker group. | +| `roles` | `array` | Required. Node group roles. | +| `labels` | `object` | Optional. Node group labels. Label keys must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values can be empty. If specified, they must consist of from 1 to 63 characters and conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). The node group must have no more than 32 labelsn. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_regions_clusters_node_groups_get` | `SELECT` | `clustersId, nodeGroupsId, projectsId, regionsId` | Gets the resource representation for a node group in a cluster. | | `projects_regions_clusters_node_groups_create` | `INSERT` | `clustersId, projectsId, regionsId` | Creates a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata). | -| `projects_regions_clusters_node_groups_get` | `EXEC` | `clustersId, nodeGroupsId, projectsId, regionsId` | Gets the resource representation for a node group in a cluster. | | `projects_regions_clusters_node_groups_resize` | `EXEC` | `clustersId, nodeGroupsId, projectsId, regionsId` | Resizes a node group in a cluster. The returned Operation.metadata is NodeGroupOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#nodegroupoperationmetadata). | diff --git a/docs/google-docs/providers/google/dataproc/operations/index.md b/docs/google-docs/providers/google/dataproc/operations/index.md index 7741109b96..96f3283ca9 100644 --- a/docs/google-docs/providers/google/dataproc/operations/index.md +++ b/docs/google-docs/providers/google/dataproc/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 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `projects_regions_operations_get` | `SELECT` | `operationsId, projectsId, regionsId` | 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. | | `projects_regions_operations_list` | `SELECT` | `projectsId, regionsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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. | | `projects_regions_operations_delete` | `DELETE` | `operationsId, projectsId, regionsId` | 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. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `_projects_regions_operations_list` | `EXEC` | `projectsId, regionsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | | `projects_regions_operations_cancel` | `EXEC` | `operationsId, projectsId, regionsId` | 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. | -| `projects_regions_operations_get` | `EXEC` | `operationsId, projectsId, regionsId` | 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. | diff --git a/docs/google-docs/providers/google/dataproc/session_templates/index.md b/docs/google-docs/providers/google/dataproc/session_templates/index.md new file mode 100644 index 0000000000..470d5b4e45 --- /dev/null +++ b/docs/google-docs/providers/google/dataproc/session_templates/index.md @@ -0,0 +1,47 @@ +--- +title: session_templates +hide_title: false +hide_table_of_contents: false +keywords: + - session_templates + - 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 + + + + +
Namesession_templates
TypeResource
Idgoogle.dataproc.session_templates
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Required. The resource name of the session template. | +| `description` | `string` | Optional. Brief description of the template. | +| `runtimeConfig` | `object` | Runtime configuration for a workload. | +| `updateTime` | `string` | Output only. The time template was last updated. | +| `createTime` | `string` | Output only. The time when the template was created. | +| `creator` | `string` | Output only. The email address of the user who created the template. | +| `jupyterSession` | `object` | Jupyter configuration for an interactive session. | +| `labels` | `object` | Optional. The labels to associate with sessions created using this template. 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 session. | +| `environmentConfig` | `object` | Environment configuration for a workload. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `projects_locations_session_templates_get` | `SELECT` | `locationsId, projectsId, sessionTemplatesId` | Gets the resource representation for a session template. | +| `projects_locations_session_templates_list` | `SELECT` | `locationsId, projectsId` | Lists session templates. | +| `projects_locations_session_templates_create` | `INSERT` | `locationsId, projectsId` | Create an session template, synchronously. | +| `projects_locations_session_templates_delete` | `DELETE` | `locationsId, projectsId, sessionTemplatesId` | Deletes a session template. | +| `_projects_locations_session_templates_list` | `EXEC` | `locationsId, projectsId` | Lists session templates. | +| `projects_locations_session_templates_patch` | `EXEC` | `locationsId, projectsId, sessionTemplatesId` | Updates the session template, synchronously.Disable check for update_mask, because all updates will be full replacements. | diff --git a/docs/google-docs/providers/google/dataproc/sessions/index.md b/docs/google-docs/providers/google/dataproc/sessions/index.md new file mode 100644 index 0000000000..b4c4cb9b62 --- /dev/null +++ b/docs/google-docs/providers/google/dataproc/sessions/index.md @@ -0,0 +1,54 @@ +--- +title: sessions +hide_title: false +hide_table_of_contents: false +keywords: + - sessions + - 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 + + + + +
Namesessions
TypeResource
Idgoogle.dataproc.sessions
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Required. The resource name of the session. | +| `user` | `string` | Optional. The email address of the user who owns the session. | +| `state` | `string` | Output only. A state of the session. | +| `stateTime` | `string` | Output only. The time when the session entered a current state. | +| `sessionTemplate` | `string` | Optional. The session template used by the session.Only resource names including project ID and location are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]Note that the template must be in the same project and Dataproc region. | +| `jupyterSession` | `object` | Jupyter configuration for an interactive session. | +| `stateHistory` | `array` | Output only. Historical state information for the session. | +| `labels` | `object` | Optional. The labels to associate with this session. 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 session. | +| `environmentConfig` | `object` | Environment configuration for a workload. | +| `uuid` | `string` | Output only. A session UUID (Unique Universal Identifier). The service generates this value when it creates the session. | +| `createTime` | `string` | Output only. The time when the session was created. | +| `stateMessage` | `string` | Output only. Session state details, such as a failure description if the state is FAILED. | +| `creator` | `string` | Output only. The email address of the user who created the session. | +| `runtimeConfig` | `object` | Runtime configuration for a workload. | +| `runtimeInfo` | `object` | Runtime information about workload execution. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `projects_locations_sessions_get` | `SELECT` | `locationsId, projectsId, sessionsId` | Gets the resource representation for an interactive session. | +| `projects_locations_sessions_list` | `SELECT` | `locationsId, projectsId` | Lists interactive sessions. | +| `projects_locations_sessions_create` | `INSERT` | `locationsId, projectsId` | Create an interactive session asynchronously. | +| `projects_locations_sessions_delete` | `DELETE` | `locationsId, projectsId, sessionsId` | Deletes the interactive session resource. If the session is not in terminal state, it will be terminated and deleted afterwards. | +| `_projects_locations_sessions_list` | `EXEC` | `locationsId, projectsId` | Lists interactive sessions. | +| `projects_locations_sessions_inject_credentials` | `EXEC` | `locationsId, projectsId, sessionsId` | Inject Credentials in the interactive session. | +| `projects_locations_sessions_terminate` | `EXEC` | `locationsId, projectsId, sessionsId` | Terminates the interactive session. | 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 580df50032..dd4cc37211 100644 --- a/docs/google-docs/providers/google/dataproc/workflow_templates/index.md +++ b/docs/google-docs/providers/google/dataproc/workflow_templates/index.md @@ -29,18 +29,20 @@ 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. | +| `placement` | `object` | Specifies workflow execution target.Either managed_cluster or cluster_selector is required. | | `updateTime` | `string` | Output only. The time template was last updated. | -| `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. | | `createTime` | `string` | Output only. The time template was created. | +| `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. | +| `jobs` | `array` | Required. The Directed Acyclic Graph of Jobs to submit. | | `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. | -| `parameters` | `array` | Optional. Template parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated. | -| `placement` | `object` | Specifies workflow execution target.Either managed_cluster or cluster_selector is required. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_workflow_templates_get` | `SELECT` | `locationsId, projectsId, workflowTemplatesId` | Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. | | `projects_locations_workflow_templates_list` | `SELECT` | `locationsId, projectsId` | Lists workflows that match the specified filter in the request. | +| `projects_regions_workflow_templates_get` | `SELECT` | `projectsId, regionsId, workflowTemplatesId` | Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. | | `projects_regions_workflow_templates_list` | `SELECT` | `projectsId, regionsId` | Lists workflows that match the specified filter in the request. | | `projects_locations_workflow_templates_create` | `INSERT` | `locationsId, projectsId` | Creates new workflow template. | | `projects_regions_workflow_templates_create` | `INSERT` | `projectsId, regionsId` | Creates new workflow template. | @@ -48,11 +50,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_regions_workflow_templates_delete` | `DELETE` | `projectsId, regionsId, workflowTemplatesId` | Deletes a workflow template. It does not cancel in-progress workflows. | | `_projects_locations_workflow_templates_list` | `EXEC` | `locationsId, projectsId` | Lists workflows that match the specified filter in the request. | | `_projects_regions_workflow_templates_list` | `EXEC` | `projectsId, regionsId` | Lists workflows that match the specified filter in the request. | -| `projects_locations_workflow_templates_get` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. | | `projects_locations_workflow_templates_instantiate` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | | `projects_locations_workflow_templates_instantiate_inline` | `EXEC` | `locationsId, projectsId` | Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | | `projects_locations_workflow_templates_update` | `EXEC` | `locationsId, projectsId, workflowTemplatesId` | Updates (replaces) workflow template. The updated template must contain version that matches the current server version. | -| `projects_regions_workflow_templates_get` | `EXEC` | `projectsId, regionsId, workflowTemplatesId` | Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter. | | `projects_regions_workflow_templates_instantiate` | `EXEC` | `projectsId, regionsId, workflowTemplatesId` | Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | | `projects_regions_workflow_templates_instantiate_inline` | `EXEC` | `projectsId, regionsId` | Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty. | | `projects_regions_workflow_templates_update` | `EXEC` | `projectsId, regionsId, workflowTemplatesId` | Updates (replaces) workflow template. The updated template must contain version that matches the current server version. | diff --git a/docs/google-docs/providers/google/dataproc/workflow_templates_iam_policies/index.md b/docs/google-docs/providers/google/dataproc/workflow_templates_iam_policies/index.md index afc6294c2e..0d7acd228d 100644 --- a/docs/google-docs/providers/google/dataproc/workflow_templates_iam_policies/index.md +++ b/docs/google-docs/providers/google/dataproc/workflow_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 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/datastore/index.md b/docs/google-docs/providers/google/datastore/index.md index 11ad856e0c..bd4e7586f0 100644 --- a/docs/google-docs/providers/google/datastore/index.md +++ b/docs/google-docs/providers/google/datastore/index.md @@ -33,7 +33,7 @@ Accesses The Schemaless NoSQL Database To Provide Fully Managed, Robust, Scalabl TypeService TitleCloud Datastore API DescriptionAccesses The Schemaless NoSQL Database To Provide Fully Managed, Robust, Scalable Storage For Your Application. -Iddatastore:v23.08.00161 +Iddatastore:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datastore/indexes/index.md b/docs/google-docs/providers/google/datastore/indexes/index.md index 2059c35780..b09aea9c0b 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 | |:-----|:---------|:------------| -| `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 ab4fb5913a..e8d9c26127 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}`. | -| `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/datastream/connection_profiles/index.md b/docs/google-docs/providers/google/datastream/connection_profiles/index.md index 95eae2af8d..33d4c03e00 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. | +| `updateTime` | `string` | Output only. The update time of the resource. | +| `labels` | `object` | Labels. | +| `createTime` | `string` | Output only. The create time of the resource. | +| `gcsProfile` | `object` | Cloud Storage bucket profile. | | `postgresqlProfile` | `object` | PostgreSQL database profile. | -| `mysqlProfile` | `object` | MySQL database profile. | | `displayName` | `string` | Required. Display name. | +| `privateConnectivity` | `object` | Private Connectivity | | `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. | -| `updateTime` | `string` | Output only. The update time of the resource. | | `oracleProfile` | `object` | Oracle database profile. | -| `gcsProfile` | `object` | Cloud Storage bucket profile. | -| `createTime` | `string` | Output only. The create time of the resource. | -| `labels` | `object` | Labels. | +| `mysqlProfile` | `object` | MySQL database profile. | | `bigqueryProfile` | `object` | BigQuery warehouse profile. | | `forwardSshConnectivity` | `object` | Forward SSH Tunnel connectivity. | -| `privateConnectivity` | `object` | Private Connectivity | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/datastream/index.md b/docs/google-docs/providers/google/datastream/index.md index 40e342d986..69b8c60bb8 100644 --- a/docs/google-docs/providers/google/datastream/index.md +++ b/docs/google-docs/providers/google/datastream/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleDatastream API Description -Iddatastream:v23.08.00161 +Iddatastream:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/datastream/locations/index.md b/docs/google-docs/providers/google/datastream/locations/index.md index cc9fca3976..86171c9990 100644 --- a/docs/google-docs/providers/google/datastream/locations/index.md +++ b/docs/google-docs/providers/google/datastream/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/datastream/operations/index.md b/docs/google-docs/providers/google/datastream/operations/index.md index 1fbd56b142..0e9f0f9f18 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}`. | -| `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/datastream/private_connections/index.md b/docs/google-docs/providers/google/datastream/private_connections/index.md index ec8402ad9e..4e31296384 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. | -| `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. | +| `labels` | `object` | Labels. | ## 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..ba65aea56f 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. | -| `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. | +| `updateTime` | `string` | Output only. The update time of the resource. | ## 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 5b8e051a52..ae1443eff9 100644 --- a/docs/google-docs/providers/google/datastream/streams/index.md +++ b/docs/google-docs/providers/google/datastream/streams/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The stream's name. | +| `createTime` | `string` | Output only. The creation time of the stream. | | `labels` | `object` | Labels. | -| `state` | `string` | The state of the stream. | -| `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. | +| `backfillAll` | `object` | Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. | | `sourceConfig` | `object` | The configuration of the stream source. | -| `createTime` | `string` | Output only. The creation time of the stream. | | `destinationConfig` | `object` | The configuration of the stream destination. | -| `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. | | `errors` | `array` | Output only. Errors on the Stream. | -| `updateTime` | `string` | Output only. The last update time of the stream. | +| `state` | `string` | The state of the stream. | +| `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. | | `displayName` | `string` | Required. Display name. | +| `updateTime` | `string` | Output only. The last update time of the stream. | ## 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 1fe7eb2a7c..256786e5bc 100644 --- a/docs/google-docs/providers/google/deploymentmanager/deployments/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/deployments/index.md @@ -30,13 +30,13 @@ 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. | -| `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | -| `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. | | `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | -| `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. | -| `target` | `object` | | -| `selfLink` | `string` | Output only. Server defined URL for the resource. | +| `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. | | `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 `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. | +| `selfLink` | `string` | Output only. Server defined URL for the resource. | +| `target` | `object` | | +| `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | | `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. | ## Methods diff --git a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md b/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md index a5d030ecf2..ff8806523e 100644 --- a/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/deployments_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/deploymentmanager/index.md b/docs/google-docs/providers/google/deploymentmanager/index.md index 47e77db035..606ae462aa 100644 --- a/docs/google-docs/providers/google/deploymentmanager/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/index.md @@ -33,7 +33,7 @@ The Google Cloud Deployment Manager V2 API Provides Services For Configuring, De TypeService TitleCloud Deployment Manager V2 API DescriptionThe Google Cloud Deployment Manager V2 API Provides Services For Configuring, Deploying, And Viewing Google Cloud Services And APIs Via Templates Which Specify Deployments Of Cloud Resources. -Iddeploymentmanager:v23.08.00161 +Iddeploymentmanager:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/deploymentmanager/manifests/index.md b/docs/google-docs/providers/google/deploymentmanager/manifests/index.md index 2664152001..ec5b1e6e24 100644 --- a/docs/google-docs/providers/google/deploymentmanager/manifests/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/manifests/index.md @@ -29,14 +29,14 @@ 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. | -| `imports` | `array` | Output only. The imported files for this manifest. | | `manifestSizeLimitBytes` | `string` | Output only. The size limit for expanded manifests in the project. | +| `selfLink` | `string` | Output only. Self link for the manifest. | | `config` | `object` | | -| `manifestSizeBytes` | `string` | Output only. The computed size of the fully expanded 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. | +| `imports` | `array` | Output only. The imported files for this manifest. | +| `manifestSizeBytes` | `string` | Output only. The computed size of the fully expanded manifest. | | `layout` | `string` | Output only. The YAML layout for this manifest. | +| `expandedConfig` | `string` | Output only. The fully-expanded configuration file, including any templates and references. | ## 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 5337df8886..6c83461de4 100644 --- a/docs/google-docs/providers/google/deploymentmanager/operations/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/operations/index.md @@ -30,26 +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. | -| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | -| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | +| `instancesBulkInsertOperationMetadata` | `object` | | | `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. | -| `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. | | `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. | -| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | -| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | -| `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. | +| `operationType` | `string` | [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. | +| `setCommonInstanceMetadataOperationMetadata` | `object` | | | `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. | +| `selfLink` | `string` | [Output Only] Server-defined URL for the resource. | +| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | | `warnings` | `array` | [Output Only] If warning messages are generated during processing of the operation, this field will be populated. | | `kind` | `string` | [Output Only] Type of the resource. Always `compute#operation` for Operation resources. | -| `zone` | `string` | [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. | -| `error` | `object` | [Output Only] If errors are generated during processing of the operation, this field will be populated. | -| `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. | -| `user` | `string` | [Output Only] User who requested the operation, for example: `user@example.com`. | +| `statusMessage` | `string` | [Output Only] An optional textual description of the current status of the operation. | +| `endTime` | `string` | [Output Only] The time that this operation was completed. This value is in RFC3339 text format. | | `creationTimestamp` | `string` | [Deprecated] This field is deprecated. | -| `selfLink` | `string` | [Output Only] Server-defined URL for the 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)`. | +| `startTime` | `string` | [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. | +| `targetId` | `string` | [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. | +| `insertTime` | `string` | [Output Only] The time that this operation was requested. This value is in RFC3339 text format. | +| `clientOperationId` | `string` | [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. | +| `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. | +| `status` | `string` | [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. | | `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/deploymentmanager/resources/index.md b/docs/google-docs/providers/google/deploymentmanager/resources/index.md index c9af36c34e..8261d94121 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. | +| `properties` | `string` | Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. | | `updateTime` | `string` | Output only. Update timestamp in RFC3339 text format. | -| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | | `update` | `object` | | +| `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | +| `accessControl` | `object` | The access controls set on the resource. | | `url` | `string` | Output only. The URL of the actual resource. | -| `type` | `string` | Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`. | -| `properties` | `string` | Output only. The current properties of the resource before any references have been filled in. Returned as serialized YAML. | +| `manifest` | `string` | Output only. URL of the manifest representing the current configuration of this resource. | | `finalProperties` | `string` | Output only. The evaluated properties of the resource with references expanded. Returned as serialized YAML. | | `warnings` | `array` | Output only. If warning messages are generated during processing of this resource, this field will be populated. | -| `accessControl` | `object` | The access controls set on the resource. | -| `manifest` | `string` | Output only. URL of the manifest representing the current configuration of this resource. | +| `type` | `string` | Output only. The type of the resource, for example `compute.v1.instance`, or `cloudfunctions.v1beta1.function`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/deploymentmanager/types/index.md b/docs/google-docs/providers/google/deploymentmanager/types/index.md index 94b2a6ed1c..b4273e7cfe 100644 --- a/docs/google-docs/providers/google/deploymentmanager/types/index.md +++ b/docs/google-docs/providers/google/deploymentmanager/types/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `id` | `string` | | | `name` | `string` | Name of the type. | -| `selfLink` | `string` | Output only. Server defined URL for the resource. | | `insertTime` | `string` | Output only. Creation timestamp in RFC3339 text format. | -| `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. | +| `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 `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. | +| `selfLink` | `string` | Output only. Server defined URL for the resource. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/dialogflow/agents/index.md b/docs/google-docs/providers/google/dialogflow/agents/index.md index edfd3f0205..97dcb4e4b1 100644 --- a/docs/google-docs/providers/google/dialogflow/agents/index.md +++ b/docs/google-docs/providers/google/dialogflow/agents/index.md @@ -30,19 +30,19 @@ 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. | | `enableSpellCorrection` | `boolean` | Indicates if automatic spell correction is enabled in detect intent requests. | -| `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/`. | | `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. | -| `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. | +| `securitySettings` | `string` | Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. | | `speechToTextSettings` | `object` | Settings related to speech recognition. | -| `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. | +| `textToSpeechSettings` | `object` | Settings related to speech synthesizing. | +| `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. | +| `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. | +| `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. | | `supportedLanguageCodes` | `array` | The list of all languages supported by the agent (except for the `default_language_code`). | -| `securitySettings` | `string` | Name of the SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. | | `gitIntegrationSettings` | `object` | Settings for connecting to Git repository for an agent. | -| `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. | +| `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/`. | +| `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. | | `enableStackdriverLogging` | `boolean` | Indicates if stackdriver logging is enabled for the agent. Please use agent.advanced_settings instead. | -| `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. | ## 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..51f5a7add9 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/. | +| `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. | | `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/. | ## 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 a97cb883be..34216c315b 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. | +| `lastUpdateTime` | `string` | Last update time of this experiment. | | `rolloutState` | `object` | State of the auto-rollout process. | -| `startTime` | `string` | Start time of this experiment. | -| `variantsHistory` | `array` | The history of updates to the experiment variants. | +| `definition` | `object` | Definition of the experiment. | | `rolloutConfig` | `object` | The configuration for auto rollout. | | `result` | `object` | The inference result which includes an objective metric to optimize and the confidence interval. | +| `startTime` | `string` | Start time of this experiment. | +| `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. | +| `variantsHistory` | `array` | The history of updates to the experiment variants. | | `endTime` | `string` | End time of this experiment. | +| `displayName` | `string` | Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters. | | `createTime` | `string` | Creation time of this experiment. | | `rolloutFailureReason` | `string` | The reason why rollout has failed. Should only be set when state is ROLLOUT_FAILED. | -| `displayName` | `string` | Required. The human-readable name of the experiment (unique in an environment). Limit of 64 characters. | -| `definition` | `object` | Definition of the experiment. | -| `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. | | `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. | -| `lastUpdateTime` | `string` | Last update time of this experiment. | ## 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/index.md b/docs/google-docs/providers/google/dialogflow/index.md index b30a168af7..578e20cfa9 100644 --- a/docs/google-docs/providers/google/dialogflow/index.md +++ b/docs/google-docs/providers/google/dialogflow/index.md @@ -33,7 +33,7 @@ Builds Conversational Interfaces (For Example, Chatbots, And Voice-Powered Apps TypeService TitleDialogflow API DescriptionBuilds Conversational Interfaces (For Example, Chatbots, And Voice-Powered Apps And Devices). -Iddialogflow:v23.08.00161 +Iddialogflow:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/dialogflow/intents/index.md b/docs/google-docs/providers/google/dialogflow/intents/index.md index e5e5f96035..8e325e98a6 100644 --- a/docs/google-docs/providers/google/dialogflow/intents/index.md +++ b/docs/google-docs/providers/google/dialogflow/intents/index.md @@ -38,9 +38,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_agents_intents_get` | `SELECT` | `agentsId, intentsId, locationsId, projectsId` | Retrieves the specified intent. | | `projects_locations_agents_intents_list` | `SELECT` | `agentsId, locationsId, projectsId` | Returns the list of all intents in the specified agent. | | `projects_locations_agents_intents_create` | `INSERT` | `agentsId, locationsId, projectsId` | Creates an intent in the specified agent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `projects_locations_agents_intents_delete` | `DELETE` | `agentsId, intentsId, locationsId, projectsId` | Deletes the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | | `_projects_locations_agents_intents_list` | `EXEC` | `agentsId, locationsId, projectsId` | Returns the list of all intents in the specified agent. | -| `projects_locations_agents_intents_get` | `EXEC` | `agentsId, intentsId, locationsId, projectsId` | Retrieves the specified intent. | | `projects_locations_agents_intents_patch` | `EXEC` | `agentsId, intentsId, locationsId, projectsId` | Updates the specified intent. Note: You should always train a flow prior to sending it queries. See the [training documentation](https://cloud.google.com/dialogflow/cx/docs/concept/training). | diff --git a/docs/google-docs/providers/google/dialogflow/locations/index.md b/docs/google-docs/providers/google/dialogflow/locations/index.md index df3c462af9..4917b0a5b3 100644 --- a/docs/google-docs/providers/google/dialogflow/locations/index.md +++ b/docs/google-docs/providers/google/dialogflow/locations/index.md @@ -28,13 +28,13 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/dialogflow/operations/index.md b/docs/google-docs/providers/google/dialogflow/operations/index.md index af103f57fc..4455ae73ad 100644 --- a/docs/google-docs/providers/google/dialogflow/operations/index.md +++ b/docs/google-docs/providers/google/dialogflow/operations/index.md @@ -28,18 +28,18 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `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. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | | `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. 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`. | -| `projects_operations_get` | `EXEC` | `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. | diff --git a/docs/google-docs/providers/google/dialogflow/pages/index.md b/docs/google-docs/providers/google/dialogflow/pages/index.md index abd33b49d4..4c69d918d2 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/`. | -| `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. | | `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. | ## 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 9c49a58471..41ebc7190c 100644 --- a/docs/google-docs/providers/google/dialogflow/security_settings/index.md +++ b/docs/google-docs/providers/google/dialogflow/security_settings/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 settings. Required for the SecuritySettingsService.UpdateSecuritySettings method. SecuritySettingsService.CreateSecuritySettings populates the name automatically. Format: `projects//locations//securitySettings/`. | -| `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. | +| `audioExportSettings` | `object` | Settings for exporting audio. | +| `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`. | | `redactionStrategy` | `string` | Strategy that defines how we do redaction. | +| `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. | -| `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`. | | `insightsExportSettings` | `object` | Settings for exporting conversations to [Insights](https://cloud.google.com/contact-center/insights/docs). | | `purgeDataTypes` | `array` | List of types of data to remove when retention settings triggers purge. | -| `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`. | -| `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. | ## 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 6dd6beb5c0..4a472731dc 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/`. | -| `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. | | `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. | ## 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 3175e7b34f..4a549284e5 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/` . | -| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dialogflow/versions/index.md b/docs/google-docs/providers/google/dialogflow/versions/index.md index 79cd9c731d..b7cae421a1 100644 --- a/docs/google-docs/providers/google/dialogflow/versions/index.md +++ b/docs/google-docs/providers/google/dialogflow/versions/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Format: projects//locations//agents//flows//versions/. Version ID is a self-increasing number generated by Dialogflow upon version creation. | | `description` | `string` | The description of the version. The maximum length is 500 characters. If exceeded, the request is rejected. | -| `displayName` | `string` | Required. The human-readable name of the version. Limit of 64 characters. | | `nluSettings` | `object` | Settings related to NLU. | | `state` | `string` | Output only. The state of this version. This field is read-only and cannot be set by create and update methods. | | `createTime` | `string` | Output only. Create time of the version. | +| `displayName` | `string` | Required. The human-readable name of the version. Limit of 64 characters. | ## 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 87725ccc64..47f156b8ef 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/conversations/index.md b/docs/google-docs/providers/google/discoveryengine/conversations/index.md index 4d62733cb8..0bb43b01d3 100644 --- a/docs/google-docs/providers/google/discoveryengine/conversations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/conversations/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 `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` | -| `startTime` | `string` | Output only. The time the conversation started. | -| `state` | `string` | The state of the Conversation. | | `userPseudoId` | `string` | A unique identifier for tracking users. | | `endTime` | `string` | Output only. The time the conversation finished. | | `messages` | `array` | Conversation messages. | +| `startTime` | `string` | Output only. The time the conversation started. | +| `state` | `string` | The state of the Conversation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/discoveryengine/data_store_operations/index.md b/docs/google-docs/providers/google/discoveryengine/data_store_operations/index.md new file mode 100644 index 0000000000..50fcb8318e --- /dev/null +++ b/docs/google-docs/providers/google/discoveryengine/data_store_operations/index.md @@ -0,0 +1,38 @@ +--- +title: data_store_operations +hide_title: false +hide_table_of_contents: false +keywords: + - data_store_operations + - discoveryengine + - google + - stackql + - infrastructure-as-code + - configuration-as-data + - cloud inventory +description: Query, deploy and manage 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_store_operations
TypeResource
Idgoogle.discoveryengine.data_store_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}`. | +| `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 | +|:-----|:--------------|:----------------| +| `projects_locations_collections_data_stores_operations_get` | `SELECT` | `collectionsId, dataStoresId, locationsId, operationsId, projectsId` | diff --git a/docs/google-docs/providers/google/discoveryengine/documents/index.md b/docs/google-docs/providers/google/discoveryengine/documents/index.md index 4f874400ea..2cca510693 100644 --- a/docs/google-docs/providers/google/discoveryengine/documents/index.md +++ b/docs/google-docs/providers/google/discoveryengine/documents/index.md @@ -29,16 +29,18 @@ 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. | +| `derivedStructData` | `object` | Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. | | `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. | | `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. | | `content` | `object` | Unstructured data linked to this document. | -| `derivedStructData` | `object` | Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_collections_data_stores_branches_documents_get` | `SELECT` | `branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId` | Gets a Document. | | `projects_locations_collections_data_stores_branches_documents_list` | `SELECT` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Gets a list of Documents. | +| `projects_locations_data_stores_branches_documents_get` | `SELECT` | `branchesId, dataStoresId, documentsId, locationsId, projectsId` | Gets a Document. | | `projects_locations_data_stores_branches_documents_list` | `SELECT` | `branchesId, dataStoresId, locationsId, projectsId` | Gets a list of Documents. | | `projects_locations_collections_data_stores_branches_documents_create` | `INSERT` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Creates a Document. | | `projects_locations_data_stores_branches_documents_create` | `INSERT` | `branchesId, dataStoresId, locationsId, projectsId` | Creates a Document. | @@ -46,11 +48,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_data_stores_branches_documents_delete` | `DELETE` | `branchesId, dataStoresId, documentsId, locationsId, projectsId` | Deletes a Document. | | `_projects_locations_collections_data_stores_branches_documents_list` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Gets a list of Documents. | | `_projects_locations_data_stores_branches_documents_list` | `EXEC` | `branchesId, dataStoresId, locationsId, projectsId` | Gets a list of Documents. | -| `projects_locations_collections_data_stores_branches_documents_get` | `EXEC` | `branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId` | Gets a Document. | | `projects_locations_collections_data_stores_branches_documents_import` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. | | `projects_locations_collections_data_stores_branches_documents_patch` | `EXEC` | `branchesId, collectionsId, dataStoresId, documentsId, locationsId, projectsId` | Updates a Document. | | `projects_locations_collections_data_stores_branches_documents_purge` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. | -| `projects_locations_data_stores_branches_documents_get` | `EXEC` | `branchesId, dataStoresId, documentsId, locationsId, projectsId` | Gets a Document. | | `projects_locations_data_stores_branches_documents_import` | `EXEC` | `branchesId, dataStoresId, locationsId, projectsId` | Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. | | `projects_locations_data_stores_branches_documents_patch` | `EXEC` | `branchesId, dataStoresId, documentsId, locationsId, projectsId` | Updates a Document. | | `projects_locations_data_stores_branches_documents_purge` | `EXEC` | `branchesId, dataStoresId, locationsId, projectsId` | Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. | diff --git a/docs/google-docs/providers/google/discoveryengine/index.md b/docs/google-docs/providers/google/discoveryengine/index.md index 0bdcfa6935..4ed1752379 100644 --- a/docs/google-docs/providers/google/discoveryengine/index.md +++ b/docs/google-docs/providers/google/discoveryengine/index.md @@ -19,8 +19,8 @@ Discovery Engine API.
-total resources: 9
-total selectable resources: 6
+total resources: 10
+total selectable resources: 7
total methods: 93
@@ -33,19 +33,20 @@ Discovery Engine API. TypeService TitleDiscovery Engine API DescriptionDiscovery Engine API. -Iddiscoveryengine:v23.08.00161 +Iddiscoveryengine:v23.08.00163 ## Resources
conversations
+data_store_operations
data_stores
documents
operations
-schemas
+schemas
search_engine_operations
serving_configs
target_site_operations
diff --git a/docs/google-docs/providers/google/discoveryengine/operations/index.md b/docs/google-docs/providers/google/discoveryengine/operations/index.md index d181f0249b..65aa58a877 100644 --- a/docs/google-docs/providers/google/discoveryengine/operations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/operations/index.md @@ -35,16 +35,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_collections_data_stores_branches_operations_get` | `SELECT` | `branchesId, collectionsId, dataStoresId, locationsId, 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. | | `projects_locations_collections_data_stores_branches_operations_list` | `SELECT` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_collections_data_stores_models_operations_get` | `SELECT` | `collectionsId, dataStoresId, locationsId, modelsId, 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. | | `projects_locations_collections_data_stores_models_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, modelsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_collections_data_stores_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_collections_data_stores_schemas_operations_get` | `SELECT` | `collectionsId, dataStoresId, locationsId, operationsId, projectsId, schemasId` | 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. | | `projects_locations_collections_data_stores_schemas_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId, schemasId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_collections_engines_operations_get` | `SELECT` | `collectionsId, enginesId, locationsId, 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. | | `projects_locations_collections_engines_operations_list` | `SELECT` | `collectionsId, enginesId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_collections_operations_get` | `SELECT` | `collectionsId, locationsId, 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. | | `projects_locations_collections_operations_list` | `SELECT` | `collectionsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_data_stores_branches_operations_get` | `SELECT` | `branchesId, dataStoresId, locationsId, 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. | | `projects_locations_data_stores_branches_operations_list` | `SELECT` | `branchesId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_data_stores_models_operations_get` | `SELECT` | `dataStoresId, locationsId, modelsId, 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. | | `projects_locations_data_stores_models_operations_list` | `SELECT` | `dataStoresId, locationsId, modelsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_data_stores_operations_get` | `SELECT` | `dataStoresId, locationsId, 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. | | `projects_locations_data_stores_operations_list` | `SELECT` | `dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `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. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_collections_data_stores_branches_operations_list` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_collections_data_stores_models_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, modelsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | @@ -57,16 +67,3 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_projects_locations_data_stores_operations_list` | `EXEC` | `dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `projects_locations_collections_data_stores_branches_operations_get` | `EXEC` | `branchesId, collectionsId, dataStoresId, locationsId, 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. | -| `projects_locations_collections_data_stores_models_operations_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, modelsId, 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. | -| `projects_locations_collections_data_stores_operations_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, 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. | -| `projects_locations_collections_data_stores_schemas_operations_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, operationsId, projectsId, schemasId` | 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. | -| `projects_locations_collections_data_stores_site_search_engine_operations_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, 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. | -| `projects_locations_collections_data_stores_site_search_engine_target_sites_operations_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, 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. | -| `projects_locations_collections_engines_operations_get` | `EXEC` | `collectionsId, enginesId, locationsId, 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. | -| `projects_locations_collections_operations_get` | `EXEC` | `collectionsId, locationsId, 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. | -| `projects_locations_data_stores_branches_operations_get` | `EXEC` | `branchesId, dataStoresId, locationsId, 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. | -| `projects_locations_data_stores_models_operations_get` | `EXEC` | `dataStoresId, locationsId, modelsId, 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. | -| `projects_locations_data_stores_operations_get` | `EXEC` | `dataStoresId, locationsId, 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. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | -| `projects_operations_get` | `EXEC` | `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. | diff --git a/docs/google-docs/providers/google/discoveryengine/schemas/index.md b/docs/google-docs/providers/google/discoveryengine/schemas/index.md index bd45360c99..f3e27b6564 100644 --- a/docs/google-docs/providers/google/discoveryengine/schemas/index.md +++ b/docs/google-docs/providers/google/discoveryengine/schemas/index.md @@ -28,12 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. | -| `jsonSchema` | `string` | The JSON representation of the schema. | | `structSchema` | `object` | The structured representation of the schema. | +| `jsonSchema` | `string` | The JSON representation of the schema. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_collections_data_stores_schemas_get` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId, schemasId` | Gets a Schema. | | `projects_locations_collections_data_stores_schemas_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | Gets a list of Schemas. | +| `projects_locations_data_stores_schemas_get` | `SELECT` | `dataStoresId, locationsId, projectsId, schemasId` | Gets a Schema. | | `projects_locations_data_stores_schemas_list` | `SELECT` | `dataStoresId, locationsId, projectsId` | Gets a list of Schemas. | | `projects_locations_collections_data_stores_schemas_create` | `INSERT` | `collectionsId, dataStoresId, locationsId, projectsId` | Creates a Schema. | | `projects_locations_data_stores_schemas_create` | `INSERT` | `dataStoresId, locationsId, projectsId` | Creates a Schema. | @@ -41,7 +43,5 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_data_stores_schemas_delete` | `DELETE` | `dataStoresId, locationsId, projectsId, schemasId` | Deletes a Schema. | | `_projects_locations_collections_data_stores_schemas_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | Gets a list of Schemas. | | `_projects_locations_data_stores_schemas_list` | `EXEC` | `dataStoresId, locationsId, projectsId` | Gets a list of Schemas. | -| `projects_locations_collections_data_stores_schemas_get` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId, schemasId` | Gets a Schema. | | `projects_locations_collections_data_stores_schemas_patch` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId, schemasId` | Updates a Schema. | -| `projects_locations_data_stores_schemas_get` | `EXEC` | `dataStoresId, locationsId, projectsId, schemasId` | Gets a Schema. | | `projects_locations_data_stores_schemas_patch` | `EXEC` | `dataStoresId, locationsId, projectsId, schemasId` | Updates a Schema. | diff --git a/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md b/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md index 2beec868a4..3c6c065294 100644 --- a/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md +++ b/docs/google-docs/providers/google/discoveryengine/search_engine_operations/index.md @@ -33,7 +33,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `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 | -|:-----|:--------------|:----------------| -| `projects_locations_collections_data_stores_site_search_engine_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | -| `_projects_locations_collections_data_stores_site_search_engine_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `projects_locations_collections_data_stores_site_search_engine_operations_get` | `SELECT` | `collectionsId, dataStoresId, locationsId, 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. | +| `projects_locations_collections_data_stores_site_search_engine_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_data_stores_site_search_engine_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | 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..617cee8271 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,12 +28,13 @@ 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 | -|:-----|:--------------|:----------------| -| `projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | -| `_projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `projects_locations_collections_data_stores_site_search_engine_target_sites_operations_get` | `SELECT` | `collectionsId, dataStoresId, locationsId, 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. | +| `projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list` | `SELECT` | `collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `_projects_locations_collections_data_stores_site_search_engine_target_sites_operations_list` | `EXEC` | `collectionsId, dataStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | 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 c173255ec1..9a35f05534 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). | -| `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. | | `deidentifyConfig` | `object` | The configuration that controls how the data will change. | +| `displayName` | `string` | Display name (max 256 chars). | ## 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 cb7822ed64..42b6b1e07c 100644 --- a/docs/google-docs/providers/google/dlp/dlp_jobs/index.md +++ b/docs/google-docs/providers/google/dlp/dlp_jobs/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The server-assigned name. | -| `actionDetails` | `array` | Events that should occur after the job has completed. | -| `inspectDetails` | `object` | The results of an inspect DataSource job. | -| `endTime` | `string` | Time when the job finished. | +| `state` | `string` | State of a job. | | `riskDetails` | `object` | Result of a risk analysis operation request. | -| `type` | `string` | The type of job. | | `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. | +| `type` | `string` | The type of job. | | `createTime` | `string` | Time when the job was created. | +| `inspectDetails` | `object` | The results of an inspect DataSource job. | +| `actionDetails` | `array` | Events that should occur after the job has completed. | | `errors` | `array` | A stream of errors encountered running the job. | -| `jobTriggerName` | `string` | If created by a job trigger, the resource name of the trigger that instantiated the job. | -| `state` | `string` | State of a job. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dlp/index.md b/docs/google-docs/providers/google/dlp/index.md index 62f69d1812..70e13b547a 100644 --- a/docs/google-docs/providers/google/dlp/index.md +++ b/docs/google-docs/providers/google/dlp/index.md @@ -33,7 +33,7 @@ Provides Methods For Detection, Risk Analysis, And De-Identification Of Privacy- TypeService TitleCloud Data Loss Prevention (DLP) DescriptionProvides Methods For Detection, Risk Analysis, And De-Identification Of Privacy-Sensitive Fragments In Text, Images, And Google Cloud Platform Storage Repositories. -Iddlp:v23.08.00161 +Iddlp:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/dlp/inspect_templates/index.md b/docs/google-docs/providers/google/dlp/inspect_templates/index.md index 3e50dbcd0a..5aaf089a90 100644 --- a/docs/google-docs/providers/google/dlp/inspect_templates/index.md +++ b/docs/google-docs/providers/google/dlp/inspect_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/inspectTemplates/TEMPLATE_ID` OR `organizations/ORGANIZATION_ID/inspectTemplates/TEMPLATE_ID`; | | `description` | `string` | Short description (max 256 chars). | -| `createTime` | `string` | Output only. The creation timestamp of an inspectTemplate. | | `displayName` | `string` | Display name (max 256 chars). | | `inspectConfig` | `object` | Configuration description of the scanning process. When used with redactContent only info_types and min_likelihood are currently used. | | `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/job_triggers/index.md b/docs/google-docs/providers/google/dlp/job_triggers/index.md index a9521cd148..3435bca3b3 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) | -| `displayName` | `string` | Display name (max 100 chars) | | `lastRunTime` | `string` | Output only. The timestamp of the last time this trigger executed. | +| `inspectJob` | `object` | Controls what and how to inspect for findings. | | `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) | | `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. | -| `inspectJob` | `object` | Controls what and how to inspect for findings. | -| `updateTime` | `string` | Output only. The last update timestamp of a triggeredJob. | | `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. | -| `createTime` | `string` | Output only. The creation timestamp of a triggeredJob. | +| `updateTime` | `string` | Output only. The last update timestamp of a triggeredJob. | ## 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 c83649140a..5602f2bafd 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. | -| `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. | +| `pendingVersions` | `array` | Pending versions of the stored info type. Empty if no versions are pending. | ## 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 a288678fb9..9708808826 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). | +| `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. | | `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. | ## 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 92cf66d3b9..e99bbb5828 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. | +| `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. | +| `keyLength` | `integer` | Length of the key in bits. Specified at creation time, and then immutable. | | `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. | -| `algorithm` | `string` | String mnemonic specifying the DNSSEC algorithm of this key. Immutable after creation time. | -| `kind` | `string` | | | `publicKey` | `string` | Base64 encoded public half of this key. Output only. | -| `keyLength` | `integer` | Length of the key in bits. Specified at creation time, and then immutable. | +| `algorithm` | `string` | String mnemonic specifying the DNSSEC algorithm of this key. 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. | -| `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. | +| `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. | -| `creationTime` | `string` | The time that this resource was created in the control plane. This is in RFC3339 text format. Output only. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/index.md b/docs/google-docs/providers/google/dns/index.md index a63521afd2..d5b02e56d1 100644 --- a/docs/google-docs/providers/google/dns/index.md +++ b/docs/google-docs/providers/google/dns/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleCloud DNS API Description -Iddns:v23.08.00161 +Iddns:v23.08.00163 ## Resources 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 9bfb46a293..450a4c8976 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) | +| `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) | | `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). | ## 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 1ead2644e3..b76f142c16 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) | +| `cloudLoggingConfig` | `object` | Cloud Logging configurations for publicly visible zones. | | `dnsName` | `string` | The DNS name of this managed zone, for instance "example.com.". | -| `labels` | `object` | User labels. | -| `visibility` | `string` | The zone's visibility: public zones are exposed to the Internet, while private zones are visible only to Virtual Private Cloud resources. | -| `dnssecConfig` | `object` | | | `kind` | `string` | | -| `privateVisibilityConfig` | `object` | | | `peeringConfig` | `object` | | -| `nameServers` | `array` | Delegate your managed_zone to these virtual name servers; defined by the server (output only) | -| `serviceDirectoryConfig` | `object` | Contains information about Service Directory-backed zones. | -| `cloudLoggingConfig` | `object` | Cloud Logging configurations for publicly visible zones. | -| `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. | -| `creationTime` | `string` | The time that this resource was created on the server. This is in RFC3339 text format. Output only. | +| `dnssecConfig` | `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. | | `forwardingConfig` | `object` | | +| `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. | +| `serviceDirectoryConfig` | `object` | Contains information about Service Directory-backed zones. | | `reverseLookupConfig` | `object` | | +| `creationTime` | `string` | The time that this resource was created on the server. This is in RFC3339 text format. Output only. | +| `labels` | `object` | User labels. | +| `privateVisibilityConfig` | `object` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 3a90a32851..26f5ed05ec 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/policies/index.md b/docs/google-docs/providers/google/dns/policies/index.md index 780871a287..478b04d9b6 100644 --- a/docs/google-docs/providers/google/dns/policies/index.md +++ b/docs/google-docs/providers/google/dns/policies/index.md @@ -30,11 +30,11 @@ 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 policy. | | `description` | `string` | A mutable string of at most 1024 characters associated with this resource for the user's convenience. Has no effect on the policy's function. | +| `kind` | `string` | | | `networks` | `array` | List of network names specifying networks to which this policy is applied. | | `alternativeNameServerConfig` | `object` | | | `enableInboundForwarding` | `boolean` | Allows networks bound to this policy to receive DNS queries sent by VMs or applications over VPN connections. When enabled, a virtual IP address is allocated from each of the subnetworks that are bound to this policy. | | `enableLogging` | `boolean` | Controls whether logging is enabled for the networks bound to this policy. Defaults to no logging if not set. | -| `kind` | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/resource_record_sets/index.md b/docs/google-docs/providers/google/dns/resource_record_sets/index.md index 8331081c6c..f358819a16 100644 --- a/docs/google-docs/providers/google/dns/resource_record_sets/index.md +++ b/docs/google-docs/providers/google/dns/resource_record_sets/index.md @@ -28,12 +28,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | For example, www.example.com. | +| `type` | `string` | The identifier of a supported record type. See the list of Supported DNS record types. | +| `kind` | `string` | | | `routingPolicy` | `object` | A RRSetRoutingPolicy represents ResourceRecordSet data that is returned dynamically with the response varying based on configured properties such as geolocation or by weighted random selection. | | `rrdatas` | `array` | As defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) -- see examples. | | `signatureRrdatas` | `array` | As defined in RFC 4034 (section 3.2). | | `ttl` | `integer` | Number of seconds that this ResourceRecordSet can be cached by resolvers. | -| `type` | `string` | The identifier of a supported record type. See the list of Supported DNS record types. | -| `kind` | `string` | | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/dns/response_policies/index.md b/docs/google-docs/providers/google/dns/response_policies/index.md index 43a9d30a45..4ee666d72a 100644 --- a/docs/google-docs/providers/google/dns/response_policies/index.md +++ b/docs/google-docs/providers/google/dns/response_policies/index.md @@ -29,11 +29,11 @@ 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` | User-provided description for this Response Policy. | +| `responsePolicyName` | `string` | User assigned name for this Response Policy. | +| `gkeClusters` | `array` | The list of Google Kubernetes Engine clusters to which this response policy is applied. | | `kind` | `string` | | | `labels` | `object` | User labels. | | `networks` | `array` | List of network names specifying networks to which this policy is applied. | -| `responsePolicyName` | `string` | User assigned name for this Response Policy. | -| `gkeClusters` | `array` | The list of Google Kubernetes Engine clusters to which this response policy is applied. | ## 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 e32ef656f5..be4f05b74c 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 | |:-----|:---------|:------------| -| `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` | | | `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. | ## 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 032a365aa2..c8640f0485 100644 --- a/docs/google-docs/providers/google/documentai/evaluations/index.md +++ b/docs/google-docs/providers/google/documentai/evaluations/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 evaluation. Format: `projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}/evaluations/{evaluation}` | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_processors_processor_versions_evaluations_get` | `SELECT` | `evaluationsId, locationsId, processorVersionsId, processorsId, projectsId` | Retrieves a specific evaluation. | | `projects_locations_processors_processor_versions_evaluations_list` | `SELECT` | `locationsId, processorVersionsId, processorsId, projectsId` | Retrieves a set of evaluations for a given processor version. | | `_projects_locations_processors_processor_versions_evaluations_list` | `EXEC` | `locationsId, processorVersionsId, processorsId, projectsId` | Retrieves a set of evaluations for a given processor version. | -| `projects_locations_processors_processor_versions_evaluations_get` | `EXEC` | `evaluationsId, locationsId, processorVersionsId, processorsId, projectsId` | Retrieves a specific evaluation. | diff --git a/docs/google-docs/providers/google/documentai/index.md b/docs/google-docs/providers/google/documentai/index.md index 59b7787df5..6131ec51ce 100644 --- a/docs/google-docs/providers/google/documentai/index.md +++ b/docs/google-docs/providers/google/documentai/index.md @@ -33,7 +33,7 @@ Service To Parse Structured Information From Unstructured Or Semi-Structured Doc TypeService TitleCloud Document AI API DescriptionService To Parse Structured Information From Unstructured Or Semi-Structured Documents Using State-Of-The-Art Google AI Such As Natural Language, Computer Vision, Translation, And AutoML. -Iddocumentai:v23.08.00161 +Iddocumentai:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/documentai/locations/index.md b/docs/google-docs/providers/google/documentai/locations/index.md index ea88274fc2..92e3b87d7c 100644 --- a/docs/google-docs/providers/google/documentai/locations/index.md +++ b/docs/google-docs/providers/google/documentai/locations/index.md @@ -28,13 +28,13 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/documentai/operations/index.md b/docs/google-docs/providers/google/documentai/operations/index.md index a39d383d40..63bad7eec1 100644 --- a/docs/google-docs/providers/google/documentai/operations/index.md +++ b/docs/google-docs/providers/google/documentai/operations/index.md @@ -28,16 +28,16 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `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. | | `operations_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`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | -| `projects_operations_get` | `EXEC` | `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. | 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 9ba00f9bf7..f0aafe4c52 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}` | +| `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. | | `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. | ## 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 43eacad889..2fc272132c 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. | | `kmsKeyVersionName` | `string` | The KMS key version with which data is encrypted. | -| `createTime` | `string` | The time the processor version was created. | -| `documentSchema` | `object` | The schema defines the output of the processed document by a processor. | | `state` | `string` | The state of the processor version. | +| `createTime` | `string` | The time the processor version was created. | +| `displayName` | `string` | The display name of the processor version. | | `kmsKeyName` | `string` | The KMS key name used for encryption. | +| `documentSchema` | `object` | The schema defines the output of the processed document by a processor. | | `latestEvaluation` | `object` | Gives a short summary of an evaluation, and links to the evaluation itself. | | `googleManaged` | `boolean` | Output only. Denotes that this `ProcessorVersion` is managed by Google. | -| `deprecationInfo` | `object` | Information about the upcoming deprecation of this processor version. | -| `displayName` | `string` | The display name of the processor version. | ## 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 9cac4d1df8..743bd54a5b 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}` | +| `processEndpoint` | `string` | Output only. Immutable. The http endpoint that can be called to invoke processing. | +| `processorVersionAliases` | `array` | Output only. The processor version aliases. | | `displayName` | `string` | The display name of the processor. | +| `defaultProcessorVersion` | `string` | The default processor version. | | `state` | `string` | Output only. The state of the processor. | | `type` | `string` | The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`. To get a list of processor types, see FetchProcessorTypes. | -| `defaultProcessorVersion` | `string` | The default processor version. | -| `createTime` | `string` | The time the processor was created. | -| `processorVersionAliases` | `array` | Output only. The processor version aliases. | -| `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. | +| `createTime` | `string` | The time the processor was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/domains/index.md b/docs/google-docs/providers/google/domains/index.md index 14cafc3f9a..e4d8de9a0a 100644 --- a/docs/google-docs/providers/google/domains/index.md +++ b/docs/google-docs/providers/google/domains/index.md @@ -33,7 +33,7 @@ Enables Management And Configuration Of Domain Names. TypeService TitleCloud Domains API DescriptionEnables Management And Configuration Of Domain Names. -Iddomains:v23.08.00161 +Iddomains:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/domains/locations/index.md b/docs/google-docs/providers/google/domains/locations/index.md index 80bd0f50d4..9fbad528d7 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"` | -| `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/domains/operations/index.md b/docs/google-docs/providers/google/domains/operations/index.md index f24da0844a..ab017287fe 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}`. | -| `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/domains/registrations/index.md b/docs/google-docs/providers/google/domains/registrations/index.md index 58aa118aca..5296506476 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/`. | -| `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. | +| `supportedPrivacy` | `array` | Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports. | +| `dnsSettings` | `object` | Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records. | | `labels` | `object` | Set of labels associated with the `Registration`. | +| `expireTime` | `string` | Output only. The expiration timestamp of the `Registration`. | +| `registerFailureReason` | `string` | Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state. | +| `transferFailureReason` | `string` | Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state. | +| `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`. | -| `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. | -| `dnsSettings` | `object` | Defines the DNS configuration of a `Registration`, including name servers, DNSSEC, and glue records. | +| `createTime` | `string` | Output only. The creation timestamp of the `Registration` resource. | | `issues` | `array` | Output only. The set of issues with the `Registration` that require attention. | | `domainName` | `string` | Required. Immutable. The domain name. Unicode domain names must be expressed in Punycode format. | -| `transferFailureReason` | `string` | Output only. The reason the domain transfer failed. Only set for domains in TRANSFER_FAILED state. | -| `supportedPrivacy` | `array` | Output only. Set of options for the `contact_settings.privacy` field that this `Registration` supports. | -| `registerFailureReason` | `string` | Output only. The reason the domain registration failed. Only set for domains in REGISTRATION_FAILED state. | -| `createTime` | `string` | Output only. The creation timestamp of the `Registration` resource. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 c3ed60b1da..853a8c44f0 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/essentialcontacts/contacts/index.md b/docs/google-docs/providers/google/essentialcontacts/contacts/index.md index 1845815975..f0798ab729 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} | -| `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. | +| `validationState` | `string` | The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/essentialcontacts/index.md b/docs/google-docs/providers/google/essentialcontacts/index.md index 4c314aa335..332a08ffc7 100644 --- a/docs/google-docs/providers/google/essentialcontacts/index.md +++ b/docs/google-docs/providers/google/essentialcontacts/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleEssential Contacts API Description -Idessentialcontacts:v23.08.00161 +Idessentialcontacts:v23.08.00163 ## Resources 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 7c14a44251..3a109764f6 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. | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 b5010bb6f3..b21a5c49bd 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/channels/index.md b/docs/google-docs/providers/google/eventarc/channels/index.md index eb956852e4..5a54443797 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}`. | +| `state` | `string` | Output only. The state of a Channel. | | `updateTime` | `string` | Output only. The last-modified time. | -| `activationToken` | `string` | Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing. | | `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/*`. | -| `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. | -| `state` | `string` | Output only. The state of a Channel. | | `createTime` | `string` | Output only. The creation time. | +| `activationToken` | `string` | Output only. The activation token for the channel. The token must be used by the provider to register the channel for publishing. | +| `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}`. | +| `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}`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 52c2b01b38..022e581592 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 9ea66aeee4..e1d197dc00 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`. | -| `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. | +| `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/*`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/eventarc/index.md b/docs/google-docs/providers/google/eventarc/index.md index 4d86cc7455..dc9308c895 100644 --- a/docs/google-docs/providers/google/eventarc/index.md +++ b/docs/google-docs/providers/google/eventarc/index.md @@ -33,7 +33,7 @@ Build Event-Driven Applications On Google Cloud Platform. TypeService TitleEventarc API DescriptionBuild Event-Driven Applications On Google Cloud Platform. -Ideventarc:v23.08.00161 +Ideventarc:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/eventarc/locations/index.md b/docs/google-docs/providers/google/eventarc/locations/index.md index e5617597d8..1ece6b12d3 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"`. | +| `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/eventarc/operations/index.md b/docs/google-docs/providers/google/eventarc/operations/index.md index 25e338a145..88a7cd2a08 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, 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/eventarc/providers/index.md b/docs/google-docs/providers/google/eventarc/providers/index.md index 3e833148ec..2973b02993 100644 --- a/docs/google-docs/providers/google/eventarc/providers/index.md +++ b/docs/google-docs/providers/google/eventarc/providers/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. In `projects/{project}/locations/{location}/providers/{provider_id}` format. | -| `eventTypes` | `array` | Output only. Event types for this provider. | | `displayName` | `string` | Output only. Human friendly name for the Provider. For example "Cloud Storage". | +| `eventTypes` | `array` | Output only. Event types for this provider. | ## 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 c60f75b07f..68aff8c247 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. | -| `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. | -| `labels` | `object` | Optional. User labels attached to the triggers that can be used to group resources. | -| `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. | -| `transport` | `object` | Represents the transport intermediaries created for the trigger to deliver events. | +| `updateTime` | `string` | Output only. The last-modified time. | | `destination` | `object` | Represents a target of an invocation over HTTP. | -| `conditions` | `object` | Output only. The reason(s) why a trigger is in FAILED state. | | `createTime` | `string` | Output only. The creation time. | -| `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. | -| `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. | +| `transport` | `object` | Represents the transport intermediaries created for the trigger to deliver events. | +| `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. | +| `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. | | `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. | +| `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. | +| `conditions` | `object` | Output only. The reason(s) why a trigger is in FAILED state. | +| `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. | +| `labels` | `object` | Optional. User labels attached to the triggers that can be used to group resources. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 32590e691f..480d75251e 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/file/backups/index.md b/docs/google-docs/providers/google/file/backups/index.md index 55153bb183..766d9e9a9f 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. | -| `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. | +| `labels` | `object` | Resource labels to represent user provided metadata. | +| `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. | +| `state` | `string` | Output only. The backup state. | | `kmsKey` | `string` | Immutable. KMS key name used for data encryption. | +| `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. | | `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. | -| `sourceFileShare` | `string` | Name of the file share in the source Filestore instance that the backup is created from. | | `sourceInstanceTier` | `string` | Output only. The service tier of the source Filestore instance that this backup is created from. | -| `state` | `string` | Output only. The backup state. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `sourceFileShare` | `string` | Name of the file share in the source Filestore instance that the 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. | -| `capacityGb` | `string` | Output only. Capacity of the source file share when the backup was created. | -| `labels` | `object` | Resource labels to represent user provided metadata. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/file/index.md b/docs/google-docs/providers/google/file/index.md index 8a41bee41e..1c36524849 100644 --- a/docs/google-docs/providers/google/file/index.md +++ b/docs/google-docs/providers/google/file/index.md @@ -33,7 +33,7 @@ The Cloud Filestore API Is Used For Creating And Managing Cloud File Servers. TypeService TitleCloud Filestore API DescriptionThe Cloud Filestore API Is Used For Creating And Managing Cloud File Servers. -Idfile:v23.08.00161 +Idfile:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/file/instances/index.md b/docs/google-docs/providers/google/file/instances/index.md index 6fe78c4d1f..9c5ee8665d 100644 --- a/docs/google-docs/providers/google/file/instances/index.md +++ b/docs/google-docs/providers/google/file/instances/index.md @@ -30,16 +30,16 @@ 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). | | `tier` | `string` | The service tier of the instance. | +| `statusMessage` | `string` | Output only. Additional information about the instance state, if available. | | `fileShares` | `array` | File system shares on the instance. For this version, only a single file share is supported. | | `networks` | `array` | VPC networks to which the instance is connected. For this version, only a single network is supported. | -| `kmsKeyName` | `string` | KMS key name used for data encryption. | | `createTime` | `string` | Output only. The time when the instance was created. | -| `state` | `string` | Output only. The instance state. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `suspensionReasons` | `array` | Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. | | `etag` | `string` | Server-specified ETag for the instance resource to prevent simultaneous updates from overwriting each other. | +| `kmsKeyName` | `string` | KMS key name used for data encryption. | | `labels` | `object` | Resource labels to represent user provided metadata. | -| `statusMessage` | `string` | Output only. Additional information about the instance state, if available. | -| `suspensionReasons` | `array` | Output only. Field indicates all the reasons the instance is in "SUSPENDED" state. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `state` | `string` | Output only. The instance state. | ## 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 d87fe91d1e..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"` | +| `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/file/operations/index.md b/docs/google-docs/providers/google/file/operations/index.md index 153a128add..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}`. | -| `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/backup_schedules/index.md b/docs/google-docs/providers/google/firestore/backup_schedules/index.md index 27225160dd..4d8fe72227 100644 --- a/docs/google-docs/providers/google/firestore/backup_schedules/index.md +++ b/docs/google-docs/providers/google/firestore/backup_schedules/index.md @@ -28,11 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` | +| `updateTime` | `string` | Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. | | `weeklyRecurrence` | `object` | Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. | | `createTime` | `string` | Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. | | `dailyRecurrence` | `object` | Represent a recurring schedule that runs at a specific time every day. The time zone is UTC. | | `retention` | `string` | At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. | -| `updateTime` | `string` | Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. | ## 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 5ee80bbe73..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}`. | -| `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/index.md b/docs/google-docs/providers/google/firestore/index.md index b99a165fff..fa994beb93 100644 --- a/docs/google-docs/providers/google/firestore/index.md +++ b/docs/google-docs/providers/google/firestore/index.md @@ -33,7 +33,7 @@ Accesses The NoSQL Document Database Built For Automatic Scaling, High Performan TypeService TitleCloud Firestore API DescriptionAccesses The NoSQL Document Database Built For Automatic Scaling, High Performance, And Ease Of Application Development. -Idfirestore:v23.08.00161 +Idfirestore:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/firestore/indexes/index.md b/docs/google-docs/providers/google/firestore/indexes/index.md index 254f9fc596..9ea4615529 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. | -| `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. | +| `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. | ## 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 29172c2d49..60e1ea7312 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"` | +| `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/firestore/operations/index.md b/docs/google-docs/providers/google/firestore/operations/index.md index cabf72f396..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}`. | -| `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/gkebackup/backup_plans/index.md b/docs/google-docs/providers/google/gkebackup/backup_plans/index.md index 46f2ca1e9d..9f335679f0 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. | -| `cluster` | `string` | Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | -| `backupConfig` | `object` | BackupConfig defines the configuration of Backups created via this BackupPlan. | -| `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 | -| `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. | +| `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` | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | +| `backupSchedule` | `object` | Defines scheduling parameters for automatically creating Backups via this BackupPlan. | +| `labels` | `object` | Optional. A set of custom labels supplied by user. | | `retentionPolicy` | `object` | RetentionPolicy defines a Backup retention policy for a 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. | -| `labels` | `object` | Optional. A set of custom labels supplied by user. | -| `backupSchedule` | `object` | Defines scheduling parameters for automatically creating Backups via this BackupPlan. | -| `createTime` | `string` | Output only. The timestamp when this BackupPlan resource was created. | -| `updateTime` | `string` | Output only. The timestamp when this BackupPlan resource was last updated. | | `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 | +| `cluster` | `string` | Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*` | +| `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. | +| `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 | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/backups/index.md b/docs/google-docs/providers/google/gkebackup/backups/index.md index b33cdae068..3c86f6d53a 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. | +| `resourceCount` | `integer` | Output only. The total number of Kubernetes resources included in the Backup. | +| `selectedNamespaces` | `object` | A list of Kubernetes Namespaces | +| `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). | +| `sizeBytes` | `string` | Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes) | +| `createTime` | `string` | Output only. The timestamp when this Backup resource was created. | | `containsSecrets` | `boolean` | Output only. Whether or not the Backup contains Kubernetes Secrets. Controlled by the parent BackupPlan's include_secrets value. | +| `state` | `string` | Output only. Current state of the Backup | +| `clusterMetadata` | `object` | Information about the GKE cluster from which this Backup was created. | +| `volumeCount` | `integer` | Output only. The total number of volume backups contained in the Backup. | | `retainExpireTime` | `string` | Output only. The time at which this Backup will be automatically deleted (calculated from create_time + retain_days). | -| `sizeBytes` | `string` | Output only. The total size of the Backup in bytes = config backup size + sum(volume backup sizes) | +| `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. | +| `allNamespaces` | `boolean` | Output only. If True, all namespaces were included in the Backup. | +| `selectedApplications` | `object` | A list of namespaced Kubernetes resources. | | `encryptionKey` | `object` | Defined a customer managed encryption key that will be used to encrypt Backup artifacts. | -| `updateTime` | `string` | Output only. The timestamp when this Backup resource was last updated. | -| `labels` | `object` | Optional. A set of custom labels supplied by user. | | `completeTime` | `string` | Output only. Completion time of the Backup | -| `stateReason` | `string` | Output only. Human-readable description of why the backup is in the current `state`. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) | +| `labels` | `object` | Optional. A set of custom labels supplied by user. | +| `podCount` | `integer` | Output only. The total number of Kubernetes Pods contained in the Backup. | +| `configBackupSizeBytes` | `string` | Output only. The size of the config backup in bytes. | +| `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. | | `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. | +| `stateReason` | `string` | Output only. Human-readable description of why the backup is in the current `state`. | | `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. | +| `updateTime` | `string` | Output only. The timestamp when this Backup resource was last updated. | | `containsVolumeData` | `boolean` | Output only. Whether or not the Backup contains volume data. Controlled by the parent BackupPlan's include_volume_data value. | -| `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). | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier) | -| `volumeCount` | `integer` | Output only. The total number of volume backups contained in the Backup. | -| `allNamespaces` | `boolean` | Output only. If True, all namespaces were included in the Backup. | -| `configBackupSizeBytes` | `string` | Output only. The size of the config backup in bytes. | -| `clusterMetadata` | `object` | Information about the GKE cluster from which this Backup was created. | -| `podCount` | `integer` | Output only. The total number of Kubernetes Pods contained in the Backup. | -| `resourceCount` | `integer` | Output only. The total number of Kubernetes resources included in the Backup. | -| `createTime` | `string` | Output only. The timestamp when this Backup resource was created. | -| `selectedApplications` | `object` | A list of namespaced Kubernetes resources. | -| `state` | `string` | Output only. Current state of the Backup | -| `selectedNamespaces` | `object` | A list of Kubernetes Namespaces | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md index 386ea15882..7e87ce4ad1 100644 --- a/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/backups_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/index.md b/docs/google-docs/providers/google/gkebackup/index.md index 4b620754c1..f601313227 100644 --- a/docs/google-docs/providers/google/gkebackup/index.md +++ b/docs/google-docs/providers/google/gkebackup/index.md @@ -33,7 +33,7 @@ Backup For GKE Is A Managed Kubernetes Workload Backup And Restore Service For G TypeService TitleBackup For GKE API DescriptionBackup For GKE Is A Managed Kubernetes Workload Backup And Restore Service For GKE Clusters. -Idgkebackup:v23.08.00161 +Idgkebackup:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/gkebackup/locations/index.md b/docs/google-docs/providers/google/gkebackup/locations/index.md index c924fa0763..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"` | +| `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/gkebackup/operations/index.md b/docs/google-docs/providers/google/gkebackup/operations/index.md index 848741cedf..c16136e9bc 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, 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/gkebackup/restore_plans/index.md b/docs/google-docs/providers/google/gkebackup/restore_plans/index.md index 0acb9efb87..c3a739a930 100644 --- a/docs/google-docs/providers/google/gkebackup/restore_plans/index.md +++ b/docs/google-docs/providers/google/gkebackup/restore_plans/index.md @@ -29,16 +29,16 @@ 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. | -| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | -| `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. | | `createTime` | `string` | Output only. The timestamp when this RestorePlan resource was created. | +| `stateReason` | `string` | Output only. Human-readable description of why RestorePlan is in the current `state` | | `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | +| `labels` | `object` | Optional. A set of custom labels supplied by user. | | `state` | `string` | Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation. | | `updateTime` | `string` | Output only. The timestamp when this RestorePlan resource was last updated. | | `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/*`. | | `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/*` | -| `labels` | `object` | Optional. A set of custom labels supplied by user. | -| `stateReason` | `string` | Output only. Human-readable description of why RestorePlan is in the current `state` | +| `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. | +| `uid` | `string` | Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md index db35ee59a3..e9c25ad14f 100644 --- a/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/restore_plans_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkebackup/restores/index.md b/docs/google-docs/providers/google/gkebackup/restores/index.md index 6555dc42b0..9ef3b28cc2 100644 --- a/docs/google-docs/providers/google/gkebackup/restores/index.md +++ b/docs/google-docs/providers/google/gkebackup/restores/index.md @@ -29,21 +29,21 @@ 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. | +| `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. | +| `createTime` | `string` | Output only. The timestamp when this Restore resource was created. | +| `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. | +| `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | | `updateTime` | `string` | Output only. The timestamp when this Restore resource was last updated. | -| `resourcesFailedCount` | `integer` | Output only. Number of resources that failed to be restored during the restore execution. | +| `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/*`. | | `resourcesExcludedCount` | `integer` | Output only. Number of resources excluded during the restore execution. | -| `restoreConfig` | `object` | Configuration of a restore. Next id: 12 | -| `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. | +| `resourcesRestoredCount` | `integer` | Output only. Number of resources restored during the restore execution. | +| `state` | `string` | Output only. The current state of the 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. | | `labels` | `object` | A set of custom labels supplied by user. | | `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. | -| `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/*`. | -| `resourcesRestoredCount` | `integer` | Output only. Number of resources restored during the restore execution. | | `stateReason` | `string` | Output only. Human-readable description of why the Restore is in its current state. | -| `createTime` | `string` | Output only. The timestamp when this Restore resource was created. | -| `completeTime` | `string` | Output only. Timestamp of when the restore operation completed. | +| `resourcesFailedCount` | `integer` | Output only. Number of resources that failed to be restored during the restore execution. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 a117384a8b..73fa1a601f 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 f4e3a1d1a2..c8b96c3d09 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_backups/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_backups/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 name of the VolumeBackup resource. Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*`. | -| `diskSizeBytes` | `string` | Output only. The minimum size of the disk to which this VolumeBackup can be restored. | -| `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeBackup is in its current state. | -| `updateTime` | `string` | Output only. The timestamp when this VolumeBackup resource was last updated. | -| `volumeBackupHandle` | `string` | Output only. A storage system-specific opaque handle to the underlying volume backup. | -| `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. | | `format` | `string` | Output only. The format used for the volume backup. | -| `sourcePvc` | `object` | A reference to a namespaced resource in Kubernetes. | -| `state` | `string` | Output only. The current state of this VolumeBackup. | +| `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. | +| `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. | +| `state` | `string` | Output only. The current state of this VolumeBackup. | | `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. | +| `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeBackup is in its current state. | +| `sourcePvc` | `object` | A reference to a namespaced resource in Kubernetes. | +| `diskSizeBytes` | `string` | Output only. The minimum size of the disk to which this VolumeBackup can be restored. | +| `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. | +| `volumeBackupHandle` | `string` | Output only. A storage system-specific opaque handle to the underlying volume backup. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 b8966c19e3..1de1f38bab 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 52d110aa18..06f5f31c77 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_restores/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_restores/index.md @@ -28,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. Full name of the VolumeRestore resource. Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*` | +| `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeRestore is in its current state. | | `updateTime` | `string` | Output only. The timestamp when this VolumeRestore resource was last updated. | -| `state` | `string` | Output only. The current state of this VolumeRestore. | -| `targetPvc` | `object` | A reference to a namespaced resource in Kubernetes. | +| `createTime` | `string` | Output only. The timestamp when this VolumeRestore resource was created. | | `volumeHandle` | `string` | Output only. A storage system-specific opaque handler to the underlying volume created for the target PVC from the volume backup. | -| `stateMessage` | `string` | Output only. A human readable message explaining why the VolumeRestore is in its current state. | +| `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. | +| `targetPvc` | `object` | A reference to a namespaced resource in Kubernetes. | +| `state` | `string` | Output only. The current state of this VolumeRestore. | | `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 VolumeRestore resource was created. | | `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 | | `completeTime` | `string` | Output only. The timestamp when the associated underlying volume restoration completed. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md b/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md index d2ff1b7efa..adaa8eec9b 100644 --- a/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkebackup/volume_restores_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/bindings/index.md b/docs/google-docs/providers/google/gkehub/bindings/index.md index 74c42474b1..6298b47095 100644 --- a/docs/google-docs/providers/google/gkehub/bindings/index.md +++ b/docs/google-docs/providers/google/gkehub/bindings/index.md @@ -28,20 +28,19 @@ 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}` | -| `updateTime` | `string` | Output only. When the membership binding was last updated. | | `createTime` | `string` | Output only. When the membership binding was created. | | `deleteTime` | `string` | Output only. When the membership binding was deleted. | -| `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. | | `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/*`. | -| `fleet` | `boolean` | Whether the membershipbinding is Fleet-wide; true means that this Membership should be bound to all Namespaces in this entire Fleet. | +| `state` | `object` | MembershipBindingLifecycleState describes the state of a Binding resource. | +| `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. | +| `updateTime` | `string` | Output only. When the membership binding was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_memberships_bindings_get` | `SELECT` | `bindingsId, locationsId, membershipsId, projectsId` | Returns the details of a MembershipBinding. | | `projects_locations_memberships_bindings_list` | `SELECT` | `locationsId, membershipsId, projectsId` | Lists MembershipBindings. | | `projects_locations_memberships_bindings_create` | `INSERT` | `locationsId, membershipsId, projectsId` | Creates a MembershipBinding. | | `projects_locations_memberships_bindings_delete` | `DELETE` | `bindingsId, locationsId, membershipsId, projectsId` | Deletes a MembershipBinding. | | `_projects_locations_memberships_bindings_list` | `EXEC` | `locationsId, membershipsId, projectsId` | Lists MembershipBindings. | -| `projects_locations_memberships_bindings_get` | `EXEC` | `bindingsId, locationsId, membershipsId, projectsId` | Returns the details of a MembershipBinding. | | `projects_locations_memberships_bindings_patch` | `EXEC` | `bindingsId, locationsId, membershipsId, projectsId` | Updates a MembershipBinding. | diff --git a/docs/google-docs/providers/google/gkehub/features/index.md b/docs/google-docs/providers/google/gkehub/features/index.md index 9749a09f8d..85f6d6f30a 100644 --- a/docs/google-docs/providers/google/gkehub/features/index.md +++ b/docs/google-docs/providers/google/gkehub/features/index.md @@ -28,24 +28,24 @@ 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/*`. | -| `fleetDefaultMemberConfig` | `object` | CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet | -| `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. | -| `createTime` | `string` | Output only. When the Feature resource was created. | | `labels` | `object` | Labels for this 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. | +| `fleetDefaultMemberConfig` | `object` | CommonFleetDefaultMemberConfigSpec contains default configuration information for memberships of a fleet | | `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. | -| `state` | `object` | CommonFeatureState contains Hub-wide Feature status information. | -| `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. | -| `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. | | `spec` | `object` | CommonFeatureSpec contains Hub-wide configuration information | +| `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. | -| `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. | +| `createTime` | `string` | Output only. When the Feature resource was created. | | `updateTime` | `string` | Output only. When the Feature resource was last updated. | +| `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. | +| `state` | `object` | CommonFeatureState contains Hub-wide Feature status information. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_features_get` | `SELECT` | `featuresId, locationsId, projectsId` | Gets details of a single Feature. | | `projects_locations_features_list` | `SELECT` | `locationsId, projectsId` | Lists Features in a given project and location. | | `projects_locations_features_create` | `INSERT` | `locationsId, projectsId` | Adds a new Feature. | | `projects_locations_features_delete` | `DELETE` | `featuresId, locationsId, projectsId` | Removes a Feature. | | `_projects_locations_features_list` | `EXEC` | `locationsId, projectsId` | Lists Features in a given project and location. | -| `projects_locations_features_get` | `EXEC` | `featuresId, locationsId, projectsId` | Gets details of a single Feature. | | `projects_locations_features_patch` | `EXEC` | `featuresId, locationsId, projectsId` | Updates an existing Feature. | diff --git a/docs/google-docs/providers/google/gkehub/fleets/index.md b/docs/google-docs/providers/google/gkehub/fleets/index.md index 8933c5fe07..d0c3db91e7 100644 --- a/docs/google-docs/providers/google/gkehub/fleets/index.md +++ b/docs/google-docs/providers/google/gkehub/fleets/index.md @@ -28,21 +28,21 @@ 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 | |:-----|:--------------|:----------------|:------------| | `organizations_locations_fleets_list` | `SELECT` | `locationsId, organizationsId` | Returns all fleets within an organization or a project that the caller has access to. | +| `projects_locations_fleets_get` | `SELECT` | `fleetsId, locationsId, projectsId` | Returns the details of a fleet. | | `projects_locations_fleets_list` | `SELECT` | `locationsId, projectsId` | Returns all fleets within an organization or a project that the caller has access to. | | `projects_locations_fleets_create` | `INSERT` | `locationsId, projectsId` | Creates a fleet. | | `projects_locations_fleets_delete` | `DELETE` | `fleetsId, locationsId, projectsId` | Removes a Fleet. There must be no memberships remaining in the Fleet. | | `_organizations_locations_fleets_list` | `EXEC` | `locationsId, organizationsId` | Returns all fleets within an organization or a project that the caller has access to. | | `_projects_locations_fleets_list` | `EXEC` | `locationsId, projectsId` | Returns all fleets within an organization or a project that the caller has access to. | -| `projects_locations_fleets_get` | `EXEC` | `fleetsId, locationsId, projectsId` | Returns the details of a fleet. | | `projects_locations_fleets_patch` | `EXEC` | `fleetsId, locationsId, projectsId` | Updates a fleet. | diff --git a/docs/google-docs/providers/google/gkehub/index.md b/docs/google-docs/providers/google/gkehub/index.md index 4e423afa52..7eac1cc74b 100644 --- a/docs/google-docs/providers/google/gkehub/index.md +++ b/docs/google-docs/providers/google/gkehub/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleGKE Hub API Description -Idgkehub:v23.08.00161 +Idgkehub:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/gkehub/locations/index.md b/docs/google-docs/providers/google/gkehub/locations/index.md index db4abe5b19..81e4fc36a1 100644 --- a/docs/google-docs/providers/google/gkehub/locations/index.md +++ b/docs/google-docs/providers/google/gkehub/locations/index.md @@ -28,13 +28,13 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/gkehub/memberships/index.md b/docs/google-docs/providers/google/gkehub/memberships/index.md index 1818f0634a..4040289c70 100644 --- a/docs/google-docs/providers/google/gkehub/memberships/index.md +++ b/docs/google-docs/providers/google/gkehub/memberships/index.md @@ -25,13 +25,28 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Output only. The full, unique name of this Membership resource in the format `projects/*/locations/*/memberships/{membership_id}`, set during creation. `membership_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters. | +| `description` | `string` | Output only. Description of this membership, limited to 63 characters. Must match the regex: `a-zA-Z0-9*` This field is present for legacy purposes. | +| `deleteTime` | `string` | Output only. When the Membership was deleted. | +| `state` | `object` | MembershipState describes the state of a Membership resource. | +| `endpoint` | `object` | MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. | +| `uniqueId` | `string` | Output only. Google-generated UUID for this resource. This is unique across all Membership resources. If a Membership resource is deleted and another resource with the same name is created, it gets a different unique_id. | +| `updateTime` | `string` | Output only. When the Membership was last updated. | +| `lastConnectionTime` | `string` | Output only. For clusters using Connect, the timestamp of the most recent connection established with Google Cloud. This time is updated every several minutes, not continuously. For clusters that do not use GKE Connect, or that have never connected successfully, this field will be unset. | +| `authority` | `object` | Authority encodes how Google will recognize identities from this Membership. See the workload identity documentation for more details: https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity | +| `createTime` | `string` | Output only. When the Membership was created. | +| `externalId` | `string` | Optional. An externally-generated and managed ID for this Membership. This ID may be modified after creation, but this is not recommended. The ID must match the regex: `a-zA-Z0-9*` If this Membership represents a Kubernetes cluster, this value should be set to the UID of the `kube-system` namespace object. | +| `monitoringConfig` | `object` | This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics. | +| `labels` | `object` | Optional. Labels for this membership. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_memberships_get` | `SELECT` | `locationsId, membershipsId, projectsId` | Gets the details of a Membership. | | `projects_locations_memberships_list` | `SELECT` | `locationsId, projectsId` | Lists Memberships in a given project and location. | | `projects_locations_memberships_create` | `INSERT` | `locationsId, projectsId` | Creates a new Membership. **This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster. | | `projects_locations_memberships_delete` | `DELETE` | `locationsId, membershipsId, projectsId` | Removes a Membership. **This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster. | | `_projects_locations_memberships_list` | `EXEC` | `locationsId, projectsId` | Lists Memberships in a given project and location. | | `projects_locations_memberships_generate_connect_manifest` | `EXEC` | `locationsId, membershipsId, projectsId` | Generates the manifest for deployment of the GKE connect agent. **This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly. | -| `projects_locations_memberships_get` | `EXEC` | `locationsId, membershipsId, projectsId` | Gets the details of a Membership. | | `projects_locations_memberships_patch` | `EXEC` | `locationsId, membershipsId, projectsId` | Updates an existing Membership. | 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 5edb7a1e24..9b53312344 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/gkehub/namespaces/index.md b/docs/google-docs/providers/google/gkehub/namespaces/index.md index a1eee4a2e2..37ae9b0b9c 100644 --- a/docs/google-docs/providers/google/gkehub/namespaces/index.md +++ b/docs/google-docs/providers/google/gkehub/namespaces/index.md @@ -28,20 +28,20 @@ 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}` | +| `labels` | `object` | Optional. Labels for this Namespace. | | `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. | -| `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. | -| `state` | `object` | NamespaceLifecycleState describes the state of a Namespace resource. | +| `deleteTime` | `string` | Output only. When the namespace was deleted. | | `scope` | `string` | Required. Scope associated with the namespace | -| `labels` | `object` | Optional. Labels for this Namespace. | | `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. | +| `state` | `object` | NamespaceLifecycleState describes the state of a Namespace resource. | | `createTime` | `string` | Output only. When the namespace was created. | -| `deleteTime` | `string` | Output only. When the namespace was deleted. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_scopes_namespaces_get` | `SELECT` | `locationsId, namespacesId, projectsId, scopesId` | Returns the details of a fleet namespace. | | `projects_locations_scopes_namespaces_list` | `SELECT` | `locationsId, projectsId, scopesId` | Lists fleet namespaces. | | `projects_locations_scopes_namespaces_create` | `INSERT` | `locationsId, projectsId, scopesId` | Creates a fleet namespace. | | `projects_locations_scopes_namespaces_delete` | `DELETE` | `locationsId, namespacesId, projectsId, scopesId` | Deletes a fleet namespace. | | `_projects_locations_scopes_namespaces_list` | `EXEC` | `locationsId, projectsId, scopesId` | Lists fleet namespaces. | -| `projects_locations_scopes_namespaces_get` | `EXEC` | `locationsId, namespacesId, projectsId, scopesId` | Returns the details of a fleet namespace. | | `projects_locations_scopes_namespaces_patch` | `EXEC` | `locationsId, namespacesId, projectsId, scopesId` | Updates a fleet namespace. | diff --git a/docs/google-docs/providers/google/gkehub/operations/index.md b/docs/google-docs/providers/google/gkehub/operations/index.md index 0fdd294782..2cac3b619c 100644 --- a/docs/google-docs/providers/google/gkehub/operations/index.md +++ b/docs/google-docs/providers/google/gkehub/operations/index.md @@ -35,8 +35,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md b/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md index a739c70bad..ed9525e5bc 100644 --- a/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md +++ b/docs/google-docs/providers/google/gkehub/rbacrolebindings/index.md @@ -28,21 +28,21 @@ 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}` | +| `deleteTime` | `string` | Output only. When the rbacrolebinding was deleted. | +| `createTime` | `string` | Output only. When the rbacrolebinding was created. | +| `updateTime` | `string` | Output only. When the rbacrolebinding was last updated. | | `role` | `object` | Role is the type for Kubernetes roles | -| `state` | `object` | RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. | | `user` | `string` | user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld" | | `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. | -| `deleteTime` | `string` | Output only. When the rbacrolebinding was deleted. | | `labels` | `object` | Optional. Labels for this RBACRolebinding. | -| `updateTime` | `string` | Output only. When the rbacrolebinding was last updated. | -| `createTime` | `string` | Output only. When the rbacrolebinding was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_scopes_rbacrolebindings_get` | `SELECT` | `locationsId, projectsId, rbacrolebindingsId, scopesId` | Returns the details of a Scope RBACRoleBinding. | | `projects_locations_scopes_rbacrolebindings_list` | `SELECT` | `locationsId, projectsId, scopesId` | Lists all Scope RBACRoleBindings. | | `projects_locations_scopes_rbacrolebindings_create` | `INSERT` | `locationsId, projectsId, scopesId` | Creates a Scope RBACRoleBinding. | | `projects_locations_scopes_rbacrolebindings_delete` | `DELETE` | `locationsId, projectsId, rbacrolebindingsId, scopesId` | Deletes a Scope RBACRoleBinding. | | `_projects_locations_scopes_rbacrolebindings_list` | `EXEC` | `locationsId, projectsId, scopesId` | Lists all Scope RBACRoleBindings. | -| `projects_locations_scopes_rbacrolebindings_get` | `EXEC` | `locationsId, projectsId, rbacrolebindingsId, scopesId` | Returns the details of a Scope RBACRoleBinding. | | `projects_locations_scopes_rbacrolebindings_patch` | `EXEC` | `locationsId, projectsId, rbacrolebindingsId, scopesId` | Updates a Scope RBACRoleBinding. | diff --git a/docs/google-docs/providers/google/gkehub/scopes/index.md b/docs/google-docs/providers/google/gkehub/scopes/index.md index c70ff80ab5..d679407ddf 100644 --- a/docs/google-docs/providers/google/gkehub/scopes/index.md +++ b/docs/google-docs/providers/google/gkehub/scopes/index.md @@ -28,20 +28,20 @@ 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}` | +| `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. | +| `deleteTime` | `string` | Output only. When the scope was deleted. | +| `labels` | `object` | Optional. Labels for this 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. | | `updateTime` | `string` | Output only. When the scope was last updated. | -| `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. | -| `allMemberships` | `boolean` | If true, all Memberships in the Fleet bind to this Scope. | -| `labels` | `object` | Optional. Labels for this Scope. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_scopes_get` | `SELECT` | `locationsId, projectsId, scopesId` | Returns the details of a Scope. | | `projects_locations_scopes_list` | `SELECT` | `locationsId, projectsId` | Lists Scopes. | | `projects_locations_scopes_create` | `INSERT` | `locationsId, projectsId` | Creates a Scope. | | `projects_locations_scopes_delete` | `DELETE` | `locationsId, projectsId, scopesId` | Deletes a Scope. | | `_projects_locations_scopes_list` | `EXEC` | `locationsId, projectsId` | Lists Scopes. | -| `projects_locations_scopes_get` | `EXEC` | `locationsId, projectsId, scopesId` | Returns the details of a Scope. | | `projects_locations_scopes_patch` | `EXEC` | `locationsId, projectsId, scopesId` | Updates a scopes. | 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 098e43f52b..cd1c69f1ed 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | 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 1950284fdc..1d09e9be55 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,40 +29,41 @@ 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. | +| `securityConfig` | `object` | Specifies the security 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. | +| `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. ## | +| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal admin cluster. | | `storage` | `object` | BareMetalAdminStorageConfig specifies the cluster storage configuration. | -| `networkConfig` | `object` | BareMetalAdminNetworkConfig specifies the cluster network configuration. | -| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal Admin Cluster. | +| `updateTime` | `string` | Output only. The time at which this bare metal admin cluster was last updated. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | | `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `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. | +| `state` | `string` | Output only. The current state of the bare metal admin cluster. | | `nodeConfig` | `object` | BareMetalAdminWorkloadNodeConfig specifies the workload node configurations. | +| `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. | -| `endpoint` | `string` | Output only. The IP address name of bare metal admin cluster's API server. | +| `uid` | `string` | Output only. The unique identifier of the bare metal admin cluster. | | `proxy` | `object` | BareMetalAdminProxyConfig specifies the cluster proxy configuration. | +| `clusterOperations` | `object` | BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure. | +| `binaryAuthorization` | `object` | Configuration for Binary Authorization. | +| `endpoint` | `string` | Output only. The IP address name of bare metal admin cluster's API server. | | `controlPlane` | `object` | BareMetalAdminControlPlaneConfig specifies the control plane configuration. | -| `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 | -| `uid` | `string` | Output only. The unique identifier of the bare metal admin cluster. | -| `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. | -| `updateTime` | `string` | Output only. The time at which this bare metal admin cluster was last updated. | -| `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. ## | -| `securityConfig` | `object` | Specifies the security related settings for the bare metal admin cluster. | -| `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal admin cluster. | -| `state` | `string` | Output only. The current state of the bare metal admin cluster. | +| `osEnvironmentConfig` | `object` | Specifies operating system operation settings for cluster provisioning. | | `bareMetalVersion` | `string` | The Anthos clusters on bare metal version for the bare metal admin cluster. | -| `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. | | `maintenanceStatus` | `object` | BareMetalAdminMaintenanceStatus represents the maintenance status for bare metal Admin cluster CR's nodes. | -| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | -| `clusterOperations` | `object` | BareMetalAdminClusterOperationsConfig specifies the admin cluster's observability infrastructure. | | `createTime` | `string` | Output only. The time at which this bare metal admin cluster was created. | -| `maintenanceConfig` | `object` | BareMetalAdminMaintenanceConfig specifies configurations to put bare metal Admin cluster CRs nodes in and out of maintenance. | -| `loadBalancer` | `object` | BareMetalAdminLoadBalancerConfig specifies the load balancer configuration. | -| `osEnvironmentConfig` | `object` | Specifies operating system operation settings for cluster provisioning. | +| `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. | +| `networkConfig` | `object` | BareMetalAdminNetworkConfig specifies the cluster network configuration. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal Admin Cluster. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_bare_metal_admin_clusters_get` | `SELECT` | `bareMetalAdminClustersId, locationsId, projectsId` | Gets details of a single bare metal admin cluster. | | `projects_locations_bare_metal_admin_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists bare metal admin clusters in a given project and location. | | `projects_locations_bare_metal_admin_clusters_create` | `INSERT` | `locationsId, projectsId` | Creates a new bare metal admin cluster in a given project and location. The API needs to be combined with creating a bootstrap cluster to work. See: https://cloud.google.com/anthos/clusters/docs/bare-metal/latest/installing/creating-clusters/create-admin-cluster-api#prepare_bootstrap_environment | | `_projects_locations_bare_metal_admin_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists bare metal admin clusters in a given project and location. | | `projects_locations_bare_metal_admin_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing bare metal admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API. | -| `projects_locations_bare_metal_admin_clusters_get` | `EXEC` | `bareMetalAdminClustersId, locationsId, projectsId` | Gets details of a single bare metal admin cluster. | | `projects_locations_bare_metal_admin_clusters_patch` | `EXEC` | `bareMetalAdminClustersId, locationsId, projectsId` | Updates the parameters of a single bare metal admin cluster. | | `projects_locations_bare_metal_admin_clusters_query_version_config` | `EXEC` | `locationsId, projectsId` | Queries the bare metal admin cluster version config. | | `projects_locations_bare_metal_admin_clusters_unenroll` | `EXEC` | `bareMetalAdminClustersId, locationsId, projectsId` | Unenrolls an existing bare metal admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients. | diff --git a/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters_iam_policies/index.md index bb69fad48b..d7d361e2a6 100644 --- a/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/bare_metal_admin_clusters_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 9e7571a539..ab0d26713e 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,44 +29,45 @@ 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. | -| `adminClusterName` | `string` | Output only. The resource name of the bare metal admin cluster managing this user cluster. | -| `state` | `string` | Output only. The current state of the bare metal user cluster. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal user cluster. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `proxy` | `object` | Specifies the cluster proxy configuration. | +| `updateTime` | `string` | Output only. The time when the bare metal user cluster was last updated. | | `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. ## | -| `maintenanceConfig` | `object` | Specifies configurations to put bare metal nodes in and out of maintenance. | -| `loadBalancer` | `object` | Specifies the load balancer configuration. | -| `createTime` | `string` | Output only. The time when the bare metal user cluster was created. | -| `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 | -| `networkConfig` | `object` | Specifies the cluster network configuration. | | `nodeConfig` | `object` | Specifies the workload node configurations. | -| `endpoint` | `string` | Output only. The IP address of the bare metal user cluster's API server. | | `upgradePolicy` | `object` | BareMetalClusterUpgradePolicy defines the cluster upgrade policy. | -| `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. | -| `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. | -| `proxy` | `object` | Specifies the cluster proxy configuration. | -| `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. | +| `loadBalancer` | `object` | Specifies the load balancer configuration. | +| `storage` | `object` | BareMetalStorageConfig specifies the cluster storage configuration. | +| `maintenanceStatus` | `object` | Represents the maintenance status of the bare metal user cluster. | +| `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `deleteTime` | `string` | Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty | +| `securityConfig` | `object` | Specifies the security related settings for the bare metal user cluster. | | `clusterOperations` | `object` | Specifies the bare metal user cluster's observability infrastructure. | -| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | +| `adminClusterName` | `string` | Output only. The resource name of the bare metal admin cluster managing this user cluster. | | `osEnvironmentConfig` | `object` | Specifies operating system settings for cluster provisioning. | +| `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. | | `nodeAccessConfig` | `object` | Specifies the node access related settings for the bare metal user cluster. | -| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal user cluster. | -| `securityConfig` | `object` | Specifies the security related settings for the bare metal user cluster. | +| `networkConfig` | `object` | Specifies the cluster network configuration. | +| `createTime` | `string` | Output only. The time when the bare metal user cluster was created. | | `uid` | `string` | Output only. The unique identifier of the bare metal user cluster. | | `controlPlane` | `object` | Specifies the control plane configuration. | -| `maintenanceStatus` | `object` | Represents the maintenance status of the bare metal user cluster. | -| `storage` | `object` | BareMetalStorageConfig specifies the cluster storage configuration. | -| `bareMetalVersion` | `string` | Required. The Anthos clusters on bare metal version for your user cluster. | -| `updateTime` | `string` | Output only. The time when the bare metal user cluster was last updated. | -| `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | +| `maintenanceConfig` | `object` | Specifies configurations to put bare metal nodes in and out of maintenance. | +| `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. | +| `state` | `string` | Output only. The current state of 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. | +| `binaryAuthorization` | `object` | Configuration for Binary Authorization. | +| `endpoint` | `string` | Output only. The IP address of the bare metal user cluster's API server. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_bare_metal_clusters_get` | `SELECT` | `bareMetalClustersId, locationsId, projectsId` | Gets details of a single bare metal Cluster. | | `projects_locations_bare_metal_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists bare metal clusters in a given project and location. | | `projects_locations_bare_metal_clusters_create` | `INSERT` | `locationsId, projectsId` | Creates a new bare metal cluster in a given project and location. | | `projects_locations_bare_metal_clusters_delete` | `DELETE` | `bareMetalClustersId, locationsId, projectsId` | Deletes a single bare metal Cluster. | | `_projects_locations_bare_metal_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists bare metal clusters in a given project and location. | | `projects_locations_bare_metal_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing bare metal user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API. | -| `projects_locations_bare_metal_clusters_get` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Gets details of a single bare metal Cluster. | | `projects_locations_bare_metal_clusters_patch` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Updates the parameters of a single bare metal Cluster. | | `projects_locations_bare_metal_clusters_query_version_config` | `EXEC` | `locationsId, projectsId` | Queries the bare metal user cluster version config. | | `projects_locations_bare_metal_clusters_unenroll` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Unenrolls an existing bare metal user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients. | 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 79d2ec90f8..3d5e681a7a 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 | |:-----|:---------|:------------| -| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 9be027a69f..d4b71a35d5 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,26 +28,26 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The bare metal node pool resource name. | -| `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 bare metal node pool was last updated. | | `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 | -| `state` | `string` | Output only. The current state of the bare metal node pool. | +| `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. | +| `upgradePolicy` | `object` | BareMetalNodePoolUpgradePolicy defines the node pool upgrade policy. | | `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. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | | `nodePoolConfig` | `object` | BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool. | -| `uid` | `string` | Output only. The unique identifier of the bare metal node pool. | -| `displayName` | `string` | The display name for the bare metal node pool. | +| `state` | `string` | Output only. The current state of the bare metal node pool. | | `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. | -| `upgradePolicy` | `object` | BareMetalNodePoolUpgradePolicy defines the node pool upgrade policy. | -| `createTime` | `string` | Output only. The time at which this bare metal node pool was created. | | `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the bare metal node pool. | +| `uid` | `string` | Output only. The unique identifier of the bare metal node pool. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_bare_metal_clusters_bare_metal_node_pools_get` | `SELECT` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Gets details of a single bare metal node pool. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_list` | `SELECT` | `bareMetalClustersId, locationsId, projectsId` | Lists bare metal node pools in a given project, location and bare metal cluster. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_create` | `INSERT` | `bareMetalClustersId, locationsId, projectsId` | Creates a new bare metal node pool in a given project, location and Bare Metal cluster. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_delete` | `DELETE` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Deletes a single bare metal node pool. | | `_projects_locations_bare_metal_clusters_bare_metal_node_pools_list` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Lists bare metal node pools in a given project, location and bare metal cluster. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_enroll` | `EXEC` | `bareMetalClustersId, locationsId, projectsId` | Enrolls an existing bare metal node pool to the Anthos On-Prem API within a given project and location. Through enrollment, an existing node pool will become Anthos On-Prem API managed. The corresponding GCP resources will be created. | -| `projects_locations_bare_metal_clusters_bare_metal_node_pools_get` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Gets details of a single bare metal node pool. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_patch` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Updates the parameters of a single bare metal node pool. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_unenroll` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Unenrolls a bare metal node pool from Anthos On-Prem API. | diff --git a/docs/google-docs/providers/google/gkeonprem/index.md b/docs/google-docs/providers/google/gkeonprem/index.md index df29349bcd..d0046a58c8 100644 --- a/docs/google-docs/providers/google/gkeonprem/index.md +++ b/docs/google-docs/providers/google/gkeonprem/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleAnthos On-Prem API Description -Idgkeonprem:v23.08.00161 +Idgkeonprem:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/gkeonprem/locations/index.md b/docs/google-docs/providers/google/gkeonprem/locations/index.md index 13a690ef08..0022b2454d 100644 --- a/docs/google-docs/providers/google/gkeonprem/locations/index.md +++ b/docs/google-docs/providers/google/gkeonprem/locations/index.md @@ -35,6 +35,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/gkeonprem/operations/index.md b/docs/google-docs/providers/google/gkeonprem/operations/index.md index e3528f876b..f74195c08f 100644 --- a/docs/google-docs/providers/google/gkeonprem/operations/index.md +++ b/docs/google-docs/providers/google/gkeonprem/operations/index.md @@ -30,17 +30,24 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `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`. | +| `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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_bare_metal_admin_clusters_operations_get` | `SELECT` | `bareMetalAdminClustersId, locationsId, 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. | | `projects_locations_bare_metal_admin_clusters_operations_list` | `SELECT` | `bareMetalAdminClustersId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get` | `SELECT` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, 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. | | `projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_list` | `SELECT` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_bare_metal_clusters_operations_get` | `SELECT` | `bareMetalClustersId, locationsId, 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. | | `projects_locations_bare_metal_clusters_operations_list` | `SELECT` | `bareMetalClustersId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_vmware_admin_clusters_operations_get` | `SELECT` | `locationsId, operationsId, projectsId, vmwareAdminClustersId` | 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. | | `projects_locations_vmware_admin_clusters_operations_list` | `SELECT` | `locationsId, projectsId, vmwareAdminClustersId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_vmware_clusters_operations_get` | `SELECT` | `locationsId, operationsId, projectsId, vmwareClustersId` | 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. | | `projects_locations_vmware_clusters_operations_list` | `SELECT` | `locationsId, projectsId, vmwareClustersId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_vmware_clusters_vmware_node_pools_operations_get` | `SELECT` | `locationsId, operationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | 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. | | `projects_locations_vmware_clusters_vmware_node_pools_operations_list` | `SELECT` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_projects_locations_bare_metal_admin_clusters_operations_list` | `EXEC` | `bareMetalAdminClustersId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | @@ -50,11 +57,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_projects_locations_vmware_admin_clusters_operations_list` | `EXEC` | `locationsId, projectsId, vmwareAdminClustersId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_vmware_clusters_operations_list` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_vmware_clusters_vmware_node_pools_operations_list` | `EXEC` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `projects_locations_bare_metal_admin_clusters_operations_get` | `EXEC` | `bareMetalAdminClustersId, locationsId, 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. | -| `projects_locations_bare_metal_clusters_bare_metal_node_pools_operations_get` | `EXEC` | `bareMetalClustersId, bareMetalNodePoolsId, locationsId, 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. | -| `projects_locations_bare_metal_clusters_operations_get` | `EXEC` | `bareMetalClustersId, locationsId, 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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | -| `projects_locations_vmware_admin_clusters_operations_get` | `EXEC` | `locationsId, operationsId, projectsId, vmwareAdminClustersId` | 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. | -| `projects_locations_vmware_clusters_operations_get` | `EXEC` | `locationsId, operationsId, projectsId, vmwareClustersId` | 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. | -| `projects_locations_vmware_clusters_vmware_node_pools_operations_get` | `EXEC` | `locationsId, operationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | 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. | 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 5a808f9cc0..828d69896b 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,34 +29,34 @@ 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. | -| `imageType` | `string` | The OS image type for the VMware admin cluster. | -| `endpoint` | `string` | Output only. The DNS name of VMware admin cluster's API server. | | `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. | -| `vcenter` | `object` | VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. | -| `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. | | `platformConfig` | `object` | VmwarePlatformConfig represents configuration for the VMware platform. | | `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. | -| `addonNode` | `object` | VmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster. | +| `vcenter` | `object` | VmwareAdminVCenterConfig contains VCenter configuration for VMware admin cluster. | +| `loadBalancer` | `object` | VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster. | | `state` | `string` | Output only. The current state of VMware admin cluster. | | `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 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. | -| `createTime` | `string` | Output only. The time at which VMware admin cluster was created. | +| `bootstrapClusterMembership` | `string` | The bootstrap cluster this VMware admin cluster belongs to. | | `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | -| `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. | -| `loadBalancer` | `object` | VmwareAdminLoadBalancerConfig contains load balancer configuration for VMware admin cluster. | | `networkConfig` | `object` | VmwareAdminNetworkConfig contains network configuration for VMware admin cluster. | -| `bootstrapClusterMembership` | `string` | The bootstrap cluster this VMware admin cluster belongs to. | +| `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. | +| `addonNode` | `object` | VmwareAdminAddonNodeConfig contains add-on node configurations for VMware admin cluster. | +| `onPremVersion` | `string` | The Anthos clusters on the VMware version for the admin cluster. | +| `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. | | `updateTime` | `string` | Output only. The time at which VMware admin cluster was last updated. | | `uid` | `string` | Output only. The unique identifier of the VMware admin cluster. | +| `createTime` | `string` | Output only. The time at which VMware admin 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. | +| `antiAffinityGroups` | `object` | Specifies anti affinity group config for the VMware user cluster. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_vmware_admin_clusters_get` | `SELECT` | `locationsId, projectsId, vmwareAdminClustersId` | Gets details of a single VMware admin cluster. | | `projects_locations_vmware_admin_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists VMware admin clusters in a given project and location. | | `_projects_locations_vmware_admin_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists VMware admin clusters in a given project and location. | | `projects_locations_vmware_admin_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing VMware admin cluster to the Anthos On-Prem API within a given project and location. Through enrollment, an existing admin cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster will be expected to be performed through the API. | -| `projects_locations_vmware_admin_clusters_get` | `EXEC` | `locationsId, projectsId, vmwareAdminClustersId` | Gets details of a single VMware admin cluster. | | `projects_locations_vmware_admin_clusters_patch` | `EXEC` | `locationsId, projectsId, vmwareAdminClustersId` | Updates the parameters of a single VMware admin cluster. | | `projects_locations_vmware_admin_clusters_unenroll` | `EXEC` | `locationsId, projectsId, vmwareAdminClustersId` | Unenrolls an existing VMware admin cluster from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or its clients. | diff --git a/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters_iam_policies/index.md b/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters_iam_policies/index.md index 33a5c05274..d02e3134e9 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters_iam_policies/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_admin_clusters_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 d0e44fa12e..4fdb366d3d 100644 --- a/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md +++ b/docs/google-docs/providers/google/gkeonprem/vmware_clusters/index.md @@ -29,42 +29,44 @@ 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. | +| `onPremVersion` | `string` | Required. The Anthos clusters on the VMware version for your user cluster. | +| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | | `antiAffinityGroups` | `object` | Specifies anti affinity group config for the VMware user cluster. | -| `updateTime` | `string` | Output only. The time at which VMware user cluster was last updated. | -| `uid` | `string` | Output only. The unique identifier of the VMware user cluster. | +| `storage` | `object` | Specifies vSphere CSI components deployment config in 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. | +| `vmTrackingEnabled` | `boolean` | Enable VM tracking. | +| `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. | | `authorization` | `object` | Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster. | -| `status` | `object` | ResourceStatus describes why a cluster or node pool has a certain status. (e.g., ERROR or DEGRADED). | -| `endpoint` | `string` | Output only. The DNS name of VMware user cluster's API server. | -| `enableControlPlaneV2` | `boolean` | Enable control plane V2. Default to false. | -| `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 | -| `controlPlaneNode` | `object` | Specifies control plane node config for the VMware user cluster. | -| `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. | -| `vcenter` | `object` | Represents configuration for the VMware VCenter for the user cluster. | +| `adminClusterName` | `string` | Output only. The resource name of the VMware admin cluster hosting this user cluster. | | `networkConfig` | `object` | Specifies network config for the VMware user 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. | -| `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. | +| `controlPlaneNode` | `object` | Specifies control plane node config for the VMware user cluster. | +| `disableBundledIngress` | `boolean` | Disable bundled ingress. | +| `updateTime` | `string` | Output only. The time at which VMware user cluster was last updated. | | `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. ## | -| `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. | -| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | -| `vmTrackingEnabled` | `boolean` | Enable VM tracking. | +| `loadBalancer` | `object` | Specifies the locad balancer config for the VMware user cluster. | +| `upgradePolicy` | `object` | VmwareClusterUpgradePolicy defines the cluster upgrade policy. | | `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the VMware user cluster. | +| `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 | +| `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. | +| `vcenter` | `object` | Represents configuration for the VMware VCenter for the user cluster. | +| `uid` | `string` | Output only. The unique identifier of the VMware user cluster. | | `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. | +| `enableControlPlaneV2` | `boolean` | Enable control plane V2. Default to false. | | `deleteTime` | `string` | Output only. The time at which VMware user cluster was deleted. | -| `loadBalancer` | `object` | Specifies the locad balancer config for the VMware user cluster. | -| `adminClusterName` | `string` | Output only. The resource name of the VMware admin cluster hosting this user cluster. | -| `storage` | `object` | Specifies vSphere CSI components deployment config in the VMware user cluster. | +| `autoRepairConfig` | `object` | Specifies config to enable/disable auto repair. The cluster-health-controller is deployed only if Enabled is true. | +| `createTime` | `string` | Output only. The time at which VMware user cluster was created. | +| `endpoint` | `string` | Output only. The DNS name of VMware user cluster's API server. | +| `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. | | `validationCheck` | `object` | ValidationCheck represents the result of preflight check. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_vmware_clusters_get` | `SELECT` | `locationsId, projectsId, vmwareClustersId` | Gets details of a single VMware Cluster. | | `projects_locations_vmware_clusters_list` | `SELECT` | `locationsId, projectsId` | Lists VMware Clusters in a given project and location. | | `projects_locations_vmware_clusters_create` | `INSERT` | `locationsId, projectsId` | Creates a new VMware user cluster in a given project and location. | | `projects_locations_vmware_clusters_delete` | `DELETE` | `locationsId, projectsId, vmwareClustersId` | Deletes a single VMware Cluster. | | `_projects_locations_vmware_clusters_list` | `EXEC` | `locationsId, projectsId` | Lists VMware Clusters in a given project and location. | | `projects_locations_vmware_clusters_enroll` | `EXEC` | `locationsId, projectsId` | Enrolls an existing VMware user cluster and its node pools to the Anthos On-Prem API within a given project and location. Through enrollment, an existing cluster will become Anthos On-Prem API managed. The corresponding GCP resources will be created and all future modifications to the cluster and/or its node pools will be expected to be performed through the API. | -| `projects_locations_vmware_clusters_get` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Gets details of a single VMware Cluster. | | `projects_locations_vmware_clusters_patch` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Updates the parameters of a single VMware cluster. | | `projects_locations_vmware_clusters_query_version_config` | `EXEC` | `locationsId, projectsId` | Queries the VMware user cluster version config. | | `projects_locations_vmware_clusters_unenroll` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Unenrolls an existing VMware user cluster and its node pools from the Anthos On-Prem API within a given project and location. Unenrollment removes the Cloud reference to the cluster without modifying the underlying OnPrem Resources. Clusters and node pools will continue to run; however, they will no longer be accessible through the Anthos On-Prem API or UI. | 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 2819409b0b..0e6f4b681d 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,27 +28,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name of this 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. | -| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the node pool. | -| `onPremVersion` | `string` | Anthos version for the node pool. Defaults to the user cluster version. | -| `deleteTime` | `string` | Output only. The time at which this node pool was deleted. If the resource is not deleted, this must be empty | -| `updateTime` | `string` | Output only. The time at which this node pool was last updated. | -| `config` | `object` | Parameters that describe the configuration of all nodes within a given node pool. | | `nodePoolAutoscaling` | `object` | NodePoolAutoscaling config for the NodePool to allow for the kubernetes to scale NodePool. | -| `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. | -| `displayName` | `string` | The display name for the node pool. | | `state` | `string` | Output only. The current state of the node pool. | +| `updateTime` | `string` | Output only. The time at which this node pool was last updated. | +| `onPremVersion` | `string` | Anthos version for the node pool. Defaults to the user cluster version. | | `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 node pool was created. | | `uid` | `string` | Output only. The unique identifier 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. | +| `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 | +| `config` | `object` | Parameters that describe the configuration of all nodes within a given node pool. | +| `reconciling` | `boolean` | Output only. If set, there are currently changes in flight to the node pool. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_vmware_clusters_vmware_node_pools_get` | `SELECT` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Gets details of a single VMware node pool. | | `projects_locations_vmware_clusters_vmware_node_pools_list` | `SELECT` | `locationsId, projectsId, vmwareClustersId` | Lists VMware node pools in a given project, location and VMWare cluster. | | `projects_locations_vmware_clusters_vmware_node_pools_create` | `INSERT` | `locationsId, projectsId, vmwareClustersId` | Creates a new VMware node pool in a given project, location and VMWare cluster. | | `projects_locations_vmware_clusters_vmware_node_pools_delete` | `DELETE` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Deletes a single VMware node pool. | | `_projects_locations_vmware_clusters_vmware_node_pools_list` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Lists VMware node pools in a given project, location and VMWare cluster. | | `projects_locations_vmware_clusters_vmware_node_pools_enroll` | `EXEC` | `locationsId, projectsId, vmwareClustersId` | Enrolls a VMware node pool to Anthos On-Prem API | -| `projects_locations_vmware_clusters_vmware_node_pools_get` | `EXEC` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Gets details of a single VMware node pool. | | `projects_locations_vmware_clusters_vmware_node_pools_patch` | `EXEC` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Updates the parameters of a single VMware node pool. | | `projects_locations_vmware_clusters_vmware_node_pools_unenroll` | `EXEC` | `locationsId, projectsId, vmwareClustersId, vmwareNodePoolsId` | Unenrolls a VMware node pool to Anthos On-Prem API | 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 8764ecc67d..00a2b2f386 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 c70415ddb1..85ce9f66c3 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. | -| `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. | | `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. | ## 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..2c467c6529 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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 c9cf9a850b..718c2a685c 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/consents/index.md b/docs/google-docs/providers/google/healthcare/consents/index.md index e805baf3ed..8d4dcf8cf3 100644 --- a/docs/google-docs/providers/google/healthcare/consents/index.md +++ b/docs/google-docs/providers/google/healthcare/consents/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. | -| `userId` | `string` | Required. User's UUID provided by the client. | | `state` | `string` | Required. Indicates the current state of this Consent. | -| `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. | +| `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | +| `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}`. | +| `userId` | `string` | Required. User's UUID provided by the client. | | `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. | +| `policies` | `array` | Optional. Represents a user's consent in terms of the resources that can be accessed and under what conditions. | | `ttl` | `string` | Input only. The time to live for this Consent from when it is created. | -| `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. | ## 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 e054aeb780..f146994384 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. | -| `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. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `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. | +| `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. | +| `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | | `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. | -| `expireTime` | `string` | Timestamp in UTC of when this Consent is considered expired. | -| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | -| `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}`. | -| `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. | -| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 0af85cf3be..5301cdcd17 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 e189b40483..d555babc3f 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_policies/index.md b/docs/google-docs/providers/google/healthcare/dicom_stores_iam_policies/index.md index bb38b5fbce..2613820528 100644 --- a/docs/google-docs/providers/google/healthcare/dicom_stores_iam_policies/index.md +++ b/docs/google-docs/providers/google/healthcare/dicom_stores_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| 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 23c555305c..f3983f0006 100644 --- a/docs/google-docs/providers/google/healthcare/fhir_stores/index.md +++ b/docs/google-docs/providers/google/healthcare/fhir_stores/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 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. | -| `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`. | | `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. | +| `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. | | `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. | -| `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. | +| `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. | -| `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. | +| `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. | +| `notificationConfig` | `object` | Specifies where to send notifications upon changes to a data store. | +| `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. | +| `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`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 b7627308c3..31f710f88c 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}`. | -| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 2cad4f1eec..de151af355 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/healthcare/index.md b/docs/google-docs/providers/google/healthcare/index.md index aaaf858bf8..abd9eb6712 100644 --- a/docs/google-docs/providers/google/healthcare/index.md +++ b/docs/google-docs/providers/google/healthcare/index.md @@ -33,7 +33,7 @@ Manage, Store, And Access Healthcare Data In Google Cloud Platform. TypeService TitleCloud Healthcare API DescriptionManage, Store, And Access Healthcare Data In Google Cloud Platform. -Idhealthcare:v23.08.00161 +Idhealthcare:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/healthcare/locations/index.md b/docs/google-docs/providers/google/healthcare/locations/index.md index 7dc1054949..674ebba4e0 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"` | +| `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/healthcare/messages/index.md b/docs/google-docs/providers/google/healthcare/messages/index.md index 0965d58e54..a0187c687d 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. | +| `sendFacility` | `string` | The hospital that this message came from. MSH-4. | +| `sendTime` | `string` | The datetime the sending application sent this message. MSH-7. | | `messageType` | `string` | The message type for this message. MSH-9.1. | -| `patientIds` | `array` | All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. | | `parsedData` | `object` | The content of a HL7v2 message in a structured format. | -| `createTime` | `string` | Output only. The datetime when the message was created. Set by the server. | | `data` | `string` | Raw message bytes. | -| `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. | | `schematizedData` | `object` | The content of an HL7v2 message in a structured format as specified by a schema. | -| `sendTime` | `string` | The datetime the sending application sent this message. MSH-7. | -| `sendFacility` | `string` | The hospital that this message came from. MSH-4. | +| `patientIds` | `array` | All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. | +| `createTime` | `string` | Output only. The datetime when the message was created. Set by the server. | +| `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/user_data_mappings/index.md b/docs/google-docs/providers/google/healthcare/user_data_mappings/index.md index 9a936fa632..99519bb162 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}`. | -| `archiveTime` | `string` | Output only. Indicates the time when this mapping was archived. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/iam/index.md b/docs/google-docs/providers/google/iam/index.md index 580d3495eb..263a17ad3e 100644 --- a/docs/google-docs/providers/google/iam/index.md +++ b/docs/google-docs/providers/google/iam/index.md @@ -20,7 +20,7 @@ Manages Identity And Access Control For Google Cloud Platform Resources, Includi
total resources: 2
-total selectable resources: 1
+total selectable resources: 2
total methods: 7
@@ -33,7 +33,7 @@ Manages Identity And Access Control For Google Cloud Platform Resources, Includi TypeService TitleIdentity And Access Management (IAM) API DescriptionManages Identity And Access Control For Google Cloud Platform Resources, Including The Creation Of Service Accounts, Which You Can Use To Authenticate To Google And Make API Calls. -Idiam:v23.08.00161 +Idiam:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/iam/operations/index.md b/docs/google-docs/providers/google/iam/operations/index.md index 2f086e85d1..9ac779ec62 100644 --- a/docs/google-docs/providers/google/iam/operations/index.md +++ b/docs/google-docs/providers/google/iam/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.iam.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}`. | +| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/iam/policies/index.md b/docs/google-docs/providers/google/iam/policies/index.md index eedb63d3fe..e6697fc15e 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. | -| `kind` | `string` | Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`. | -| `displayName` | `string` | A user-specified description of the `Policy`. This value can be up to 63 characters. | +| `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. | | `createTime` | `string` | Output only. The time when the `Policy` was created. | +| `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. | | `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`. | -| `uid` | `string` | Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created. | +| `kind` | `string` | Output only. The kind of the `Policy`. Always contains the value `DenyPolicy`. | +| `displayName` | `string` | A user-specified description of the `Policy`. This value can be up to 63 characters. | | `updateTime` | `string` | Output only. The time when the `Policy` was last updated. | | `deleteTime` | `string` | Output only. The time when the `Policy` was deleted. Empty if the policy is not deleted. | -| `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. | -| `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. | +| `uid` | `string` | Immutable. The globally unique ID of the `Policy`. Assigned automatically when the `Policy` is created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/iamcredentials/index.md b/docs/google-docs/providers/google/iamcredentials/index.md index 9afeee0f74..6d92be1ba3 100644 --- a/docs/google-docs/providers/google/iamcredentials/index.md +++ b/docs/google-docs/providers/google/iamcredentials/index.md @@ -33,7 +33,7 @@ Creates Short-Lived Credentials For Impersonating IAM Service Accounts. To Enabl TypeService TitleIAM Service Account Credentials API DescriptionCreates Short-Lived Credentials For Impersonating IAM Service Accounts. To Enable This API, You Must Enable The IAM API (Iam.Googleapis.Com). -Idiamcredentials:v23.08.00161 +Idiamcredentials:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/iap/brands/index.md b/docs/google-docs/providers/google/iap/brands/index.md index 4975dfce38..c7bafcd6a7 100644 --- a/docs/google-docs/providers/google/iap/brands/index.md +++ b/docs/google-docs/providers/google/iap/brands/index.md @@ -25,12 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Output only. Identifier of the brand. NOTE: GCP project number achieves the same brand identification purpose as only one brand per project can be created. | -| `applicationTitle` | `string` | Application name displayed on OAuth consent screen. | -| `orgInternalOnly` | `boolean` | Output only. Whether the brand is only intended for usage inside the G Suite organization only. | -| `supportEmail` | `string` | Support email displayed on the OAuth consent screen. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 cb4af5e614..9d47821aef 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 (-). | -| `cidrs` | `array` | Unordered list. List of CIDRs that this group applies to. | | `fqdns` | `array` | Unordered list. List of FQDNs that this group applies to. | +| `cidrs` | `array` | Unordered list. List of CIDRs that this group applies to. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 651b7ce200..a7ed983466 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. | -| `secret` | `string` | Output only. Client secret of the OAuth client. | | `displayName` | `string` | Human-friendly name given to the OAuth client. | +| `secret` | `string` | Output only. Client secret of the OAuth client. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/iap/index.md b/docs/google-docs/providers/google/iap/index.md index 11031833b5..03f14ea4c7 100644 --- a/docs/google-docs/providers/google/iap/index.md +++ b/docs/google-docs/providers/google/iap/index.md @@ -33,7 +33,7 @@ Controls Access To Cloud Applications Running On Google Cloud Platform. TypeService TitleCloud Identity-Aware Proxy API DescriptionControls Access To Cloud Applications Running On Google Cloud Platform. -Idiap:v23.08.00161 +Idiap:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/identitytoolkit/index.md b/docs/google-docs/providers/google/identitytoolkit/index.md index 6e625c049d..f54145471c 100644 --- a/docs/google-docs/providers/google/identitytoolkit/index.md +++ b/docs/google-docs/providers/google/identitytoolkit/index.md @@ -33,7 +33,7 @@ Help The Third Party Sites To Implement Federated Login. TypeService TitleGoogle Identity Toolkit API DescriptionHelp The Third Party Sites To Implement Federated Login. -Ididentitytoolkit:v23.08.00161 +Ididentitytoolkit:v23.08.00163 ## Resources 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 7b407d5eb5..7ee8d1b162 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 | |:-----|:---------|:------------| -| `legacyResetPasswordTemplate` | `object` | Template for an email template. | -| `allowPasswordUser` | `boolean` | Whether to allow password user sign in or sign up. | -| `enableAnonymousUser` | `boolean` | Whether anonymous user is enabled. | -| `resetPasswordTemplate` | `object` | Template for an email template. | -| `useEmailSending` | `boolean` | Whether to use email sending provided by Firebear. | -| `changeEmailTemplate` | `object` | Template for an email template. | | `apiKey` | `string` | Browser API key, needed when making http request to Apiary. | -| `authorizedDomains` | `array` | Authorized domains. | -| `dynamicLinksDomain` | `string` | | | `idpConfig` | `array` | OAuth2 provider configuration. | +| `useEmailSending` | `boolean` | Whether to use email sending provided by Firebear. | +| `legacyResetPasswordTemplate` | `object` | Template for an email template. | +| `changeEmailTemplate` | `object` | Template for an email template. | +| `enableAnonymousUser` | `boolean` | Whether anonymous user is enabled. | | `projectId` | `string` | Project ID of the relying party. | +| `allowPasswordUser` | `boolean` | Whether to allow password user sign in or sign up. | +| `dynamicLinksDomain` | `string` | | | `verifyEmailTemplate` | `object` | Template for an email template. | +| `authorizedDomains` | `array` | Authorized domains. | +| `resetPasswordTemplate` | `object` | Template for an email template. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/identitytoolkit/relyingparty_recaptcha_param/index.md b/docs/google-docs/providers/google/identitytoolkit/relyingparty_recaptcha_param/index.md index 3628fb3720..6efee3312a 100644 --- a/docs/google-docs/providers/google/identitytoolkit/relyingparty_recaptcha_param/index.md +++ b/docs/google-docs/providers/google/identitytoolkit/relyingparty_recaptcha_param/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `recaptchaStoken` | `string` | The stoken field for the recaptcha widget, used to request captcha challenge. | | `kind` | `string` | The fixed string "identitytoolkit#GetRecaptchaParamResponse". | | `recaptchaSiteKey` | `string` | Site key registered at recaptcha. | +| `recaptchaStoken` | `string` | The stoken field for the recaptcha widget, used to request captcha challenge. | ## 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 324bdf2a13..2e80fd0c3a 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. | -| `endpointForwardingRule` | `string` | Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule. | -| `state` | `string` | Output only. Current state of the endpoint. | -| `updateTime` | `string` | Output only. The update time timestamp. | | `threatExceptions` | `array` | List of threat IDs to be excepted from generating alerts. | | `labels` | `object` | The labels of the endpoint. | | `network` | `string` | Required. The fully qualified URL of the network to which the IDS Endpoint is attached. | | `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. | | `createTime` | `string` | Output only. The create time timestamp. | +| `severity` | `string` | Required. Lowest threat severity that this endpoint will alert on. | +| `state` | `string` | Output only. Current state of the endpoint. | +| `trafficLogs` | `boolean` | Whether the endpoint should report traffic logs in addition to threat logs. | +| `endpointForwardingRule` | `string` | Output only. The fully qualified URL of the endpoint's ILB Forwarding Rule. | +| `updateTime` | `string` | Output only. The update time timestamp. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ids/index.md b/docs/google-docs/providers/google/ids/index.md index 1d850db384..1853e40b7a 100644 --- a/docs/google-docs/providers/google/ids/index.md +++ b/docs/google-docs/providers/google/ids/index.md @@ -33,7 +33,7 @@ Cloud IDS (Cloud Intrusion Detection System) Detects Malware, Spyware, Command-A TypeService TitleCloud IDS API DescriptionCloud IDS (Cloud Intrusion Detection System) Detects Malware, Spyware, Command-And-Control Attacks, And Other Network-Based Threats. Its Security Efficacy Is Industry Leading, Built With Palo Alto Networks Technologies. When You Use This Product, Your Organization Name And Consumption Levels Will Be Shared With Palo Alto Networks. -Idids:v23.08.00161 +Idids:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/ids/locations/index.md b/docs/google-docs/providers/google/ids/locations/index.md index a314e7eaac..7d3b3edc9e 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"` | -| `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/integrations/auth_configs/index.md b/docs/google-docs/providers/google/integrations/auth_configs/index.md index db6334e567..cdc4b1cbf7 100644 --- a/docs/google-docs/providers/google/integrations/auth_configs/index.md +++ b/docs/google-docs/providers/google/integrations/auth_configs/index.md @@ -29,21 +29,21 @@ 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. | -| `state` | `string` | The status of the auth config. | -| `updateTime` | `string` | Output only. The timestamp when the auth config is modified. | -| `validTime` | `string` | The time until the auth config is valid. Empty or max value is considered the auth config won't expire. | +| `visibility` | `string` | The visibility of the auth config. | | `credentialType` | `string` | Credential type of the encrypted credential. | -| `createTime` | `string` | Output only. The timestamp when the auth config is created. | -| `displayName` | `string` | Required. The name of the auth config. | +| `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. | +| `validTime` | `string` | The time until the auth config is valid. Empty or max value is considered the auth config won't expire. | +| `decryptedCredential` | `object` | Defines parameters for a single, canonical credential. | | `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. | -| `visibility` | `string` | The visibility of the auth config. | -| `reason` | `string` | The reason / details of the current status. | | `encryptedCredential` | `string` | Auth credential encrypted by Cloud KMS. Can be decrypted as Credential with proper KMS key. | -| `decryptedCredential` | `object` | Defines parameters for a single, canonical credential. | +| `reason` | `string` | The reason / details of the current status. | +| `createTime` | `string` | Output only. The timestamp when the auth config is created. | | `lastModifierEmail` | `string` | The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | | `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 | -| `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. | +| `updateTime` | `string` | Output only. The timestamp when the auth config is modified. | +| `displayName` | `string` | Required. The name of the auth config. | ## 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 92e6f37050..30497ec98f 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 | -| `validStartTime` | `string` | Output only. The timestamp after which certificate will be valid | -| `certificateStatus` | `string` | Status of the certificate | +| `credentialId` | `string` | Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY | +| `requestorId` | `string` | Immutable. Requestor ID to be used to register certificate with trawler | | `validEndTime` | `string` | Output only. The timestamp after which certificate will expire | +| `validStartTime` | `string` | Output only. The timestamp after which certificate will be valid | | `displayName` | `string` | Required. Name of the certificate | | `rawCertificate` | `object` | Contains client certificate information | -| `credentialId` | `string` | Immutable. Credential id that will be used to register with trawler INTERNAL_ONLY | -| `requestorId` | `string` | Immutable. Requestor ID to be used to register certificate with trawler | +| `certificateStatus` | `string` | Status 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 b73ea90ba2..73707e67ef 100644 --- a/docs/google-docs/providers/google/integrations/connections/index.md +++ b/docs/google-docs/providers/google/integrations/connections/index.md @@ -29,30 +29,30 @@ 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. | -| `serviceAccount` | `string` | Optional. Service account needed for runtime plane to access Google Cloud resources. | -| `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. | | `sslConfig` | `object` | SSL Configuration of a connection | -| `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" | -| `nodeConfig` | `object` | Node configuration for the connection. | +| `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 | +| `authConfig` | `object` | AuthConfig defines details of a authentication type. | +| `configVariables` | `array` | Optional. Configuration for configuring the connection with an external system. | +| `destinationConfigs` | `array` | Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s). | +| `suspended` | `boolean` | Optional. Suspended indicates if a user has suspended a connection or not. | | `subscriptionType` | `string` | Output only. This subscription type enum states the subscription type of the project. | +| `envoyImageLocation` | `string` | Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} | +| `eventingEnablementType` | `string` | Optional. Eventing enablement type. Will be nil if eventing is not enabled. | +| `imageLocation` | `string` | Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} | | `connectorVersionInfraConfig` | `object` | This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version | +| `connectorVersionLaunchStage` | `string` | Output only. Flag to mark the version indicating the launch stage. | | `createTime` | `string` | Output only. Created time. | | `connectionRevision` | `string` | Output only. Connection revision. This field is only updated when the connection is created or updated by User. | -| `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 | -| `imageLocation` | `string` | Output only. GCR location where the runtime image is stored. formatted like: gcr.io/{bucketName}/{imageName} | -| `authConfig` | `object` | AuthConfig defines details of a authentication type. | +| `eventingRuntimeData` | `object` | Eventing runtime data has the details related to eventing managed by the system. | +| `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" | +| `nodeConfig` | `object` | Node configuration for the connection. | | `updateTime` | `string` | Output only. Updated time. | -| `eventingEnablementType` | `string` | Optional. Eventing enablement type. Will be nil if eventing is not enabled. | -| `envoyImageLocation` | `string` | Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName} | | `lockConfig` | `object` | Determines whether or no a connection is locked. If locked, a reason must be specified. | -| `suspended` | `boolean` | Optional. Suspended indicates if a user has suspended a connection or not. | -| `eventingConfig` | `object` | Eventing Configuration of a connection | -| `configVariables` | `array` | Optional. Configuration for configuring the connection with an external system. | +| `serviceAccount` | `string` | Optional. Service account needed for runtime plane to access Google Cloud resources. | | `logConfig` | `object` | Log configuration for the connection. | -| `eventingRuntimeData` | `object` | Eventing runtime data has the details related to eventing managed by the system. | -| `connectorVersionLaunchStage` | `string` | Output only. Flag to mark the version indicating the launch stage. | +| `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. | | `status` | `object` | ConnectionStatus indicates the state of the connection. | -| `destinationConfigs` | `array` | Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s). | +| `eventingConfig` | `object` | Eventing Configuration of a connection | ## 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 ea028143e8..ff4168ab62 100644 --- a/docs/google-docs/providers/google/integrations/executions/index.md +++ b/docs/google-docs/providers/google/integrations/executions/index.md @@ -28,23 +28,23 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Auto-generated primary key. | -| `updateTime` | `string` | Output only. Last modified time of the 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 | +| `executionDetails` | `object` | Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. | | `requestParams` | `array` | Event parameters come in as part of the request. | -| `executionMethod` | `string` | The ways user posts this event. | | `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. | -| `createTime` | `string` | Output only. Created time of the execution. | -| `directSubExecutions` | `array` | Direct sub executions of the following Execution. | -| `executionDetails` | `object` | Contains the details of the execution info: this includes the tasks execution details plus the event execution statistics. | -| `requestParameters` | `object` | Event parameters come in as part of the request. | +| `executionMethod` | `string` | The ways user posts this event. | | `responseParams` | `array` | Event parameters come out as part of the response. | +| `directSubExecutions` | `array` | Direct sub executions of the following Execution. | +| `updateTime` | `string` | Output only. Last modified time of the execution. | | `responseParameters` | `object` | Event parameters returned as part of the response. | +| `createTime` | `string` | Output only. Created time of the 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 | +| `requestParameters` | `object` | Event parameters come in as part of the request. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| | `projects_locations_integrations_executions_list` | `SELECT` | `integrationsId, locationsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | +| `projects_locations_products_integrations_executions_get` | `SELECT` | `executionsId, integrationsId, locationsId, productsId, projectsId` | Get an execution in the specified project. | | `projects_locations_products_integrations_executions_list` | `SELECT` | `integrationsId, locationsId, productsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | | `_projects_locations_integrations_executions_list` | `EXEC` | `integrationsId, locationsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | | `_projects_locations_products_integrations_executions_list` | `EXEC` | `integrationsId, locationsId, productsId, projectsId` | Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI. | | `projects_locations_products_integrations_executions_cancel` | `EXEC` | `executionsId, integrationsId, locationsId, productsId, projectsId` | Cancellation of an execution | -| `projects_locations_products_integrations_executions_get` | `EXEC` | `executionsId, integrationsId, locationsId, productsId, projectsId` | Get an execution in the specified project. | diff --git a/docs/google-docs/providers/google/integrations/index.md b/docs/google-docs/providers/google/integrations/index.md index 4a7a6109d2..ac8244b36c 100644 --- a/docs/google-docs/providers/google/integrations/index.md +++ b/docs/google-docs/providers/google/integrations/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleApplication Integration API Description -Idintegrations:v23.08.00161 +Idintegrations:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/integrations/integrations/index.md b/docs/google-docs/providers/google/integrations/integrations/index.md index 31cc9552da..c15f92c50c 100644 --- a/docs/google-docs/providers/google/integrations/integrations/index.md +++ b/docs/google-docs/providers/google/integrations/integrations/index.md @@ -29,8 +29,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. The resource name of the integration. | | `description` | `string` | Optional. | -| `updateTime` | `string` | Output only. Auto-generated. | | `active` | `boolean` | Required. If any integration version is published. | +| `updateTime` | `string` | Output only. Auto-generated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 564ec9ec22..24b82051b8 100644 --- a/docs/google-docs/providers/google/integrations/sfdc_channels/index.md +++ b/docs/google-docs/providers/google/integrations/sfdc_channels/index.md @@ -29,12 +29,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 | -| `createTime` | `string` | Output only. Time when the channel is created | | `deleteTime` | `string` | Output only. Time when the channel was deleted. Empty if not deleted. | -| `lastReplayId` | `string` | Last sfdc messsage replay id for 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. | | `displayName` | `string` | Client level unique name/alias to easily reference a channel. | | `updateTime` | `string` | Output only. Time when the channel was last updated | +| `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 | | `channelTopic` | `string` | The Channel topic defined by salesforce once an channel is opened | ## 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 e7bdd8a81a..b2da84a7cb 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. | -| `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. | -| `createTime` | `string` | Output only. Time when the instance is created | | `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. | | `serviceAuthority` | `string` | URL used for API calls after authentication (the login authority is configured within the referenced AuthConfig). | | `sfdcOrgId` | `string` | The SFDC Org Id. This is defined in salesforce. | +| `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 | ## 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 e0f3e9211a..765d2f41d1 100644 --- a/docs/google-docs/providers/google/integrations/suspensions/index.md +++ b/docs/google-docs/providers/google/integrations/suspensions/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Resource name for suspensions suspension/{suspension_id} | -| `integration` | `string` | Required. The name of the originating integration. | -| `taskId` | `string` | Required. Task id of the associated SuspensionTask. | -| `suspensionConfig` | `object` | | -| `createTime` | `string` | Output only. Auto-generated. | -| `eventExecutionInfoId` | `string` | Required. ID of the associated execution. | | `approvalConfig` | `object` | Configurations for approving the Suspension. | +| `createTime` | `string` | Output only. Auto-generated. | | `audit` | `object` | Contains when and by whom the suspension was resolved. | +| `suspensionConfig` | `object` | | +| `taskId` | `string` | Required. Task id of the associated SuspensionTask. | +| `integration` | `string` | Required. The name of the originating integration. | +| `eventExecutionInfoId` | `string` | Required. ID of the associated execution. | | `lastModifyTime` | `string` | Output only. Auto-generated. | | `state` | `string` | Required. State of this suspension, indicating what action a resolver has taken. | ## Methods diff --git a/docs/google-docs/providers/google/integrations/versions/index.md b/docs/google-docs/providers/google/integrations/versions/index.md index a50fc47329..817823aef4 100644 --- a/docs/google-docs/providers/google/integrations/versions/index.md +++ b/docs/google-docs/providers/google/integrations/versions/index.md @@ -27,28 +27,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `name` | `string` | Output only. Auto-generated primary key. | -| `description` | `string` | Optional. The integration description. | -| `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 integration. It's optional. | +| `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. | | `triggerConfigs` | `array` | Optional. Trigger configurations. | -| `state` | `string` | Output only. User should not set it as an input. | -| `lastModifierEmail` | `string` | Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | -| `origin` | `string` | Optional. The origin that indicates where this integration is coming from. | -| `status` | `string` | Output only. Generated by eventbus. User should not set it as an input. | | `userLabel` | `string` | Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created. | -| `snapshotNumber` | `string` | Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head. | +| `errorCatcherConfigs` | `array` | Optional. Error Catch Task configuration for the IntegrationTemplateVersion. It's optional. | +| `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. | | `updateTime` | `string` | Output only. Auto-generated. | -| `runAsServiceAccount` | `string` | Optional. The run-as service account email, if set and auth config is not configured, that will be used to generate auth token to be used in Connector task, Rest caller task and Cloud function task. | -| `triggerConfigsInternal` | `array` | Optional. Trigger configurations. | +| `parentIntegrationVersionId` | `string` | Optional. ID of the IntegrationVersion that was used to create this IntegrationTemplateVersion | | `teardown` | `object` | | -| `integrationParametersInternal` | `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. | -| `taskConfigsInternal` | `array` | Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. | -| `integrationParameters` | `array` | Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. | +| `lastModifierEmail` | `string` | Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `snapshotNumber` | `string` | Output only. An increasing sequence that is set when a new snapshot is created. | +| `status` | `string` | Optional. Generated by eventbus. User should not set it as an input. | +| `taskConfigs` | `array` | Optional. Task configuration for the IntegrationTemplateVersion. It's optional, but the IntegrationTemplateVersion doesn't do anything without task_configs. | | `createTime` | `string` | Output only. Auto-generated. | -| `taskConfigs` | `array` | Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. | -| `parentTemplateId` | `string` | Optional. The id of the template which was used to create this integration_version. | -| `lockHolder` | `string` | Optional. The edit lock holder's email address. Generated based on the End User Credentials/LOAS role of the user making the call. | +| `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. | ## 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 7fb14d957c..885e86688c 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". | -| `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. | | `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. | -| `derivedInfo` | `object` | Derived details about the company. | -| `size` | `string` | The employer's company size. | -| `displayName` | `string` | Required. The display name of the company, for example, "Google LLC". | -| `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. | +| `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. | | `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. | +| `hiringAgency` | `boolean` | Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. | +| `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. | +| `derivedInfo` | `object` | Derived details about the company. | | `careerSiteUri` | `string` | The URI to employer's career site or careers page on the employer's web site, for example, "https://careers.google.com". | | `imageUri` | `string` | A URI that hosts the employer's company logo. | -| `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. | -| `hiringAgency` | `boolean` | Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided. | +| `externalId` | `string` | Required. Client side company identifier, used to uniquely identify the company. The maximum number of allowed characters is 255. | +| `size` | `string` | The employer's company size. | +| `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. | +| `displayName` | `string` | Required. The display name of the company, for example, "Google LLC". | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/jobs/index.md b/docs/google-docs/providers/google/jobs/index.md index 270c46c4ee..12995cf2be 100644 --- a/docs/google-docs/providers/google/jobs/index.md +++ b/docs/google-docs/providers/google/jobs/index.md @@ -20,7 +20,7 @@ Cloud Talent Solution Provides The Capability To Create, Read, Update, And Delet
total resources: 5
-total selectable resources: 3
+total selectable resources: 4
total methods: 26
@@ -33,7 +33,7 @@ Cloud Talent Solution Provides The Capability To Create, Read, Update, And Delet TypeService TitleCloud Talent Solution API DescriptionCloud Talent Solution Provides The Capability To Create, Read, Update, And Delete Job Postings, As Well As Search Jobs Based On Keywords And Filters. -Idjobs:v23.08.00161 +Idjobs:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/jobs/jobs/index.md b/docs/google-docs/providers/google/jobs/jobs/index.md index f165049c9b..e1fc581dca 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. | -| `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'. | -| `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. | -| `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". | -| `processingOptions` | `object` | Options for job processing. | -| `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. | -| `visibility` | `string` | Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. | -| `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. | -| `applicationInfo` | `object` | Application related details of a job posting. | -| `postingCreateTime` | `string` | Output only. The timestamp when this job posting was created. | -| `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. | -| `derivedInfo` | `object` | Derived details about the job posting. | +| `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. | | `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. | -| `title` | `string` | Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. | -| `department` | `string` | The department or functional area within the company with the open position. The maximum number of allowed characters is 255. | +| `employmentTypes` | `array` | The employment type(s) of a job, for example, full time or part time. | | `companyDisplayName` | `string` | Output only. Display name of the company listing 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. | -| `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. | -| `jobLevel` | `string` | The experience level associated with the job, such as "Entry Level". | -| `degreeTypes` | `array` | The desired education degrees for the job, such as Bachelors, Masters. | -| `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. | +| `department` | `string` | The department or functional area within the company with the open position. The maximum number of allowed characters is 255. | +| `derivedInfo` | `object` | Derived details about the job posting. | +| `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. | | `postingUpdateTime` | `string` | Output only. The timestamp when this job posting was last updated. | +| `jobBenefits` | `array` | The benefits included with the job. | | `compensationInfo` | `object` | Job compensation details. | +| `jobLevel` | `string` | The experience level associated with the job, such as "Entry Level". | +| `jobStartTime` | `string` | The start timestamp of the job in UTC time zone. Typically this field is used for contracting engagements. Invalid timestamps are ignored. | +| `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. | +| `degreeTypes` | `array` | The desired education degrees for the job, such as Bachelors, Masters. | +| `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". | +| `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. | | `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. | -| `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. | +| `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. | +| `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'. | +| `visibility` | `string` | Deprecated. The job is only visible to the owner. The visibility of the job. Defaults to Visibility.ACCOUNT_ONLY if not specified. | +| `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. | +| `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. | | `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. | -| `jobBenefits` | `array` | The benefits included with the job. | -| `employmentTypes` | `array` | The employment type(s) of a job, for example, full time or part time. | +| `postingCreateTime` | `string` | Output only. The timestamp when this job posting was created. | +| `applicationInfo` | `object` | Application related details of a job posting. | +| `processingOptions` | `object` | Options for job processing. | +| `title` | `string` | Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/jobs/operations/index.md b/docs/google-docs/providers/google/jobs/operations/index.md index 1981abeb2b..354562b139 100644 --- a/docs/google-docs/providers/google/jobs/operations/index.md +++ b/docs/google-docs/providers/google/jobs/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.jobs.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}`. | +| `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/kmsinventory/crypto_keys/index.md b/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md index 21fcf04e50..69f593e73f 100644 --- a/docs/google-docs/providers/google/kmsinventory/crypto_keys/index.md +++ b/docs/google-docs/providers/google/kmsinventory/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/*`. | -| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | +| `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. | | `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. | | `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. | -| `createTime` | `string` | Output only. The time at which this CryptoKey was created. | +| `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. | -| `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. | -| `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. | | `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. | -| `purpose` | `string` | Immutable. The immutable purpose of this CryptoKey. | +| `createTime` | `string` | Output only. The time at which this CryptoKey was created. | +| `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). | +| `importOnly` | `boolean` | Immutable. Whether this key may contain imported versions only. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/kmsinventory/crypto_keys_protected_resources_summary/index.md b/docs/google-docs/providers/google/kmsinventory/crypto_keys_protected_resources_summary/index.md index 3638b56229..0fd29b7db3 100644 --- a/docs/google-docs/providers/google/kmsinventory/crypto_keys_protected_resources_summary/index.md +++ b/docs/google-docs/providers/google/kmsinventory/crypto_keys_protected_resources_summary/index.md @@ -25,8 +25,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The full name of the ProtectedResourcesSummary resource. Example: projects/test-project/locations/us/keyRings/test-keyring/cryptoKeys/test-key/protectedResourcesSummary | +| `projectCount` | `integer` | The number of distinct Cloud projects in the same Cloud organization as the key that have resources protected by the key. | +| `resourceCount` | `string` | The total number of protected resources in the same Cloud organization as the key. | +| `resourceTypes` | `object` | The number of resources protected by the key grouped by resource type. | +| `cloudProducts` | `object` | The number of resources protected by the key grouped by Cloud product. | +| `locations` | `object` | The number of resources protected by the key grouped by region. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_protected_resources_summary` | `EXEC` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | +| `get_protected_resources_summary` | `SELECT` | `cryptoKeysId, keyRingsId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/kmsinventory/index.md b/docs/google-docs/providers/google/kmsinventory/index.md index be16a65b92..a094a1642d 100644 --- a/docs/google-docs/providers/google/kmsinventory/index.md +++ b/docs/google-docs/providers/google/kmsinventory/index.md @@ -20,7 +20,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 3
-total selectable resources: 1
+total selectable resources: 2
total methods: 4
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleKMS Inventory API Description -Idkmsinventory:v23.08.00161 +Idkmsinventory:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/language/index.md b/docs/google-docs/providers/google/language/index.md index c0881b6292..ff6956f039 100644 --- a/docs/google-docs/providers/google/language/index.md +++ b/docs/google-docs/providers/google/language/index.md @@ -33,7 +33,7 @@ Provides Natural Language Understanding Technologies, Such As Sentiment Analysis TypeService TitleCloud Natural Language API DescriptionProvides Natural Language Understanding Technologies, Such As Sentiment Analysis, Entity Recognition, Entity Sentiment Analysis, And Other Text Annotations, To Developers. -Idlanguage:v23.08.00161 +Idlanguage:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/libraryagent/index.md b/docs/google-docs/providers/google/libraryagent/index.md index 5e6ba02451..4a88817205 100644 --- a/docs/google-docs/providers/google/libraryagent/index.md +++ b/docs/google-docs/providers/google/libraryagent/index.md @@ -33,7 +33,7 @@ A Simple Google Example Library API. TypeService TitleLibrary Agent API DescriptionA Simple Google Example Library API. -Idlibraryagent:v23.08.00161 +Idlibraryagent:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/lifesciences/index.md b/docs/google-docs/providers/google/lifesciences/index.md index d8dddf9406..af1f7a6531 100644 --- a/docs/google-docs/providers/google/lifesciences/index.md +++ b/docs/google-docs/providers/google/lifesciences/index.md @@ -33,7 +33,7 @@ Cloud Life Sciences Is A Suite Of Services And Tools For Managing, Processing, A TypeService TitleCloud Life Sciences API DescriptionCloud Life Sciences Is A Suite Of Services And Tools For Managing, Processing, And Transforming Life Sciences Data. -Idlifesciences:v23.08.00161 +Idlifesciences:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/lifesciences/operations/index.md b/docs/google-docs/providers/google/lifesciences/operations/index.md index 735064fc8f..538ec86f64 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. | +| `response` | `object` | An Empty object. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/billing_accounts_cmek_settings/index.md b/docs/google-docs/providers/google/logging/billing_accounts_cmek_settings/index.md index 4f101ea52a..dff2723d21 100644 --- a/docs/google-docs/providers/google/logging/billing_accounts_cmek_settings/index.md +++ b/docs/google-docs/providers/google/logging/billing_accounts_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. | -| `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. | | `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. | ## 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 a268fdae06..29755bf31e 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. | -| `analyticsEnabled` | `boolean` | Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. | -| `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. | -| `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. | -| `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) | | `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. | +| `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. | | `indexConfigs` | `array` | A list of indexed fields and related configuration data. | +| `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. | +| `lifecycleState` | `string` | Output only. The bucket lifecycle state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -45,7 +45,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `billing_accounts_locations_buckets_list` | `SELECT` | `billingAccountsId, locationsId` | Lists log buckets. | | `folders_locations_buckets_get` | `SELECT` | `bucketsId, foldersId, locationsId` | Gets a log bucket. | | `folders_locations_buckets_list` | `SELECT` | `foldersId, locationsId` | Lists log buckets. | -| `locations_buckets_get` | `SELECT` | `name` | Gets a log bucket. | | `locations_buckets_list` | `SELECT` | `parent` | Lists log buckets. | | `organizations_locations_buckets_get` | `SELECT` | `bucketsId, locationsId, organizationsId` | Gets a log bucket. | | `organizations_locations_buckets_list` | `SELECT` | `locationsId, organizationsId` | Lists log buckets. | @@ -53,12 +52,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_locations_buckets_list` | `SELECT` | `locationsId, projectsId` | Lists log buckets. | | `billing_accounts_locations_buckets_create` | `INSERT` | `billingAccountsId, locationsId` | Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. | | `folders_locations_buckets_create` | `INSERT` | `foldersId, locationsId` | Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. | -| `locations_buckets_create` | `INSERT` | `parent` | Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. | | `organizations_locations_buckets_create` | `INSERT` | `locationsId, organizationsId` | Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. | | `projects_locations_buckets_create` | `INSERT` | `locationsId, projectsId` | Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. | | `billing_accounts_locations_buckets_delete` | `DELETE` | `billingAccountsId, bucketsId, locationsId` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | | `folders_locations_buckets_delete` | `DELETE` | `bucketsId, foldersId, locationsId` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | -| `locations_buckets_delete` | `DELETE` | `name` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | | `organizations_locations_buckets_delete` | `DELETE` | `bucketsId, locationsId, organizationsId` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | | `projects_locations_buckets_delete` | `DELETE` | `bucketsId, locationsId, projectsId` | Deletes a log bucket.Changes the bucket's lifecycle_state to the DELETE_REQUESTED state. After 7 days, the bucket will be purged and all log entries in the bucket will be permanently deleted. | | `_billing_accounts_locations_buckets_list` | `EXEC` | `billingAccountsId, locationsId` | Lists log buckets. | @@ -70,7 +67,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `billing_accounts_locations_buckets_undelete` | `EXEC` | `billingAccountsId, bucketsId, locationsId` | Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. | | `folders_locations_buckets_patch` | `EXEC` | `bucketsId, foldersId, locationsId` | Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | | `folders_locations_buckets_undelete` | `EXEC` | `bucketsId, foldersId, locationsId` | Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. | -| `locations_buckets_patch` | `EXEC` | `name` | Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | | `locations_buckets_undelete` | `EXEC` | `name` | Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. | | `organizations_locations_buckets_patch` | `EXEC` | `bucketsId, locationsId, organizationsId` | Updates a log bucket.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | | `organizations_locations_buckets_undelete` | `EXEC` | `bucketsId, locationsId, organizationsId` | Undeletes a log bucket. A bucket that has been deleted can be undeleted within the grace period of 7 days. | diff --git a/docs/google-docs/providers/google/logging/buckets_async/index.md b/docs/google-docs/providers/google/logging/buckets_async/index.md index 37255cdd34..66c5358ac9 100644 --- a/docs/google-docs/providers/google/logging/buckets_async/index.md +++ b/docs/google-docs/providers/google/logging/buckets_async/index.md @@ -31,6 +31,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `billing_accounts_locations_buckets_create_async` | `INSERT` | `billingAccountsId, locationsId` | Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. | | `folders_locations_buckets_create_async` | `INSERT` | `foldersId, locationsId` | Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. | +| `locations_buckets_create_async` | `INSERT` | `parent` | Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. | | `organizations_locations_buckets_create_async` | `INSERT` | `locationsId, organizationsId` | Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. | | `projects_locations_buckets_create_async` | `INSERT` | `locationsId, projectsId` | Creates a log bucket asynchronously that can be used to store log entries.After a bucket has been created, the bucket's location cannot be changed. | | `billing_accounts_locations_buckets_update_async` | `EXEC` | `billingAccountsId, bucketsId, locationsId` | Updates a log bucket asynchronously.If the bucket has a lifecycle_state of DELETE_REQUESTED, then FAILED_PRECONDITION will be returned.After a bucket has been created, the bucket's location cannot be changed. | diff --git a/docs/google-docs/providers/google/logging/exclusions/index.md b/docs/google-docs/providers/google/logging/exclusions/index.md index 1c5441ec02..a1296cc33c 100644 --- a/docs/google-docs/providers/google/logging/exclusions/index.md +++ b/docs/google-docs/providers/google/logging/exclusions/index.md @@ -38,6 +38,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `billing_accounts_exclusions_get` | `SELECT` | `billingAccountsId, exclusionsId` | Gets the description of an exclusion in the _Default sink. | | `billing_accounts_exclusions_list` | `SELECT` | `billingAccountsId` | Lists all the exclusions on the _Default sink in a parent resource. | +| `exclusions_get` | `SELECT` | `name` | Gets the description of an exclusion in the _Default sink. | | `exclusions_list` | `SELECT` | `parent` | Lists all the exclusions on the _Default sink in a parent resource. | | `folders_exclusions_get` | `SELECT` | `exclusionsId, foldersId` | Gets the description of an exclusion in the _Default sink. | | `folders_exclusions_list` | `SELECT` | `foldersId` | Lists all the exclusions on the _Default sink in a parent resource. | @@ -51,6 +52,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `organizations_exclusions_create` | `INSERT` | `organizationsId` | Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. | | `projects_exclusions_create` | `INSERT` | `projectsId` | Creates a new exclusion in the _Default sink in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource. | | `billing_accounts_exclusions_delete` | `DELETE` | `billingAccountsId, exclusionsId` | Deletes an exclusion in the _Default sink. | +| `exclusions_delete` | `DELETE` | `name` | Deletes an exclusion in the _Default sink. | | `folders_exclusions_delete` | `DELETE` | `exclusionsId, foldersId` | Deletes an exclusion in the _Default sink. | | `organizations_exclusions_delete` | `DELETE` | `exclusionsId, organizationsId` | Deletes an exclusion in the _Default sink. | | `projects_exclusions_delete` | `DELETE` | `exclusionsId, projectsId` | Deletes an exclusion in the _Default sink. | @@ -60,6 +62,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_organizations_exclusions_list` | `EXEC` | `organizationsId` | Lists all the exclusions on the _Default sink in a parent resource. | | `_projects_exclusions_list` | `EXEC` | `projectsId` | Lists all the exclusions on the _Default sink in a parent resource. | | `billing_accounts_exclusions_patch` | `EXEC` | `billingAccountsId, exclusionsId` | Changes one or more properties of an existing exclusion in the _Default sink. | +| `exclusions_patch` | `EXEC` | `name` | Changes one or more properties of an existing exclusion in the _Default sink. | | `folders_exclusions_patch` | `EXEC` | `exclusionsId, foldersId` | Changes one or more properties of an existing exclusion in the _Default sink. | | `organizations_exclusions_patch` | `EXEC` | `exclusionsId, organizationsId` | Changes one or more properties of an existing exclusion in the _Default sink. | | `projects_exclusions_patch` | `EXEC` | `exclusionsId, projectsId` | Changes one or more properties of an existing exclusion in the _Default sink. | diff --git a/docs/google-docs/providers/google/logging/index.md b/docs/google-docs/providers/google/logging/index.md index cdfc51058b..8820530707 100644 --- a/docs/google-docs/providers/google/logging/index.md +++ b/docs/google-docs/providers/google/logging/index.md @@ -33,7 +33,7 @@ Writes Log Entries And Manages Your Cloud Logging Configuration. TypeService TitleCloud Logging API DescriptionWrites Log Entries And Manages Your Cloud Logging Configuration. -Idlogging:v23.08.00161 +Idlogging:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/logging/links/index.md b/docs/google-docs/providers/google/logging/links/index.md index 06b3a88833..7d46c3f6f8 100644 --- a/docs/google-docs/providers/google/logging/links/index.md +++ b/docs/google-docs/providers/google/logging/links/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link | | `description` | `string` | Describes this link.The maximum length of the description is 8000 characters. | +| `lifecycleState` | `string` | Output only. The resource lifecycle state. | | `bigqueryDataset` | `object` | Describes a BigQuery dataset that was created by a link. | | `createTime` | `string` | Output only. The creation timestamp of the link. | -| `lifecycleState` | `string` | Output only. The resource lifecycle state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/logging/locations/index.md b/docs/google-docs/providers/google/logging/locations/index.md index 671ff27a65..436174650c 100644 --- a/docs/google-docs/providers/google/logging/locations/index.md +++ b/docs/google-docs/providers/google/logging/locations/index.md @@ -28,24 +28,24 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `billing_accounts_locations_get` | `SELECT` | `billingAccountsId, locationsId` | Gets information about a location. | | `billing_accounts_locations_list` | `SELECT` | `billingAccountsId` | Lists information about the supported locations for this service. | +| `folders_locations_get` | `SELECT` | `foldersId, locationsId` | Gets information about a location. | | `folders_locations_list` | `SELECT` | `foldersId` | Lists information about the supported locations for this service. | | `locations_list` | `SELECT` | `name` | Lists information about the supported locations for this service. | +| `organizations_locations_get` | `SELECT` | `locationsId, organizationsId` | Gets information about a location. | | `organizations_locations_list` | `SELECT` | `organizationsId` | Lists information about the supported locations for this service. | +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_billing_accounts_locations_list` | `EXEC` | `billingAccountsId` | Lists information about the supported locations for this service. | | `_folders_locations_list` | `EXEC` | `foldersId` | Lists information about the supported locations for this service. | | `_locations_list` | `EXEC` | `name` | Lists information about the supported locations for this service. | | `_organizations_locations_list` | `EXEC` | `organizationsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `billing_accounts_locations_get` | `EXEC` | `billingAccountsId, locationsId` | Gets information about a location. | -| `folders_locations_get` | `EXEC` | `foldersId, locationsId` | Gets information about a location. | -| `organizations_locations_get` | `EXEC` | `locationsId, organizationsId` | Gets information about a location. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | 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 4f6142d2f1..21ac04b121 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 87ff3c57ce..8f40860ccf 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. | -| `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/metrics/index.md b/docs/google-docs/providers/google/logging/metrics/index.md index 9c8e14cfba..b0d9840a6b 100644 --- a/docs/google-docs/providers/google/logging/metrics/index.md +++ b/docs/google-docs/providers/google/logging/metrics/index.md @@ -29,22 +29,22 @@ 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. | -| `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+).*") | -| `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. | -| `disabled` | `boolean` | Optional. If set to True, then this metric is disabled and it does not generate any points. | +| `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. | | `updateTime` | `string` | Output only. The last update timestamp of the metric.This field may not be present for older metrics. | | `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. | -| `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. | +| `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. | | `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. | | `version` | `string` | Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. | -| `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. | | `createTime` | `string` | Output only. The creation timestamp of the metric.This field may not be present for older metrics. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_metrics_get` | `SELECT` | `metricsId, projectsId` | Gets a logs-based metric. | | `projects_metrics_list` | `SELECT` | `projectsId` | Lists logs-based metrics. | | `projects_metrics_create` | `INSERT` | `projectsId` | Creates a logs-based metric. | | `projects_metrics_delete` | `DELETE` | `metricsId, projectsId` | Deletes a logs-based metric. | | `_projects_metrics_list` | `EXEC` | `projectsId` | Lists logs-based metrics. | -| `projects_metrics_get` | `EXEC` | `metricsId, projectsId` | Gets a logs-based metric. | | `projects_metrics_update` | `EXEC` | `metricsId, projectsId` | Creates or updates a logs-based metric. | 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/operations/index.md b/docs/google-docs/providers/google/logging/operations/index.md index 3b0fe84fc7..8a8c067c39 100644 --- a/docs/google-docs/providers/google/logging/operations/index.md +++ b/docs/google-docs/providers/google/logging/operations/index.md @@ -35,10 +35,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `billing_accounts_locations_operations_get` | `SELECT` | `billingAccountsId, locationsId, 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. | | `billing_accounts_locations_operations_list` | `SELECT` | `billingAccountsId, locationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `folders_locations_operations_get` | `SELECT` | `foldersId, locationsId, 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. | | `folders_locations_operations_list` | `SELECT` | `foldersId, locationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `locations_operations_list` | `SELECT` | `name` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `organizations_locations_operations_get` | `SELECT` | `locationsId, operationsId, organizationsId` | 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. | | `organizations_locations_operations_list` | `SELECT` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `_billing_accounts_locations_operations_list` | `EXEC` | `billingAccountsId, locationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `_folders_locations_operations_list` | `EXEC` | `foldersId, locationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | @@ -46,10 +50,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_organizations_locations_operations_list` | `EXEC` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. | | `billing_accounts_locations_operations_cancel` | `EXEC` | `billingAccountsId, locationsId, 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. | -| `billing_accounts_locations_operations_get` | `EXEC` | `billingAccountsId, locationsId, 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. | | `folders_locations_operations_cancel` | `EXEC` | `foldersId, locationsId, 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. | -| `folders_locations_operations_get` | `EXEC` | `foldersId, locationsId, 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. | | `organizations_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | -| `organizations_locations_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/logging/sinks/index.md b/docs/google-docs/providers/google/logging/sinks/index.md index 0dbfa47431..cdd56d5585 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. | -| `bigqueryOptions` | `object` | Options that change functionality of a sink exporting data to BigQuery. | -| `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 | -| `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. | -| `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 | -| `disabled` | `boolean` | Optional. If set to true, then this sink is disabled and it does not export any log entries. | -| `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. | | `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. | | `outputVersionFormat` | `string` | Deprecated. This field is unused. | | `createTime` | `string` | Output only. The creation timestamp of the sink.This field may not be present for older sinks. | +| `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. | +| `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. | +| `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 | +| `bigqueryOptions` | `object` | Options that change functionality of a sink exporting data to BigQuery. | ## 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 53a272d629..e4440e21b7 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. | -| `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. | | `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") | ## 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..c7d2800181 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}` | -| `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. | +| `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. | ## 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 07cadbd382..4089a1d89c 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}`. | -| `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. | +| `updateTime` | `string` | Output only. The last update time. | +| `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]. | | `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. | +| `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. | +| `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. | +| `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. | | `trusts` | `array` | Output only. The current trusts associated with the domain. | -| `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]. | | `statusMessage` | `string` | Output only. Additional information about the current status of this domain, if available. | -| `createTime` | `string` | Output only. The time the instance was created. | -| `updateTime` | `string` | Output only. The last update time. | -| `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. | -| `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. | +| `state` | `string` | Output only. The current state of this domain. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 b0d6e6105d..e759d2643a 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/index.md b/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/index.md index 9b6e779fff..f89bc5d1f5 100644 --- a/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/index.md +++ b/docs/google-docs/providers/google/managedidentities/domains_ldapssettings/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 LDAPS settings. Uses the form: `projects/{project}/locations/{location}/domains/{domain}`. | -| `certificate` | `object` | Certificate used to configure LDAPS. | -| `certificatePassword` | `string` | Input only. The password used to encrypt the uploaded PFX certificate. | | `certificatePfx` | `string` | Input only. The uploaded PKCS12-formatted certificate to configure LDAPS with. It will enable the domain controllers in this domain to accept LDAPS connections (either LDAP over SSL/TLS or the StartTLS operation). A valid certificate chain must form a valid x.509 certificate chain (or be comprised of a single self-signed certificate. It must be encrypted with either: 1) PBES2 + PBKDF2 + AES256 encryption and SHA256 PRF; or 2) pbeWithSHA1And3-KeyTripleDES-CBC Private key must be included for the leaf / single self-signed certificate. Note: For a fqdn your-example-domain.com, the wildcard fqdn is *.your-example-domain.com. Specifically the leaf certificate must have: - Either a blank subject or a subject with CN matching the wildcard fqdn. - Exactly two SANs - the fqdn and wildcard fqdn. - Encipherment and digital key signature key usages. - Server authentication extended key usage (OID=1.3.6.1.5.5.7.3.1) - Private key must be in one of the following formats: RSA, ECDSA, ED25519. - Private key must have appropriate key length: 2048 for RSA, 256 for ECDSA - Signature algorithm of the leaf certificate cannot be MD2, MD5 or SHA1. | | `state` | `string` | Output only. The current state of this LDAPS settings. | | `updateTime` | `string` | Output only. Last update time. | +| `certificate` | `object` | Certificate used to configure LDAPS. | +| `certificatePassword` | `string` | Input only. The password used to encrypt the uploaded PFX certificate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/index.md b/docs/google-docs/providers/google/managedidentities/index.md index 84da527b07..bcd70288f7 100644 --- a/docs/google-docs/providers/google/managedidentities/index.md +++ b/docs/google-docs/providers/google/managedidentities/index.md @@ -33,7 +33,7 @@ The Managed Service For Microsoft Active Directory API Is Used For Managing A Hi TypeService TitleManaged Service For Microsoft Active Directory API DescriptionThe Managed Service For Microsoft Active Directory API Is Used For Managing A Highly Available, Hardened Service Running Microsoft Active Directory (AD). -Idmanagedidentities:v23.08.00161 +Idmanagedidentities:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/managedidentities/locations/index.md b/docs/google-docs/providers/google/managedidentities/locations/index.md index 60dfeff922..6e6873e9e0 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". | ## 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 47b1584d42..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}`. | +| `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}` | -| `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/managedidentities/peerings_iam_policies/index.md b/docs/google-docs/providers/google/managedidentities/peerings_iam_policies/index.md index 69dfae3610..7dcde1c55b 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md b/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md index 790fe1b514..ad62c3a311 100644 --- a/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md +++ b/docs/google-docs/providers/google/managedidentities/sql_integrations/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The unique name of the SQL integration in the form of `projects/{project_id}/locations/global/domains/{domain_name}/sqlIntegrations/{sql_integration}` | -| `state` | `string` | Output only. The current state of the SQL integration. | -| `updateTime` | `string` | Output only. The time the SQL integration was updated. | | `createTime` | `string` | Output only. The time the SQL integration was created. | | `sqlInstance` | `string` | The full resource name of an integrated SQL instance | +| `state` | `string` | Output only. The current state of the SQL integration. | +| `updateTime` | `string` | Output only. The time the SQL integration was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/memcache/index.md b/docs/google-docs/providers/google/memcache/index.md index f689d1f4da..d883bdde35 100644 --- a/docs/google-docs/providers/google/memcache/index.md +++ b/docs/google-docs/providers/google/memcache/index.md @@ -33,7 +33,7 @@ Google Cloud Memorystore For Memcached API Is Used For Creating And Managing Mem TypeService TitleCloud Memorystore For Memcached API DescriptionGoogle Cloud Memorystore For Memcached API Is Used For Creating And Managing Memcached Instances In GCP. -Idmemcache:v23.08.00161 +Idmemcache:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/memcache/instances/index.md b/docs/google-docs/providers/google/memcache/instances/index.md index 50b403640f..56324d9b7e 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. | -| `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. | -| `parameters` | `object` | | -| `nodeConfig` | `object` | Configuration for a Memcached Node. | -| `state` | `string` | Output only. The state of this Memcached instance. | -| `updateTime` | `string` | Output only. The time the instance was updated. | -| `memcacheNodes` | `array` | Output only. List of Memcached nodes. Refer to Node message for more details. | -| `instanceMessages` | `array` | List of messages that describe the current state of the Memcached 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". | -| `discoveryEndpoint` | `string` | Output only. Endpoint for the Discovery API. | +| `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. | | `nodeCount` | `integer` | Required. Number of nodes in the Memcached instance. | -| `displayName` | `string` | User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters. | -| `createTime` | `string` | Output only. The time the instance was created. | +| `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. | | `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. | | `maintenancePolicy` | `object` | Maintenance policy per instance. | -| `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. | -| `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. | +| `state` | `string` | Output only. The state of this Memcached instance. | +| `createTime` | `string` | Output only. The time the instance was created. | +| `memcacheNodes` | `array` | Output only. List of Memcached nodes. Refer to Node message for more details. | +| `parameters` | `object` | | | `maintenanceSchedule` | `object` | Upcoming maintenance schedule. | -| `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 | +| `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. | +| `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. | +| `discoveryEndpoint` | `string` | Output only. Endpoint for the Discovery API. | +| `updateTime` | `string` | Output only. The time the instance was updated. | +| `displayName` | `string` | User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters. | ## 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 8b0d77bb88..d77bf1bbb2 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 48a6501375..e074f87566 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}`. | -| `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/metastore/backups/index.md b/docs/google-docs/providers/google/metastore/backups/index.md index e2277ebddf..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. | -| `endTime` | `string` | Output only. The time when the backup finished creating. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md b/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md index 27167906a3..8dc2d15e95 100644 --- a/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md +++ b/docs/google-docs/providers/google/metastore/backups_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/federations/index.md b/docs/google-docs/providers/google/metastore/federations/index.md index 7c9a28369b..dfdcb0654c 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}`. | -| `labels` | `object` | User-defined labels for the metastore federation. | -| `createTime` | `string` | Output only. The time when the metastore federation was created. | -| `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. | -| `updateTime` | `string` | Output only. The time when the metastore federation was last updated. | -| `endpointUri` | `string` | Output only. The federation endpoint. | -| `uid` | `string` | Output only. The globally unique resource identifier of the metastore federation. | -| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore federation, if available. | | `state` | `string` | Output only. The current state of the federation. | | `version` | `string` | Immutable. The Apache Hive metastore version of the federation. All backend metastore versions must be compatible with the federation version. | +| `uid` | `string` | Output only. The globally unique resource identifier of the metastore federation. | +| `updateTime` | `string` | Output only. The time when the metastore federation was last updated. | +| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore federation, if available. | +| `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. | +| `endpointUri` | `string` | Output only. The federation endpoint. | +| `createTime` | `string` | Output only. The time when the metastore federation was created. | +| `labels` | `object` | User-defined labels for the metastore federation. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/metastore/index.md b/docs/google-docs/providers/google/metastore/index.md index 598566a7eb..5effdb41ce 100644 --- a/docs/google-docs/providers/google/metastore/index.md +++ b/docs/google-docs/providers/google/metastore/index.md @@ -33,7 +33,7 @@ The Dataproc Metastore API Is Used To Manage The Lifecycle And Configuration Of TypeService TitleDataproc Metastore API DescriptionThe Dataproc Metastore API Is Used To Manage The Lifecycle And Configuration Of Metastore Services. -Idmetastore:v23.08.00161 +Idmetastore:v23.08.00163 ## Resources 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 0558e54db3..3edda6d023 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. | -| `state` | `string` | Output only. The current state of the metadata import. | ## 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 e8f7eb1648..6cf16cb6c0 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}. | +| `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 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/metastore/services/index.md b/docs/google-docs/providers/google/metastore/services/index.md index 798f61c718..0eac8050fd 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}. | -| `scalingConfig` | `object` | Represents the scaling configuration of a metastore service. | -| `endpointUri` | `string` | Output only. The URI of the endpoint used to access the metastore service. | +| `labels` | `object` | User-defined labels for the metastore service. | +| `networkConfig` | `object` | Network configuration for the Dataproc Metastore service.Next available ID: 4 | +| `tier` | `string` | The tier of the service. | +| `maintenanceWindow` | `object` | Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. | +| `metadataManagementActivity` | `object` | The metadata management activities of the metastore service. | +| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore service, if available. | | `databaseType` | `string` | Immutable. The database type that the Metastore service stores its data. | +| `updateTime` | `string` | Output only. The time when the metastore service was last updated. | +| `createTime` | `string` | Output only. The time when the metastore service was created. | | `state` | `string` | Output only. The current state of the metastore service. | -| `releaseChannel` | `string` | Immutable. The release channel of the service. If unspecified, defaults to STABLE. | | `port` | `integer` | The TCP port at which the metastore service is reached. Default: 9083. | -| `createTime` | `string` | Output only. The time when the metastore service was created. | -| `stateMessage` | `string` | Output only. Additional information about the current state of the metastore service, if available. | -| `tier` | `string` | The tier of the 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. | -| `metadataManagementActivity` | `object` | The metadata management activities of the metastore service. | +| `releaseChannel` | `string` | Immutable. The release channel of the service. If unspecified, defaults to STABLE. | +| `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}. | +| `telemetryConfig` | `object` | Telemetry Configuration for the Dataproc Metastore service. | | `artifactGcsUri` | `string` | Output only. A Cloud Storage URI (starting with gs://) that specifies where artifacts related to the metastore service are stored. | -| `labels` | `object` | User-defined labels for the metastore service. | | `encryptionConfig` | `object` | Encryption settings for the service. | -| `telemetryConfig` | `object` | Telemetry Configuration for the Dataproc Metastore service. | +| `scalingConfig` | `object` | Represents the scaling configuration of a metastore service. | +| `endpointUri` | `string` | Output only. The URI of the endpoint used to access the metastore service. | +| `hiveMetastoreConfig` | `object` | Specifies configuration information specific to running Hive metastore software as the metastore service. | | `uid` | `string` | Output only. The globally unique resource identifier of the metastore service. | -| `updateTime` | `string` | Output only. The time when the metastore service was last updated. | -| `maintenanceWindow` | `object` | Maintenance window. This specifies when Dataproc Metastore may perform system maintenance operation to the service. | -| `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}. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 a8d7631131..83b4f8a7bc 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or 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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/assets/index.md b/docs/google-docs/providers/google/migrationcenter/assets/index.md index e2ff15f545..22778e5695 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. | -| `performanceData` | `object` | Performance data for an asset. | | `sources` | `array` | Output only. The list of sources contributing to the asset. | +| `performanceData` | `object` | Performance data for an asset. | +| `assignedGroups` | `array` | Output only. The list of groups that the asset is assigned to. | | `insightList` | `object` | Message containing insights list. | -| `attributes` | `object` | Generic asset attributes. | -| `machineDetails` | `object` | Details of a machine. | -| `labels` | `object` | Labels as key value pairs. | | `updateTime` | `string` | Output only. The timestamp when the asset was last updated. | -| `assignedGroups` | `array` | Output only. The list of groups that the asset is assigned to. | +| `labels` | `object` | Labels as key value pairs. | +| `machineDetails` | `object` | Details of a machine. | +| `attributes` | `object` | Generic asset attributes. | | `createTime` | `string` | Output only. The timestamp when the asset was created. | ## 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..5a76ffb548 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. | +| `violations` | `array` | Output only. All the violations that were detected for the frame. | | `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. | ## 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 5fade3396b..190c8ed478 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. | -| `labels` | `object` | Labels as key value pairs. | -| `completeTime` | `string` | Output only. The timestamp when the import job was completed. | -| `createTime` | `string` | Output only. The timestamp when the import job was created. | | `updateTime` | `string` | Output only. The timestamp when the import job was last updated. | -| `assetSource` | `string` | Required. Reference to a source. | +| `completeTime` | `string` | Output only. The timestamp when the import job was completed. | | `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `executionReport` | `object` | A resource that reports result of the import job execution. | | `validationReport` | `object` | A resource that aggregates errors across import job files. | | `state` | `string` | Output only. The state of the import job. | -| `executionReport` | `object` | A resource that reports result of the import job execution. | +| `assetSource` | `string` | Required. Reference to a source. | +| `createTime` | `string` | Output only. The timestamp when the import job was created. | +| `labels` | `object` | Labels as key value pairs. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/index.md b/docs/google-docs/providers/google/migrationcenter/index.md index 998f01862b..17e83fc0ba 100644 --- a/docs/google-docs/providers/google/migrationcenter/index.md +++ b/docs/google-docs/providers/google/migrationcenter/index.md @@ -33,7 +33,7 @@ A Unified Platform That Helps You Accelerate Your End-To-End Cloud Journey From TypeService TitleMigration Center API DescriptionA Unified Platform That Helps You Accelerate Your End-To-End Cloud Journey From Your Current On-Premises Or Cloud Environments To Google Cloud. -Idmigrationcenter:v23.08.00161 +Idmigrationcenter:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/migrationcenter/locations/index.md b/docs/google-docs/providers/google/migrationcenter/locations/index.md index 6a0dad373a..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"` | -| `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/migrationcenter/operations/index.md b/docs/google-docs/providers/google/migrationcenter/operations/index.md index d8679a61d6..0c4c3a5519 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, 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/migrationcenter/preference_sets/index.md b/docs/google-docs/providers/google/migrationcenter/preference_sets/index.md index f9c1adfac3..928311279c 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. | -| `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. | +| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | +| `updateTime` | `string` | Output only. The timestamp when the preference set was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/migrationcenter/report_configs/index.md b/docs/google-docs/providers/google/migrationcenter/report_configs/index.md index af6f9d47d5..b3a3e84bee 100644 --- a/docs/google-docs/providers/google/migrationcenter/report_configs/index.md +++ b/docs/google-docs/providers/google/migrationcenter/report_configs/index.md @@ -29,10 +29,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. Name of resource. | | `description` | `string` | Free-text description. | -| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | | `groupPreferencesetAssignments` | `array` | Required. Collection of combinations of groups and preference sets. | | `updateTime` | `string` | Output only. The timestamp when the resource was last updated. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `displayName` | `string` | User-friendly display name. Maximum length is 63 characters. | ## 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 b6b7e54a7b..a1ed990951 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. | -| `createTime` | `string` | Output only. The timestamp when the source was created. | +| `state` | `string` | Output only. The state of the source. | | `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. | | `updateTime` | `string` | Output only. The timestamp when the source was last updated. | | `errorFrameCount` | `integer` | Output only. The number of frames that were reported by the source and contained errors. | -| `state` | `string` | Output only. The state of the source. | -| `type` | `string` | Data source type. | | `displayName` | `string` | User-friendly display name. | +| `pendingFrameCount` | `integer` | Output only. Number of frames that are still being processed. | +| `createTime` | `string` | Output only. The timestamp when the source was created. | +| `priority` | `integer` | The information confidence of the source. The higher the value, the higher the confidence. | +| `type` | `string` | Data source type. | ## 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 6c3914a330..77c947adb5 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 | |:-----|:---------|:------------| +| `serviceAccountProject` | `string` | The project number for `service_account`. | | `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/ml/index.md b/docs/google-docs/providers/google/ml/index.md index 9944e1befa..e0efa52c0f 100644 --- a/docs/google-docs/providers/google/ml/index.md +++ b/docs/google-docs/providers/google/ml/index.md @@ -33,7 +33,7 @@ An API To Enable Creating And Using Machine Learning Models. TypeService TitleAI Platform Training & Prediction API DescriptionAn API To Enable Creating And Using Machine Learning Models. -Idml:v23.08.00161 +Idml:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/ml/jobs/index.md b/docs/google-docs/providers/google/ml/jobs/index.md index e6e5c2236f..b6282f19b8 100644 --- a/docs/google-docs/providers/google/ml/jobs/index.md +++ b/docs/google-docs/providers/google/ml/jobs/index.md @@ -27,25 +27,25 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `createTime` | `string` | Output only. When the job was created. | -| `endTime` | `string` | Output only. When the job processing was completed. | +| `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. | -| `state` | `string` | Output only. The detailed state of a job. | -| `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | -| `predictionOutput` | `object` | Represents results of a prediction job. | -| `startTime` | `string` | Output only. When the job processing was started. | -| `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. | | `jobId` | `string` | Required. The user-specified id of the 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. | +| `state` | `string` | Output only. The detailed state of a job. | +| `startTime` | `string` | Output only. When the job processing was started. | | `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. | +| `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | +| `createTime` | `string` | Output only. When the job was created. | +| `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). | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_jobs_get` | `SELECT` | `jobsId, projectsId` | Describes a job. | | `projects_jobs_list` | `SELECT` | `projectsId` | Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}. | | `projects_jobs_create` | `INSERT` | `projectsId` | Creates a training or a batch prediction job. | | `_projects_jobs_list` | `EXEC` | `projectsId` | Lists the jobs in the project. If there are no jobs that match the request parameters, the list request returns an empty response body: {}. | | `projects_jobs_cancel` | `EXEC` | `jobsId, projectsId` | Cancels a running job. | -| `projects_jobs_get` | `EXEC` | `jobsId, projectsId` | Describes a job. | | `projects_jobs_patch` | `EXEC` | `jobsId, projectsId` | Updates a specific job resource. Currently the only supported fields to update are `labels`. | diff --git a/docs/google-docs/providers/google/ml/models/index.md b/docs/google-docs/providers/google/ml/models/index.md index 552c21e11f..effe56c040 100644 --- a/docs/google-docs/providers/google/ml/models/index.md +++ b/docs/google-docs/providers/google/ml/models/index.md @@ -29,18 +29,18 @@ 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. | -| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_models_get` | `SELECT` | `modelsId, projectsId` | Gets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed). | | `projects_models_list` | `SELECT` | `projectsId` | Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}. | | `projects_models_create` | `INSERT` | `projectsId` | Creates a model which will later contain one or more versions. You must add at least one version before you can request predictions from the model. Add versions by calling projects.models.versions.create. | | `projects_models_delete` | `DELETE` | `modelsId, projectsId` | Deletes a model. You can only delete a model if there are no versions in it. You can delete versions by calling projects.models.versions.delete. | | `_projects_models_list` | `EXEC` | `projectsId` | Lists the models in a project. Each project can contain multiple models, and each model can have multiple versions. If there are no models that match the request parameters, the list request returns an empty response body: {}. | -| `projects_models_get` | `EXEC` | `modelsId, projectsId` | Gets information about a model, including its name, the description (if set), and the default version (if at least one version of the model has been deployed). | | `projects_models_patch` | `EXEC` | `modelsId, projectsId` | Updates a specific model resource. Currently the only supported fields to update are `description` and `default_version.name`. | 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 215e135c89..5e4e3ba88b 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ml/operations/index.md b/docs/google-docs/providers/google/ml/operations/index.md index f0745c7aa7..5f57a9f108 100644 --- a/docs/google-docs/providers/google/ml/operations/index.md +++ b/docs/google-docs/providers/google/ml/operations/index.md @@ -28,16 +28,16 @@ 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`. | +| `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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | +| `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. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | | `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. 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`. | -| `projects_operations_get` | `EXEC` | `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. | diff --git a/docs/google-docs/providers/google/ml/versions/index.md b/docs/google-docs/providers/google/ml/versions/index.md index 9f98ba1756..968eeddc0a 100644 --- a/docs/google-docs/providers/google/ml/versions/index.md +++ b/docs/google-docs/providers/google/ml/versions/index.md @@ -29,37 +29,37 @@ 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. | -| `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). | +| `createTime` | `string` | Output only. The time the version was created. | +| `manualScaling` | `object` | Options for manually scaling a model. | | `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). | -| `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). | -| `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. | | `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). | -| `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. | | `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). | -| `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. | +| `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. | +| `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. | +| `errorMessage` | `string` | Output only. The details of a failure or a cancellation. | +| `state` | `string` | Output only. The state of a version. | +| `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). | -| `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`. | +| `lastUseTime` | `string` | Output only. The time the version was last used for prediction. | +| `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). | +| `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). | +| `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). | +| `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. | +| `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). | | `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) | | `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. | | `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. | -| `autoScaling` | `object` | Options for automatically scaling a model. | -| `manualScaling` | `object` | Options for manually scaling a model. | -| `createTime` | `string` | Output only. The time the version was created. | -| `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. | -| `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). | -| `lastUseTime` | `string` | Output only. The time the version was last used for prediction. | -| `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). | -| `state` | `string` | Output only. The state of a version. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_models_versions_get` | `SELECT` | `modelsId, projectsId, versionsId` | Gets information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model. | | `projects_models_versions_list` | `SELECT` | `modelsId, projectsId` | Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}. | | `projects_models_versions_create` | `INSERT` | `modelsId, projectsId` | Creates a new version of a model from a trained TensorFlow model. If the version created in the cloud by this call is the first deployed version of the specified model, it will be made the default version of the model. When you add a version to a model that already has one or more versions, the default version does not automatically change. If you want a new version to be the default, you must call projects.models.versions.setDefault. | | `projects_models_versions_delete` | `DELETE` | `modelsId, projectsId, versionsId` | Deletes a model version. Each model can have multiple versions deployed and in use at any given time. Use this method to remove a single version. Note: You cannot delete the version that is set as the default version of the model unless it is the only remaining version. | | `_projects_models_versions_list` | `EXEC` | `modelsId, projectsId` | Gets basic information about all the versions of a model. If you expect that a model has many versions, or if you need to handle only a limited number of results at a time, you can request that the list be retrieved in batches (called pages). If there are no versions that match the request parameters, the list request returns an empty response body: {}. | -| `projects_models_versions_get` | `EXEC` | `modelsId, projectsId, versionsId` | Gets information about a model version. Models can have multiple versions. You can call projects.models.versions.list to get the same information that this method returns for all of the versions of a model. | | `projects_models_versions_patch` | `EXEC` | `modelsId, projectsId, versionsId` | Updates the specified Version resource. Currently the only update-able fields are `description`, `requestLoggingConfig`, `autoScaling.minNodes`, and `manualScaling.nodes`. | | `projects_models_versions_set_default` | `EXEC` | `modelsId, projectsId, versionsId` | Designates a version to be the default for the model. The default version is used for prediction requests made against the model that don't specify a version. The first version to be created for a model is automatically set as the default. You must make any subsequent changes to the default version setting manually using this method. | 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 7032df3339..4456894bef 100644 --- a/docs/google-docs/providers/google/monitoring/alert_policies/index.md +++ b/docs/google-docs/providers/google/monitoring/alert_policies/index.md @@ -28,23 +28,23 @@ 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. | -| `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. | | `mutationRecord` | `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. | -| `alertStrategy` | `object` | Control over how the notification channels in notification_channels are notified when this alert fires. | -| `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. | -| `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. | | `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 {alert name} is a valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels), whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values. | -| `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. | -| `documentation` | `object` | A content string and a MIME type that describes the content string's format. | | `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). | +| `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. | +| `alertStrategy` | `object` | Control over how the notification channels in notification_channels are notified when this alert fires. | +| `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. | +| `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] | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_alert_policies_get` | `SELECT` | `alertPoliciesId, projectsId` | Gets a single alerting policy. | | `projects_alert_policies_list` | `SELECT` | `projectsId` | Lists the existing alerting policies for the workspace. | | `projects_alert_policies_create` | `INSERT` | `projectsId` | Creates a new alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. | | `projects_alert_policies_delete` | `DELETE` | `alertPoliciesId, projectsId` | Deletes an alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. | | `_projects_alert_policies_list` | `EXEC` | `projectsId` | Lists the existing alerting policies for the workspace. | -| `projects_alert_policies_get` | `EXEC` | `alertPoliciesId, projectsId` | Gets a single alerting policy. | | `projects_alert_policies_patch` | `EXEC` | `alertPoliciesId, projectsId` | Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. | diff --git a/docs/google-docs/providers/google/monitoring/index.md b/docs/google-docs/providers/google/monitoring/index.md index 4fbf12948d..fad5ebb4c7 100644 --- a/docs/google-docs/providers/google/monitoring/index.md +++ b/docs/google-docs/providers/google/monitoring/index.md @@ -33,7 +33,7 @@ Manages Your Cloud Monitoring Data And Configurations. TypeService TitleCloud Monitoring API DescriptionManages Your Cloud Monitoring Data And Configurations. -Idmonitoring:v23.08.00161 +Idmonitoring:v23.08.00163 ## Resources 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 617b918395..693f2eb0b2 100644 --- a/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md +++ b/docs/google-docs/providers/google/monitoring/metric_descriptors/index.md @@ -29,15 +29,15 @@ 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. | -| `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" | -| `launchStage` | `string` | Optional. The launch stage of the metric definition. | -| `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. | -| `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. | -| `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. | | `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"). | +| `launchStage` | `string` | Optional. The launch stage of the metric definition. | | `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. | +| `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. | +| `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" | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/monitoring/monitored_resource_descriptors/index.md b/docs/google-docs/providers/google/monitoring/monitored_resource_descriptors/index.md index 4cb4ee0e3a..de2ffe7edc 100644 --- a/docs/google-docs/providers/google/monitoring/monitored_resource_descriptors/index.md +++ b/docs/google-docs/providers/google/monitoring/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 | 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 1fd6529b35..18c957c142 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. | +| `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. | | `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. | ## 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 264952b07d..00669d9cac 100644 --- a/docs/google-docs/providers/google/monitoring/notification_channels/index.md +++ b/docs/google-docs/providers/google/monitoring/notification_channels/index.md @@ -29,22 +29,22 @@ 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. | -| `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. | -| `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. | -| `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. | -| `mutationRecords` | `array` | Records of the modification of this channel. | | `creationRecord` | `object` | Describes a change made to a configuration. | -| `type` | `string` | The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. | | `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. | | `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. | +| `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. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_notification_channels_get` | `SELECT` | `notificationChannelsId, projectsId` | Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method. | | `projects_notification_channels_list` | `SELECT` | `projectsId` | Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method. | | `projects_notification_channels_create` | `INSERT` | `projectsId` | Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. | | `projects_notification_channels_delete` | `DELETE` | `notificationChannelsId, projectsId` | Deletes a notification channel.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. | | `_projects_notification_channels_list` | `EXEC` | `projectsId` | Lists the notification channels that have been created for the project. To list the types of notification channels that are supported, use the ListNotificationChannelDescriptors method. | -| `projects_notification_channels_get` | `EXEC` | `notificationChannelsId, projectsId` | Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method. | | `projects_notification_channels_patch` | `EXEC` | `notificationChannelsId, projectsId` | Updates a notification channel. Fields not specified in the field mask remain unchanged.Design your application to single-thread API calls that modify the state of notification channels in a single project. This includes calls to CreateNotificationChannel, DeleteNotificationChannel and UpdateNotificationChannel. | | `projects_notification_channels_send_verification_code` | `EXEC` | `notificationChannelsId, projectsId` | Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel. | | `projects_notification_channels_verify` | `EXEC` | `notificationChannelsId, projectsId` | Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode. | 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 ac0f042f93..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 @@ -39,7 +39,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:--------------|:----------------|:------------| | `services_service_level_objectives_list` | `SELECT` | `parent` | List the ServiceLevelObjectives for the given Service. | | `services_service_level_objectives_create` | `INSERT` | `parent` | Create a ServiceLevelObjective for the given Service. | -| `services_service_level_objectives_delete` | `DELETE` | `name` | Delete the given ServiceLevelObjective. | | `_services_service_level_objectives_list` | `EXEC` | `parent` | List the ServiceLevelObjectives for the given Service. | -| `services_service_level_objectives_get` | `EXEC` | `name` | Get a ServiceLevelObjective by name. | -| `services_service_level_objectives_patch` | `EXEC` | `name` | Update the given ServiceLevelObjective. | diff --git a/docs/google-docs/providers/google/monitoring/services/index.md b/docs/google-docs/providers/google/monitoring/services/index.md index 510bf0192f..fe4555d208 100644 --- a/docs/google-docs/providers/google/monitoring/services/index.md +++ b/docs/google-docs/providers/google/monitoring/services/index.md @@ -28,23 +28,26 @@ 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] | +| `cloudEndpoints` | `object` | Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. | +| `meshIstio` | `object` | Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. | +| `cloudRun` | `object` | Cloud Run service. Learn more at https://cloud.google.com/run. | +| `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. | +| `displayName` | `string` | Name used for UI elements listing this Service. | | `appEngine` | `object` | App Engine service. Learn more at https://cloud.google.com/appengine. | +| `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). | +| `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. | | `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. | | `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. | -| `meshIstio` | `object` | Istio service scoped to an Istio mesh. Anthos clusters running ASM < 1.6.8 will have their services ingested as this type. | -| `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. | +| `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). | | `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. | -| `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). | -| `displayName` | `string` | Name used for UI elements listing this Service. | -| `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. | -| `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). | -| `cloudEndpoints` | `object` | Cloud Endpoints service. Learn more at https://cloud.google.com/endpoints. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `services_get` | `SELECT` | `name` | Get the named Service. | | `services_list` | `SELECT` | `parent` | List Services for this Metrics Scope. | | `services_create` | `INSERT` | `parent` | Create a Service. | +| `services_delete` | `DELETE` | `name` | Soft delete this Service. | | `_services_list` | `EXEC` | `parent` | List Services for this Metrics Scope. | +| `services_patch` | `EXEC` | `name` | Update this Service. | diff --git a/docs/google-docs/providers/google/monitoring/snoozes/index.md b/docs/google-docs/providers/google/monitoring/snoozes/index.md index bc1c7791b6..4e7071c905 100644 --- a/docs/google-docs/providers/google/monitoring/snoozes/index.md +++ b/docs/google-docs/providers/google/monitoring/snoozes/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. | -| `criteria` | `object` | Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied. | | `displayName` | `string` | Required. A display name for the Snooze. This can be, at most, 512 unicode characters. | | `interval` | `object` | Describes a time interval: Reads: A half-open time interval. It includes the end time but excludes the start time: (startTime, endTime]. The start time must be specified, must be earlier than the end time, and should be no older than the data retention period for the metric. Writes: A closed time interval. It extends from the start time to the end time, and includes both: [startTime, endTime]. Valid time intervals depend on the MetricKind (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time, and the end time must not be more than 25 hours in the past or more than five minutes in the future. For GAUGE metrics, the startTime value is technically optional; if no value is specified, the start time defaults to the value of the end time, and the interval represents a single point in time. If both start and end times are specified, they must be identical. Such an interval is valid only for GAUGE metrics, which are point-in-time measurements. The end time of a new interval must be at least a millisecond after the end time of the previous interval. For DELTA metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For DELTA metrics, the start time of the next interval must be at least a millisecond after the end time of the previous interval. For CUMULATIVE metrics, the start time and end time must specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. The new start time must be at least a millisecond after the end time of the previous interval. The start time of a new interval must be at least a millisecond after the end time of the previous interval because intervals are closed. If the start time of a new interval is the same as the end time of the previous interval, then data written at the new start time could overwrite data written at the previous end time. | +| `criteria` | `object` | Criteria specific to the AlertPolicys that this Snooze applies to. The Snooze will suppress alerts that come from one of the AlertPolicys whose names are supplied. | ## 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 ba096dbe73..dde95fb584 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 | |:-----|:---------|:------------| +| `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. | | `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. | ## 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 4372d88836..61f53374f2 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,26 +28,26 @@ 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. | -| `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. | -| `httpCheck` | `object` | Information involved in an HTTP/HTTPS Uptime check request. | -| `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. | -| `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. | | `tcpCheck` | `object` | Information required for a TCP Uptime check request. | -| `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. | +| `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. | +| `checkerType` | `string` | The type of checkers to use to execute the Uptime check. | +| `timeout` | `string` | The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. | | `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. | | `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. | | `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" }} | +| `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. | | `syntheticMonitor` | `object` | Describes a Synthetic Monitor to be invoked by Uptime. | +| `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. | +| `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. | -| `timeout` | `string` | The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). 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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_uptime_check_configs_get` | `SELECT` | `projectsId, uptimeCheckConfigsId` | Gets a single Uptime check configuration. | | `projects_uptime_check_configs_list` | `SELECT` | `projectsId` | Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). | | `projects_uptime_check_configs_create` | `INSERT` | `projectsId` | Creates a new Uptime check configuration. | | `projects_uptime_check_configs_delete` | `DELETE` | `projectsId, uptimeCheckConfigsId` | Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion. | | `_projects_uptime_check_configs_list` | `EXEC` | `projectsId` | Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). | -| `projects_uptime_check_configs_get` | `EXEC` | `projectsId, uptimeCheckConfigsId` | Gets a single Uptime check configuration. | | `projects_uptime_check_configs_patch` | `EXEC` | `projectsId, uptimeCheckConfigsId` | Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration. | diff --git a/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md b/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md index ee41971fb9..fbaafc48ae 100644 --- a/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md +++ b/docs/google-docs/providers/google/monitoring/uptime_check_ips/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| +| `ipAddress` | `string` | The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format. | | `location` | `string` | A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category. | | `region` | `string` | A broad region category in which the IP address is located. | -| `ipAddress` | `string` | The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/groups/index.md b/docs/google-docs/providers/google/networkconnectivity/groups/index.md index c6ba8aeebc..d135752b4f 100644 --- a/docs/google-docs/providers/google/networkconnectivity/groups/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/groups/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Immutable. The name of the group. Group names must be unique. They use the following form: `projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}` | | `description` | `string` | Optional. The description of the group. | -| `uid` | `string` | Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id. | | `updateTime` | `string` | Output only. The time the group was last updated. | | `createTime` | `string` | Output only. The time the group 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 group. | +| `uid` | `string` | Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id. | ## 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 ec84971636..d1f48b3561 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 9a4dafcd5a..bbc07c37ab 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. | -| `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. | +| `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. | +| `updateTime` | `string` | Output only. The time the hub was last updated. | | `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). | +| `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. | +| `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. | | `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. | -| `updateTime` | `string` | Output only. The time the hub was last updated. | -| `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. | | `createTime` | `string` | Output only. The time the hub was created. | +| `state` | `string` | Output only. The current lifecycle state of this hub. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/hubs_iam_policies/index.md b/docs/google-docs/providers/google/networkconnectivity/hubs_iam_policies/index.md index 1f45293cc1..6a83550d96 100644 --- a/docs/google-docs/providers/google/networkconnectivity/hubs_iam_policies/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/hubs_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkconnectivity/index.md b/docs/google-docs/providers/google/networkconnectivity/index.md index 00d79e54bb..f0e335fc93 100644 --- a/docs/google-docs/providers/google/networkconnectivity/index.md +++ b/docs/google-docs/providers/google/networkconnectivity/index.md @@ -19,9 +19,9 @@ This API Enables Connectivity With And Between Google Cloud Resources.
-total resources: 19
-total selectable resources: 19
-total methods: 89
+total resources: 20
+total selectable resources: 20
+total methods: 94
@@ -33,7 +33,7 @@ This API Enables Connectivity With And Between Google Cloud Resources. TypeService TitleNetwork Connectivity API DescriptionThis API Enables Connectivity With And Between Google Cloud Resources. -Idnetworkconnectivity:v23.08.00161 +Idnetworkconnectivity:v23.08.00163 ## Resources @@ -46,11 +46,12 @@ This API Enables Connectivity With And Between Google Cloud Resources. internal_ranges
locations
operations
+policy_based_routes
policy_based_routes_iam_policies
route_tables
-routes
+routes
service_classes
service_classes_iam_policies
service_connection_maps
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 50044a3e31..980e0af0a0 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. | -| `ipCidrRange` | `string` | The IP range that this internal range defines. | -| `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. | -| `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. | -| `labels` | `object` | User-defined labels. | -| `updateTime` | `string` | Time when the internal range was updated. | +| `usage` | `string` | The type of usage set for this InternalRange. | | `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 | +| `peering` | `string` | The type of peering set for this internal range. | +| `createTime` | `string` | Time when the internal range was created. | +| `updateTime` | `string` | Time when the internal range was updated. | +| `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. | | `overlaps` | `array` | Optional. Types of resources that are allowed to overlap with the current internal range. | +| `ipCidrRange` | `string` | The IP range that this internal range defines. | +| `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. | | `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. | -| `createTime` | `string` | Time when the internal range was created. | -| `usage` | `string` | The type of usage set for this InternalRange. | -| `peering` | `string` | The type of peering set for this internal range. | +| `labels` | `object` | User-defined labels. | ## 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 aa47433a7b..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"` | -| `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/networkconnectivity/operations/index.md b/docs/google-docs/providers/google/networkconnectivity/operations/index.md index e47799c26c..a7a48fb0ba 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}`. | -| `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/networkconnectivity/policy_based_routes/index.md b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes/index.md new file mode 100644 index 0000000000..5702a4dc48 --- /dev/null +++ b/docs/google-docs/providers/google/networkconnectivity/policy_based_routes/index.md @@ -0,0 +1,52 @@ +--- +title: policy_based_routes +hide_title: false +hide_table_of_contents: false +keywords: + - policy_based_routes + - 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
TypeResource
Idgoogle.networkconnectivity.policy_based_routes
+ +## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Immutable. A unique name of the resource in the form of `projects/{project_number}/locations/global/PolicyBasedRoutes/{policy_based_route_id}` | +| `description` | `string` | Optional. An optional description of this resource. Provide this field when you create the resource. | +| `labels` | `object` | User-defined labels. | +| `interconnectAttachment` | `object` | InterconnectAttachment to which this route applies to. | +| `warnings` | `array` | Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages. | +| `network` | `string` | Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network. | +| `updateTime` | `string` | Output only. Time when the PolicyBasedRoute was updated. | +| `kind` | `string` | Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources. | +| `filter` | `object` | Filter matches L4 traffic. | +| `createTime` | `string` | Output only. Time when the PolicyBasedRoute was created. | +| `nextHopOtherRoutes` | `string` | Optional. Other routes that will be referenced to determine the next hop of the packet. | +| `selfLink` | `string` | Output only. Server-defined fully-qualified URL for this resource. | +| `nextHopIlbIp` | `string` | Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported. | +| `priority` | `integer` | Optional. The priority of this policy based route. Priority is used to break ties in cases where there are more than one matching policy based routes found. In cases where multiple policy based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive. | +| `virtualMachine` | `object` | VM instances to which this policy based route applies to. | +## Methods +| Name | Accessible by | Required Params | Description | +|:-----|:--------------|:----------------|:------------| +| `get` | `SELECT` | `policyBasedRoutesId, projectsId` | Gets details of a single PolicyBasedRoute. | +| `list` | `SELECT` | `projectsId` | Lists PolicyBasedRoutes in a given project and location. | +| `create` | `INSERT` | `projectsId` | Creates a new PolicyBasedRoute in a given project and location. | +| `delete` | `DELETE` | `policyBasedRoutesId, projectsId` | Deletes a single PolicyBasedRoute. | +| `_list` | `EXEC` | `projectsId` | Lists PolicyBasedRoutes in a given project and location. | 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 a9a3b476e2..9b1c030ec3 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | 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 f68898f23e..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. | +| `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. | -| `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. | ## 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 3616141f14..abb9d99bc2 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. | -| `updateTime` | `string` | Output only. The time the route was last updated. | -| `ipCidrRange` | `string` | The destination 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. | -| `spoke` | `string` | Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE | -| `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. | | `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 | -| `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`. | | `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 | +| `ipCidrRange` | `string` | The destination IP address range. | +| `type` | `string` | Output only. The route's type. Its type is determined by the properties of its IP address range. | +| `spoke` | `string` | Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE | +| `updateTime` | `string` | Output only. The time the route was last updated. | +| `state` | `string` | Output only. The current lifecycle state of the route. | ## 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_connection_maps/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_maps/index.md index e3fa551bd5..95cfa3f9bf 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. | -| `updateTime` | `string` | Output only. Time when the ServiceConnectionMap was updated. | -| `infrastructure` | `string` | Output only. The infrastructure used for connections between consumers/producers. | -| `labels` | `object` | User-defined labels. | +| `consumerPscConnections` | `array` | Output only. PSC connection details on consumer side. | | `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. | | `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. | | `serviceClassUri` | `string` | Output only. The service class uri this ServiceConnectionMap is for. | +| `createTime` | `string` | Output only. Time when the ServiceConnectionMap was created. | | `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. | | `consumerPscConfigs` | `array` | The PSC configurations on consumer side. | | `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. | +| `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/index.md b/docs/google-docs/providers/google/networkconnectivity/service_connection_policies/index.md index 7c26c5179b..0923a760a4 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. | -| `network` | `string` | The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}. | -| `pscConfig` | `object` | Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. | +| `pscConnections` | `array` | Output only. [Output only] Information about each Private Service Connect connection. | | `updateTime` | `string` | Output only. Time when the ServiceConnectionMap was updated. | +| `labels` | `object` | User-defined labels. | | `infrastructure` | `string` | Output only. The type of underlying resources used to create the connection. | +| `network` | `string` | The resource path of the consumer network. Example: - projects/{projectNumOrId}/global/networks/{resourceId}. | +| `pscConfig` | `object` | Configuration used for Private Service Connect connections. Used when Infrastructure is PSC. | | `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. | | `createTime` | `string` | Output only. Time when the ServiceConnectionMap was created. | -| `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. | -| `pscConnections` | `array` | Output only. [Output only] Information about each Private Service Connect connection. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 faaa4fa5fd..8c0abcaeff 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 83dce7e989..ecaada709d 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,13 +29,13 @@ 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. | -| `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. | | `updateTime` | `string` | Output only. Time when the ServiceConnectionToken was updated. | -| `createTime` | `string` | Output only. Time when the ServiceConnectionToken was created. | -| `labels` | `object` | User-defined labels. | | `token` | `string` | Output only. The token generated by Automation. | +| `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. | +| `createTime` | `string` | Output only. Time when the ServiceConnectionToken was created. | | `network` | `string` | The resource path of the network associated with this token. Example: projects/{projectNumOrId}/global/networks/{resourceId}. | +| `expireTime` | `string` | Output only. The time to which this token is valid. | ## 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 267c8389d8..4e47994bd2 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. | -| `linkedVpcNetwork` | `object` | An existing VPC network. | -| `createTime` | `string` | Output only. The time the spoke was created. | -| `reasons` | `array` | Output only. The reasons for current state of the spoke. Only present when the spoke is in the `INACTIVE` state. | | `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). | | `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. | | `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. | +| `linkedVpcNetwork` | `object` | An existing VPC network. | | `spokeType` | `string` | Output only. The type of resource associated with the spoke. | +| `updateTime` | `string` | Output only. The time the spoke was last updated. | | `state` | `string` | Output only. The current lifecycle state of this spoke. | | `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. | -| `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. | -| `updateTime` | `string` | Output only. The time the spoke was last updated. | +| `createTime` | `string` | Output only. The time the spoke was created. | +| `hub` | `string` | Immutable. The name of the hub that this spoke is attached to. | +| `reasons` | `array` | Output only. The reasons for current state of the spoke. Only present when the spoke is in the `INACTIVE` state. | +| `group` | `string` | The name of the group that this spoke is associated with. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 214cb26c24..437821be0a 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. | -| `relatedProjects` | `array` | Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries. | -| `source` | `object` | Source or destination of the Connectivity Test. | -| `updateTime` | `string` | Output only. The time the test's configuration was updated. | -| `labels` | `object` | Resource labels to represent user-provided metadata. | | `displayName` | `string` | Output only. The display name of a Connectivity Test. | +| `updateTime` | `string` | Output only. The time the test's configuration was updated. | | `createTime` | `string` | Output only. The time the test was created. | +| `relatedProjects` | `array` | Other projects that may be relevant for reachability analysis. This is applicable to scenarios where a test can cross project boundaries. | | `destination` | `object` | Source or destination of the Connectivity Test. | -| `reachabilityDetails` | `object` | Results of the configuration analysis from the last run of the test. | +| `labels` | `object` | Resource labels to represent user-provided metadata. | +| `source` | `object` | Source or destination of the Connectivity Test. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 6e7308eb2d..3e2dfe4c0c 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkmanagement/index.md b/docs/google-docs/providers/google/networkmanagement/index.md index 61bb14b20a..72747c1536 100644 --- a/docs/google-docs/providers/google/networkmanagement/index.md +++ b/docs/google-docs/providers/google/networkmanagement/index.md @@ -33,7 +33,7 @@ The Network Management API Provides A Collection Of Network Performance Monitori TypeService TitleNetwork Management API DescriptionThe Network Management API Provides A Collection Of Network Performance Monitoring And Diagnostic Capabilities. -Idnetworkmanagement:v23.08.00161 +Idnetworkmanagement:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/networkmanagement/locations/index.md b/docs/google-docs/providers/google/networkmanagement/locations/index.md index 9f861f0f88..712d2802f7 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"`. | +| `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/networkmanagement/operations/index.md b/docs/google-docs/providers/google/networkmanagement/operations/index.md index 984fa587e7..d6a956dbc1 100644 --- a/docs/google-docs/providers/google/networkmanagement/operations/index.md +++ b/docs/google-docs/providers/google/networkmanagement/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/networksecurity/address_groups/index.md b/docs/google-docs/providers/google/networksecurity/address_groups/index.md index 090f4069cc..59d8b26a52 100644 --- a/docs/google-docs/providers/google/networksecurity/address_groups/index.md +++ b/docs/google-docs/providers/google/networksecurity/address_groups/index.md @@ -25,21 +25,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | Required. Name of the AddressGroup resource. It matches pattern `projects/*/locations/{location}/addressGroups/`. | -| `description` | `string` | Optional. Free-text description of the resource. | -| `items` | `array` | Optional. List of items. | -| `createTime` | `string` | Output only. The timestamp when the resource was created. | -| `selfLink` | `string` | Output only. Server-defined fully-qualified URL for this resource. | -| `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. | -| `capacity` | `integer` | Required. Capacity of the Address Group | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `organizations_locations_address_groups_get` | `SELECT` | `addressGroupsId, locationsId, organizationsId` | Gets details of a single address group. | | `organizations_locations_address_groups_list` | `SELECT` | `locationsId, organizationsId` | Lists address groups in a given project and location. | +| `projects_locations_address_groups_get` | `SELECT` | `addressGroupsId, locationsId, projectsId` | Gets details of a single address group. | | `projects_locations_address_groups_list` | `SELECT` | `locationsId, projectsId` | Lists address groups in a given project and location. | | `organizations_locations_address_groups_create` | `INSERT` | `locationsId, organizationsId` | Creates a new address group in a given project and location. | | `projects_locations_address_groups_create` | `INSERT` | `locationsId, projectsId` | Creates a new address group in a given project and location. | @@ -48,8 +39,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_organizations_locations_address_groups_list` | `EXEC` | `locationsId, organizationsId` | Lists address groups in a given project and location. | | `_projects_locations_address_groups_list` | `EXEC` | `locationsId, projectsId` | Lists address groups in a given project and location. | | `organizations_locations_address_groups_clone_items` | `EXEC` | `addressGroupsId, locationsId, organizationsId` | Clones items from one address group to another. | -| `organizations_locations_address_groups_get` | `EXEC` | `addressGroupsId, locationsId, organizationsId` | Gets details of a single address group. | | `organizations_locations_address_groups_patch` | `EXEC` | `addressGroupsId, locationsId, organizationsId` | Updates parameters of an address group. | | `projects_locations_address_groups_clone_items` | `EXEC` | `addressGroupsId, locationsId, projectsId` | Clones items from one address group to another. | -| `projects_locations_address_groups_get` | `EXEC` | `addressGroupsId, locationsId, projectsId` | Gets details of a single address group. | | `projects_locations_address_groups_patch` | `EXEC` | `addressGroupsId, locationsId, projectsId` | Updates the parameters of a single address group. | 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 b19195724b..eb71d1001a 100644 --- a/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/authorization_policies/index.md @@ -29,17 +29,17 @@ 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. | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_authorization_policies_get` | `SELECT` | `authorizationPoliciesId, locationsId, projectsId` | Gets details of a single AuthorizationPolicy. | | `projects_locations_authorization_policies_list` | `SELECT` | `locationsId, projectsId` | Lists AuthorizationPolicies in a given project and location. | | `projects_locations_authorization_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new AuthorizationPolicy in a given project and location. | | `projects_locations_authorization_policies_delete` | `DELETE` | `authorizationPoliciesId, locationsId, projectsId` | Deletes a single AuthorizationPolicy. | | `_projects_locations_authorization_policies_list` | `EXEC` | `locationsId, projectsId` | Lists AuthorizationPolicies in a given project and location. | -| `projects_locations_authorization_policies_get` | `EXEC` | `authorizationPoliciesId, locationsId, projectsId` | Gets details of a single AuthorizationPolicy. | | `projects_locations_authorization_policies_patch` | `EXEC` | `authorizationPoliciesId, locationsId, projectsId` | Updates the parameters of a single AuthorizationPolicy. | diff --git a/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md b/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md index 3ba567f371..c840860104 100644 --- a/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md +++ b/docs/google-docs/providers/google/networksecurity/client_tls_policies/index.md @@ -29,18 +29,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the ClientTlsPolicy resource. It matches the pattern `projects/*/locations/{location}/clientTlsPolicies/{client_tls_policy}` | | `description` | `string` | Optional. Free-text description of the resource. | +| `serverValidationCa` | `array` | Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. | | `sni` | `string` | Optional. Server Name Indication string to present to the server during TLS handshake. E.g: "secure.example.com". | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `clientCertificate` | `object` | Specification of certificate provider. Defines the mechanism to obtain the certificate and private key for peer to peer authentication. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `labels` | `object` | Optional. Set of label tags associated with the resource. | -| `serverValidationCa` | `array` | Optional. Defines the mechanism to obtain the Certificate Authority certificate to validate the server certificate. If empty, client does not validate the server certificate. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_client_tls_policies_get` | `SELECT` | `clientTlsPoliciesId, locationsId, projectsId` | Gets details of a single ClientTlsPolicy. | | `projects_locations_client_tls_policies_list` | `SELECT` | `locationsId, projectsId` | Lists ClientTlsPolicies in a given project and location. | | `projects_locations_client_tls_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new ClientTlsPolicy in a given project and location. | | `projects_locations_client_tls_policies_delete` | `DELETE` | `clientTlsPoliciesId, locationsId, projectsId` | Deletes a single ClientTlsPolicy. | | `_projects_locations_client_tls_policies_list` | `EXEC` | `locationsId, projectsId` | Lists ClientTlsPolicies in a given project and location. | -| `projects_locations_client_tls_policies_get` | `EXEC` | `clientTlsPoliciesId, locationsId, projectsId` | Gets details of a single ClientTlsPolicy. | | `projects_locations_client_tls_policies_patch` | `EXEC` | `clientTlsPoliciesId, locationsId, projectsId` | Updates the parameters of a single ClientTlsPolicy. | diff --git a/docs/google-docs/providers/google/networksecurity/index.md b/docs/google-docs/providers/google/networksecurity/index.md index a7d181e983..d2afc7d71c 100644 --- a/docs/google-docs/providers/google/networksecurity/index.md +++ b/docs/google-docs/providers/google/networksecurity/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleNetwork Security API Description -Idnetworksecurity:v23.08.00161 +Idnetworksecurity:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/networksecurity/locations/index.md b/docs/google-docs/providers/google/networksecurity/locations/index.md index a9f4a07ce7..c8c6bd5d46 100644 --- a/docs/google-docs/providers/google/networksecurity/locations/index.md +++ b/docs/google-docs/providers/google/networksecurity/locations/index.md @@ -35,6 +35,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | diff --git a/docs/google-docs/providers/google/networksecurity/operations/index.md b/docs/google-docs/providers/google/networksecurity/operations/index.md index 799c92afcc..a9465280a8 100644 --- a/docs/google-docs/providers/google/networksecurity/operations/index.md +++ b/docs/google-docs/providers/google/networksecurity/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 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 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 | |:-----|:--------------|:----------------|:------------| +| `organizations_locations_operations_get` | `SELECT` | `locationsId, operationsId, organizationsId` | 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. | | `organizations_locations_operations_list` | `SELECT` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_delete` | `DELETE` | `locationsId, operationsId, organizationsId` | 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`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_organizations_locations_operations_list` | `EXEC` | `locationsId, organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_locations_operations_cancel` | `EXEC` | `locationsId, operationsId, organizationsId` | 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`. | -| `organizations_locations_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId` | 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. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/networksecurity/rules/index.md b/docs/google-docs/providers/google/networksecurity/rules/index.md index d7e14766a4..ecc0555639 100644 --- a/docs/google-docs/providers/google/networksecurity/rules/index.md +++ b/docs/google-docs/providers/google/networksecurity/rules/index.md @@ -29,13 +29,13 @@ 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. | -| `sessionMatcher` | `string` | Required. CEL expression for matching on session criteria. | | `priority` | `integer` | Required. Priority of the rule. Lower number corresponds to higher precedence. | +| `sessionMatcher` | `string` | Required. CEL expression for matching on session criteria. | +| `basicProfile` | `string` | Required. Profile which tells what the primitive action should be. | +| `enabled` | `boolean` | Required. Whether the rule is enforced. | | `applicationMatcher` | `string` | Optional. CEL expression for matching on L7/application level criteria. | -| `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. | -| `enabled` | `boolean` | Required. Whether the rule is enforced. | -| `basicProfile` | `string` | Required. Profile which tells what the primitive action should be. | +| `tlsInspectionEnabled` | `boolean` | Optional. Flag to enable TLS inspection of traffic matching on , can only be true if the parent GatewaySecurityPolicy references a TLSInspectionConfig. | | `updateTime` | `string` | Output only. Time when the rule was updated. | ## 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 be9eb7e7d1..ec3e05a902 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 @@ -38,9 +38,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_server_tls_policies_get` | `SELECT` | `locationsId, projectsId, serverTlsPoliciesId` | Gets details of a single ServerTlsPolicy. | | `projects_locations_server_tls_policies_list` | `SELECT` | `locationsId, projectsId` | Lists ServerTlsPolicies in a given project and location. | | `projects_locations_server_tls_policies_create` | `INSERT` | `locationsId, projectsId` | Creates a new ServerTlsPolicy in a given project and location. | | `projects_locations_server_tls_policies_delete` | `DELETE` | `locationsId, projectsId, serverTlsPoliciesId` | Deletes a single ServerTlsPolicy. | | `_projects_locations_server_tls_policies_list` | `EXEC` | `locationsId, projectsId` | Lists ServerTlsPolicies in a given project and location. | -| `projects_locations_server_tls_policies_get` | `EXEC` | `locationsId, projectsId, serverTlsPoliciesId` | Gets details of a single ServerTlsPolicy. | | `projects_locations_server_tls_policies_patch` | `EXEC` | `locationsId, projectsId, serverTlsPoliciesId` | Updates the parameters of a single ServerTlsPolicy. | 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 f0dc91f8ab..21d915187b 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. | -| `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. | | `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. | +| `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. | | `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. | -| `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. | -| `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}". | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networksecurity/url_lists/index.md b/docs/google-docs/providers/google/networksecurity/url_lists/index.md index bf68ea22a2..33694bdab0 100644 --- a/docs/google-docs/providers/google/networksecurity/url_lists/index.md +++ b/docs/google-docs/providers/google/networksecurity/url_lists/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the resource provided by the user. Name is of the form projects/{project}/locations/{location}/urlLists/{url_list} url_list should match the pattern:(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$). | | `description` | `string` | Optional. Free-text description of the resource. | +| `createTime` | `string` | Output only. Time when the security policy was created. | | `updateTime` | `string` | Output only. Time when the security policy was updated. | | `values` | `array` | Required. FQDNs and URLs. | -| `createTime` | `string` | Output only. Time when the security policy was created. | ## 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 6b7fb02de3..729c348258 100644 --- a/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md +++ b/docs/google-docs/providers/google/networkservices/endpoint_policies/index.md @@ -31,13 +31,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `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. | -| `trafficPortSelector` | `object` | Specification of a port-based selector. | -| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | -| `labels` | `object` | Optional. Set of label tags associated with the EndpointPolicy resource. | -| `endpointMatcher` | `object` | A definition of a matcher that selects endpoints to which the policies should be applied. | | `type` | `string` | Required. The type of endpoint policy. This is primarily used to validate the configuration. | | `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. | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `trafficPortSelector` | `object` | Specification of a port-based selector. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 cdb9b4c478..dad991a671 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/gateways/index.md b/docs/google-docs/providers/google/networkservices/gateways/index.md index b0c3dd10f5..76e20222b4 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. | -| `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'. | +| `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". | | `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'. | | `type` | `string` | Immutable. The type of the customer managed gateway. This field is required. If unspecified, an error is returned. | | `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. | -| `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". | -| `serverTlsPolicy` | `string` | Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. | -| `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. | -| `createTime` | `string` | Output only. The timestamp when the resource was created. | | `selfLink` | `string` | Output only. Server-defined URL of this resource | -| `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'. | +| `labels` | `object` | Optional. Set of label tags associated with the Gateway resource. | +| `serverTlsPolicy` | `string` | Optional. A fully-qualified ServerTLSPolicy URL reference. Specifies how TLS traffic is terminated. If empty, TLS termination is disabled. | | `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. | +| `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'. | +| `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/grpc_routes/index.md b/docs/google-docs/providers/google/networkservices/grpc_routes/index.md index 75a7d98c2c..39a34eb18d 100644 --- a/docs/google-docs/providers/google/networkservices/grpc_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/grpc_routes/index.md @@ -29,14 +29,14 @@ 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. | +| `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/` | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | | `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. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | -| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `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. | | `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/` | +| `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"). | ## 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 412e0701ee..2ab2ca58e0 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. | -| `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 | | `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `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`. | +| `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. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `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/` | -| `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. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/index.md b/docs/google-docs/providers/google/networkservices/index.md index 5ecbb6ff88..69b56e7415 100644 --- a/docs/google-docs/providers/google/networkservices/index.md +++ b/docs/google-docs/providers/google/networkservices/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleNetwork Services API Description -Idnetworkservices:v23.08.00161 +Idnetworkservices:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/networkservices/meshes/index.md b/docs/google-docs/providers/google/networkservices/meshes/index.md index fdb0bb1cb1..c4a802fc2e 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. | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 33d29afaeb..d003d98f85 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/networkservices/operations/index.md b/docs/google-docs/providers/google/networkservices/operations/index.md index 521c7d2d34..1a51986bae 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}`. | +| `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/networkservices/service_bindings/index.md b/docs/google-docs/providers/google/networkservices/service_bindings/index.md index 73ef7a5ce4..93ffc4667a 100644 --- a/docs/google-docs/providers/google/networkservices/service_bindings/index.md +++ b/docs/google-docs/providers/google/networkservices/service_bindings/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Required. Name of the ServiceBinding resource. It matches pattern `projects/*/locations/global/serviceBindings/service_binding_name`. | | `description` | `string` | Optional. A free-text description of the resource. Max length 1024 characters. | +| `labels` | `object` | Optional. Set of label tags associated with the ServiceBinding resource. | | `service` | `string` | Required. The full Service Directory Service name of the format projects/*/locations/*/namespaces/*/services/* | | `serviceId` | `string` | Output only. The unique identifier of the Service Directory Service against which the Service Binding resource is validated. This is populated when the Service Binding resource is used in another resource (like Backend Service). This is of the UUID4 format. | | `updateTime` | `string` | Output only. The timestamp when the resource was updated. | | `createTime` | `string` | Output only. The timestamp when the resource was created. | -| `labels` | `object` | Optional. Set of label tags associated with the ServiceBinding resource. | ## 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 08d44ebde9..c671aca53b 100644 --- a/docs/google-docs/providers/google/networkservices/tcp_routes/index.md +++ b/docs/google-docs/providers/google/networkservices/tcp_routes/index.md @@ -29,13 +29,13 @@ 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. | -| `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. | +| `selfLink` | `string` | Output only. Server-defined URL of this resource | +| `updateTime` | `string` | Output only. The timestamp when the resource was updated. | +| `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 | | `createTime` | `string` | Output only. The timestamp when the resource was created. | | `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. | | `labels` | `object` | Optional. Set of label tags associated with the TcpRoute resource. | -| `selfLink` | `string` | Output only. Server-defined URL of this 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 4f645b9afd..4f3a69b3ec 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,13 @@ 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. | +| `createTime` | `string` | Output only. The timestamp when the resource was created. | +| `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 | +| `labels` | `object` | Optional. Set of label tags associated with the TlsRoute 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 | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/index.md b/docs/google-docs/providers/google/notebooks/index.md index fa42fb68ae..38c4d42b58 100644 --- a/docs/google-docs/providers/google/notebooks/index.md +++ b/docs/google-docs/providers/google/notebooks/index.md @@ -33,7 +33,7 @@ Notebooks API Is Used To Manage Notebook Resources In Google Cloud. TypeService TitleNotebooks API DescriptionNotebooks API Is Used To Manage Notebook Resources In Google Cloud. -Idnotebooks:v23.08.00161 +Idnotebooks:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/notebooks/instances/index.md b/docs/google-docs/providers/google/notebooks/instances/index.md index 6a102f1aad..85147a7265 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. | -| `state` | `string` | Output only. The state of this instance. | -| `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. | -| `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" } | -| `gceSetup` | `object` | The definition of how to configure a VM instance outside of Resources and Identity. | +| `upgradeHistory` | `array` | Output only. The upgrade history of this instance. | | `updateTime` | `string` | Output only. Instance update time. | -| `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. | -| `disableProxyAccess` | `boolean` | Optional. If true, the notebook instance will not register with the proxy. | +| `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. Instance health_state. | | `creator` | `string` | Output only. Email address of entity that sent original CreateInstance request. | -| `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. | +| `state` | `string` | Output only. The state of this instance. | +| `gceSetup` | `object` | The definition of how to configure a VM instance outside of Resources and Identity. | +| `disableProxyAccess` | `boolean` | Optional. If true, the notebook instance will not register with the proxy. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 7407a18391..526b896215 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 | |:-----|:---------|:------------| -| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/notebooks/locations/index.md b/docs/google-docs/providers/google/notebooks/locations/index.md index e5f4cb55b2..f7903c647f 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"` | -| `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/ondemandscanning/index.md b/docs/google-docs/providers/google/ondemandscanning/index.md index fffd78e488..fe0c6ae4df 100644 --- a/docs/google-docs/providers/google/ondemandscanning/index.md +++ b/docs/google-docs/providers/google/ondemandscanning/index.md @@ -33,7 +33,7 @@ A Service To Scan Container Images For Vulnerabilities. TypeService TitleOn-Demand Scanning API DescriptionA Service To Scan Container Images For Vulnerabilities. -Idondemandscanning:v23.08.00161 +Idondemandscanning:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/ondemandscanning/operations/index.md b/docs/google-docs/providers/google/ondemandscanning/operations/index.md index b92d54bfd5..ed9e0e6753 100644 --- a/docs/google-docs/providers/google/ondemandscanning/operations/index.md +++ b/docs/google-docs/providers/google/ondemandscanning/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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md b/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md index 2296d22573..1f0bda1462 100644 --- a/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md +++ b/docs/google-docs/providers/google/ondemandscanning/vulnerabilities/index.md @@ -28,23 +28,23 @@ 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]`. | -| `dsseAttestation` | `object` | Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. | -| `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. | | `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. | -| `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. | -| `deployment` | `object` | The period during which some deployable was active in a runtime. | -| `package` | `object` | Details on how a particular software package was installed on a system. | -| `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 . | | `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. | +| `compliance` | `object` | An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason. | +| `deployment` | `object` | The period during which some deployable was active in a runtime. | +| `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. | | `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. | | `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. | -| `vulnerability` | `object` | An occurrence of a severity vulnerability on a resource. | -| `image` | `object` | Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM . | +| `createTime` | `string` | Output only. The time this occurrence was created. | +| `package` | `object` | Details on how a particular software package was installed on a system. | +| `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. | | `envelope` | `object` | MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. | +| `discovery` | `object` | Provides information about the analysis status of a discovered resource. | | `remediation` | `string` | A description of actions that can be taken to remedy the note. | ## Methods | Name | Accessible by | Required Params | diff --git a/docs/google-docs/providers/google/orgpolicy/index.md b/docs/google-docs/providers/google/orgpolicy/index.md index a09a771547..aa315865af 100644 --- a/docs/google-docs/providers/google/orgpolicy/index.md +++ b/docs/google-docs/providers/google/orgpolicy/index.md @@ -33,7 +33,7 @@ The Organization Policy API Allows Users To Configure Governance Rules On Their TypeService TitleOrganization Policy API DescriptionThe Organization Policy API Allows Users To Configure Governance Rules On Their Google Cloud Resources Across The Resource Hierarchy. -Idorgpolicy:v23.08.00161 +Idorgpolicy:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/osconfig/index.md b/docs/google-docs/providers/google/osconfig/index.md index 1c3914ef2b..174beb173a 100644 --- a/docs/google-docs/providers/google/osconfig/index.md +++ b/docs/google-docs/providers/google/osconfig/index.md @@ -19,8 +19,8 @@ OS Management Tools That Can Be Used For Patch Management, Patch Compliance, And
-total resources: 11
-total selectable resources: 10
+total resources: 12
+total selectable resources: 11
total methods: 34
@@ -33,7 +33,7 @@ OS Management Tools That Can Be Used For Patch Management, Patch Compliance, And TypeService TitleOS Config API DescriptionOS Management Tools That Can Be Used For Patch Management, Patch Compliance, And Configuration Management On VM Instances. -Idosconfig:v23.08.00161 +Idosconfig:v23.08.00163 ## Resources @@ -41,12 +41,13 @@ OS Management Tools That Can Be Used For Patch Management, Patch Compliance, And
instance_details
inventories
+inventory
operations
os_policy_assignments
os_policy_assignments_revisions
-patch_deployments
+patch_deployments
patch_jobs
report
reports
diff --git a/docs/google-docs/providers/google/osconfig/instance_details/index.md b/docs/google-docs/providers/google/osconfig/instance_details/index.md index e300aab68a..61ba8e3179 100644 --- a/docs/google-docs/providers/google/osconfig/instance_details/index.md +++ b/docs/google-docs/providers/google/osconfig/instance_details/index.md @@ -28,10 +28,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The instance name in the form `projects/*/zones/*/instances/*` | -| `failureReason` | `string` | If the patch fails, this field provides the reason. | -| `instanceSystemId` | `string` | The unique identifier for the instance. This identifier is defined by the server. | | `state` | `string` | Current state of instance patch. | | `attemptCount` | `string` | The number of times the agent that the agent attempts to apply the patch. | +| `failureReason` | `string` | If the patch fails, this field provides the reason. | +| `instanceSystemId` | `string` | The unique identifier for the instance. This identifier is defined by the server. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/osconfig/inventories/index.md b/docs/google-docs/providers/google/osconfig/inventories/index.md index cc4781bf51..1c898c158e 100644 --- a/docs/google-docs/providers/google/osconfig/inventories/index.md +++ b/docs/google-docs/providers/google/osconfig/inventories/index.md @@ -28,12 +28,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | 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. | +| `osInfo` | `object` | Operating system information for the VM. | ## Methods -| Name | Accessible by | Required Params | Description | -|:-----|:--------------|:----------------|:------------| -| `get` | `SELECT` | `instancesId, locationsId, projectsId` | Get inventory data for the specified VM instance. If the VM has no associated inventory, the message `NOT_FOUND` is returned. | -| `list` | `SELECT` | `instancesId, locationsId, projectsId` | List inventory data for all VM instances in the specified zone. | -| `_list` | `EXEC` | `instancesId, locationsId, projectsId` | List inventory data for all VM instances in the specified zone. | +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `list` | `SELECT` | `instancesId, locationsId, projectsId` | +| `_list` | `EXEC` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/osconfig/inventory/index.md b/docs/google-docs/providers/google/osconfig/inventory/index.md new file mode 100644 index 0000000000..3c37758f55 --- /dev/null +++ b/docs/google-docs/providers/google/osconfig/inventory/index.md @@ -0,0 +1,30 @@ +--- +title: inventory +hide_title: false +hide_table_of_contents: false +keywords: + - inventory + - 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 + + + + +
Nameinventory
TypeResource
Idgoogle.osconfig.inventory
+ +## Methods +| Name | Accessible by | Required Params | +|:-----|:--------------|:----------------| +| `get` | `SELECT` | `instancesId, locationsId, projectsId` | diff --git a/docs/google-docs/providers/google/osconfig/operations/index.md b/docs/google-docs/providers/google/osconfig/operations/index.md index c679f422bf..6663e5eb28 100644 --- a/docs/google-docs/providers/google/osconfig/operations/index.md +++ b/docs/google-docs/providers/google/osconfig/operations/index.md @@ -24,6 +24,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png Idgoogle.osconfig.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, 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/osconfig/os_policy_assignments/index.md b/docs/google-docs/providers/google/osconfig/os_policy_assignments/index.md index fb6bba9e09..84da0e8d2f 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 | | `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | -| `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. | +| `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. | +| `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 | | `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. | | `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. | -| `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. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | | `deleted` | `boolean` | Output only. Indicates that this revision deletes the OS policy assignment. | +| `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 55f43abf23..0568dbf4fb 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. | | `rolloutState` | `string` | Output only. OS policy assignment rollout state | -| `osPolicies` | `array` | Required. List of OS policies to be applied to the VMs. | -| `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 | -| `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | -| `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. | | `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. | +| `revisionId` | `string` | Output only. The assignment revision ID A new revision is committed whenever a rollout is triggered for a 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. | +| `etag` | `string` | The etag for this OS policy assignment. If this is provided on update, it must match the server's etag. | +| `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. | +| `revisionCreateTime` | `string` | Output only. The timestamp that the revision was created. | +| `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. | +| `uid` | `string` | Output only. Server generated unique id for the OS policy assignment resource. | ## 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 a513a9e3bf..79e94fac24 100644 --- a/docs/google-docs/providers/google/osconfig/patch_deployments/index.md +++ b/docs/google-docs/providers/google/osconfig/patch_deployments/index.md @@ -29,15 +29,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. | +| `state` | `string` | Output only. Current state of the patch deployment. | | `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. | | `recurringSchedule` | `object` | Sets the time for recurring patch deployments. | +| `oneTimeSchedule` | `object` | Sets the time for a one time patch deployment. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | | `duration` | `string` | Optional. Duration of the patch. After the duration ends, the patch times out. | +| `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. | -| `oneTimeSchedule` | `object` | Sets the time for a one time patch deployment. 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. | | `rollout` | `object` | Patch rollout configuration specifications. Contains details on the concurrency control when applying patch(es) to all targeted VMs. | -| `updateTime` | `string` | Output only. Time the patch deployment was last updated. Timestamp is in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. | -| `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. | | `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | ## 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 0ad8919164..63d7b4ff0f 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. | -| `duration` | `string` | Duration of the patch job. After the duration ends, the patch job times out. | -| `errorMessage` | `string` | If this patch job failed, this message provides information about the failure. | -| `updateTime` | `string` | Last time this patch job was updated. | -| `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. | -| `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. | -| `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. | | `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. | +| `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. | -| `patchConfig` | `object` | Patch configuration specifications. Contains details on how to apply the patch(es) to a VM instance. | | `state` | `string` | The current state of the PatchJob. | -| `patchDeployment` | `string` | Output only. Name of the patch deployment that created this patch job. | +| `errorMessage` | `string` | If this patch job failed, this message provides information about the failure. | +| `duration` | `string` | Duration of the patch job. After the duration ends, the patch job times out. | +| `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. | +| `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. | +| `percentComplete` | `number` | Reflects the overall progress of the patch job in the range of 0.0 being no progress to 100.0 being complete. | | `displayName` | `string` | Display name for this patch job. This is not a unique identifier. | +| `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 2c7bd1735a..4d620519e2 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` | +| `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}` | | `osPolicyCompliances` | `array` | Compliance data for each `OSPolicy` that is applied to the VM. | -| `updateTime` | `string` | Timestamp for when the report was last generated. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/osconfig/reports/index.md b/docs/google-docs/providers/google/osconfig/reports/index.md index ff8ab56503..5077db47ad 100644 --- a/docs/google-docs/providers/google/osconfig/reports/index.md +++ b/docs/google-docs/providers/google/osconfig/reports/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` | -| `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}` | | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/osconfig/vulnerability_reports/index.md b/docs/google-docs/providers/google/osconfig/vulnerability_reports/index.md index 08f6ac784d..0475fcba34 100644 --- a/docs/google-docs/providers/google/osconfig/vulnerability_reports/index.md +++ b/docs/google-docs/providers/google/osconfig/vulnerability_reports/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/index.md b/docs/google-docs/providers/google/oslogin/index.md index 1d8bd6e83a..6f6d2eef7e 100644 --- a/docs/google-docs/providers/google/oslogin/index.md +++ b/docs/google-docs/providers/google/oslogin/index.md @@ -20,7 +20,7 @@ You Can Use OS Login To Manage Access To Your VM Instances Using IAM Roles.
total resources: 4
-total selectable resources: 1
+total selectable resources: 2
total methods: 7
@@ -33,7 +33,7 @@ You Can Use OS Login To Manage Access To Your VM Instances Using IAM Roles. TypeService TitleCloud OS Login API DescriptionYou Can Use OS Login To Manage Access To Your VM Instances Using IAM Roles. -Idoslogin:v23.08.00161 +Idoslogin:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/oslogin/users_login_profile/index.md b/docs/google-docs/providers/google/oslogin/users_login_profile/index.md index 4805244b29..dbf0ab8e9c 100644 --- a/docs/google-docs/providers/google/oslogin/users_login_profile/index.md +++ b/docs/google-docs/providers/google/oslogin/users_login_profile/index.md @@ -25,8 +25,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Required. A unique user ID. | +| `posixAccounts` | `array` | The list of POSIX accounts associated with the user. | +| `sshPublicKeys` | `object` | A map from SSH public key fingerprint to the associated key object. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `get_login_profile` | `EXEC` | `usersId` | +| `get_login_profile` | `SELECT` | `usersId` | diff --git a/docs/google-docs/providers/google/places/index.md b/docs/google-docs/providers/google/places/index.md index 8ce1644577..4c8c628c7a 100644 --- a/docs/google-docs/providers/google/places/index.md +++ b/docs/google-docs/providers/google/places/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePlaces API (New) Description -Idplaces:v23.08.00161 +Idplaces:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/policyanalyzer/index.md b/docs/google-docs/providers/google/policyanalyzer/index.md index 4222b95e67..7b48be55b5 100644 --- a/docs/google-docs/providers/google/policyanalyzer/index.md +++ b/docs/google-docs/providers/google/policyanalyzer/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePolicy Analyzer API Description -Idpolicyanalyzer:v23.08.00161 +Idpolicyanalyzer:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/policysimulator/index.md b/docs/google-docs/providers/google/policysimulator/index.md index 7f2eabc4e0..e9c940e2d8 100644 --- a/docs/google-docs/providers/google/policysimulator/index.md +++ b/docs/google-docs/providers/google/policysimulator/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePolicy Simulator API Description Policy Simulator Is A Collection Of Endpoints For Creating, Running, And Viewing A Replay. A `Replay` Is A Type Of Simulation That Lets You See How Your Members' Access To Resources Might Change If You Changed Your IAM Policy. During A `Replay`, Policy Simulator Re-Evaluates, Or Replays, Past Access Attempts Under Both The Current Policy And Your Proposed Policy, And Compares Those Results To Determine How Your Members' Access Might Change Under The Proposed Policy. -Idpolicysimulator:v23.08.00161 +Idpolicysimulator:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/policysimulator/operations/index.md b/docs/google-docs/providers/google/policysimulator/operations/index.md index d2b874e977..527cc4a956 100644 --- a/docs/google-docs/providers/google/policysimulator/operations/index.md +++ b/docs/google-docs/providers/google/policysimulator/operations/index.md @@ -28,22 +28,22 @@ 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. | +| `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 | |:-----|:--------------|:----------------|:------------| +| `folders_locations_replays_operations_get` | `SELECT` | `foldersId, locationsId, operationsId, replaysId` | 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. | | `folders_locations_replays_operations_list` | `SELECT` | `foldersId, locationsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `operations_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. | | `operations_list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `organizations_locations_replays_operations_get` | `SELECT` | `locationsId, operationsId, organizationsId, replaysId` | 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. | | `organizations_locations_replays_operations_list` | `SELECT` | `locationsId, organizationsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_replays_operations_get` | `SELECT` | `locationsId, operationsId, projectsId, replaysId` | 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. | | `projects_locations_replays_operations_list` | `SELECT` | `locationsId, projectsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_folders_locations_replays_operations_list` | `EXEC` | `foldersId, locationsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_operations_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_organizations_locations_replays_operations_list` | `EXEC` | `locationsId, organizationsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_replays_operations_list` | `EXEC` | `locationsId, projectsId, replaysId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `folders_locations_replays_operations_get` | `EXEC` | `foldersId, locationsId, operationsId, replaysId` | 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. | -| `operations_get` | `EXEC` | `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. | -| `organizations_locations_replays_operations_get` | `EXEC` | `locationsId, operationsId, organizationsId, replaysId` | 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. | -| `projects_locations_replays_operations_get` | `EXEC` | `locationsId, operationsId, projectsId, replaysId` | 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. | diff --git a/docs/google-docs/providers/google/policysimulator/replays/index.md b/docs/google-docs/providers/google/policysimulator/replays/index.md index dc902d678c..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` | +| `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. | -| `resultsSummary` | `object` | Summary statistics about the replayed log entries. | ## 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 fec66b5db9..0d13f8f229 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` | +| `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 | | `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/policytroubleshooter/index.md b/docs/google-docs/providers/google/policytroubleshooter/index.md index 7211681260..84f0bae5fe 100644 --- a/docs/google-docs/providers/google/policytroubleshooter/index.md +++ b/docs/google-docs/providers/google/policytroubleshooter/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePolicy Troubleshooter API Description -Idpolicytroubleshooter:v23.08.00161 +Idpolicytroubleshooter:v23.08.00163 ## Resources 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 6266667289..c5648ce636 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 a93aed6409..3e9de8eb4c 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/*`. | -| `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. | -| `state` | `string` | Output only. The State for this CertificateAuthority. | -| `createTime` | `string` | Output only. The time at which this CertificateAuthority was created. | -| `deleteTime` | `string` | Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. | +| `updateTime` | `string` | Output only. The time at which this CertificateAuthority was last updated. | | `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. | -| `accessUrls` | `object` | URLs where a CertificateAuthority will publish content. | -| `tier` | `string` | Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. | +| `expireTime` | `string` | Output only. The time at which this CertificateAuthority will be permanently purged, if it is in the DELETED state. | | `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. | -| `type` | `string` | Required. Immutable. The Type of this CertificateAuthority. | -| `updateTime` | `string` | Output only. The time at which this CertificateAuthority was last updated. | +| `tier` | `string` | Output only. The CaPool.Tier of the CaPool that includes this CertificateAuthority. | | `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. | -| `caCertificateDescriptions` | `array` | Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. | -| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `type` | `string` | Required. Immutable. The Type of this CertificateAuthority. | +| `state` | `string` | Output only. The State for this CertificateAuthority. | +| `accessUrls` | `object` | URLs where a CertificateAuthority will publish content. | +| `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. | +| `createTime` | `string` | Output only. The time at which this CertificateAuthority was created. | | `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. | +| `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. | +| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `caCertificateDescriptions` | `array` | Output only. A structured description of this CertificateAuthority's CA certificate and its issuers. Ordered as self-to-root. | +| `deleteTime` | `string` | Output only. The time at which this CertificateAuthority was soft deleted, if it is in the DELETED state. | ## 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 51c5d98127..a161478ce8 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/*`. | +| `pemCrl` | `string` | Output only. The PEM-encoded X.509 CRL. | | `updateTime` | `string` | Output only. The time at which this CertificateRevocationList was updated. | -| `labels` | `object` | Optional. Labels with user-defined metadata. | +| `revokedCertificates` | `array` | Output only. The revoked serial numbers that appear in pem_crl. | | `accessUrl` | `string` | Output only. The location where 'pem_crl' can be accessed. | -| `state` | `string` | Output only. The State for this CertificateRevocationList. | -| `createTime` | `string` | Output only. The time at which this CertificateRevocationList was created. | -| `pemCrl` | `string` | Output only. The PEM-encoded X.509 CRL. | | `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. | | `sequenceNumber` | `string` | Output only. The CRL sequence number that appears in pem_crl. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | +| `state` | `string` | Output only. The State for this CertificateRevocationList. | +| `createTime` | `string` | Output only. The time at which this CertificateRevocationList was created. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 271553e8be..953de7d85f 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 3f6adaffc8..ab8071f4de 100644 --- a/docs/google-docs/providers/google/privateca/certificates/index.md +++ b/docs/google-docs/providers/google/privateca/certificates/index.md @@ -28,19 +28,19 @@ 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/*`. | -| `issuerCertificateAuthority` | `string` | Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. | | `pemCsr` | `string` | Immutable. A pem-encoded X.509 certificate signing request (CSR). | -| `labels` | `object` | Optional. Labels with user-defined metadata. | -| `certificateDescription` | `object` | A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. | -| `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. | -| `createTime` | `string` | Output only. The time at which this Certificate was created. | +| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `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. | +| `updateTime` | `string` | Output only. The time at which this Certificate was updated. | | `revocationDetails` | `object` | Describes fields that are relavent to the revocation of a Certificate. | | `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. | -| `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. | -| `updateTime` | `string` | Output only. The time at which this Certificate was updated. | +| `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. | +| `issuerCertificateAuthority` | `string` | Output only. The resource name of the issuing CertificateAuthority in the format `projects/*/locations/*/caPools/*/certificateAuthorities/*`. | | `pemCertificate` | `string` | Output only. The pem-encoded, signed X.509 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. | -| `config` | `object` | A CertificateConfig describes an X.509 certificate or CSR that is to be created, as an alternative to using ASN.1. | +| `createTime` | `string` | Output only. The time at which this Certificate was created. | +| `certificateDescription` | `object` | A CertificateDescription describes an X.509 certificate or CSR that has been issued, as an alternative to using ASN.1 / X.509. | +| `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. | +| `labels` | `object` | Optional. Labels with user-defined metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/privateca/index.md b/docs/google-docs/providers/google/privateca/index.md index 30f64bfe56..aa2c56926a 100644 --- a/docs/google-docs/providers/google/privateca/index.md +++ b/docs/google-docs/providers/google/privateca/index.md @@ -33,7 +33,7 @@ The Certificate Authority Service API Is A Highly-Available, Scalable Service Th TypeService TitleCertificate Authority API DescriptionThe Certificate Authority Service API Is A Highly-Available, Scalable Service That Enables You To Simplify And Automate The Management Of Private Certificate Authorities (CAs) While Staying In Control Of Your Private Keys. -Idprivateca:v23.08.00161 +Idprivateca:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/privateca/locations/index.md b/docs/google-docs/providers/google/privateca/locations/index.md index abb41313d4..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"` | -| `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/privateca/operations/index.md b/docs/google-docs/providers/google/privateca/operations/index.md index ad8ef75123..da7419558c 100644 --- a/docs/google-docs/providers/google/privateca/operations/index.md +++ b/docs/google-docs/providers/google/privateca/operations/index.md @@ -28,7 +28,7 @@ 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`. | +| `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. | diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/customer_nodes/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/customer_nodes/index.md index d76969ac78..257c4034c2 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/customer_nodes/index.md +++ b/docs/google-docs/providers/google/prod_tt_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. | -| `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 | 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 60ce889eca..e36637386d 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 @@ -40,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `customers_migrate_organization` | `EXEC` | | Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration | | `customers_patch` | `EXEC` | `customersId` | Updates an existing customer. | | `customers_provision_deployment` | `EXEC` | | Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found. | +| `customers_setup_sas_analytics` | `EXEC` | | Setups the a GCP Project to receive SAS Analytics messages via GCP Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and BigQuery tables are created automatically as part of this service. | 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 e3e4c21338..ad25bfc687 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,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The resource path name. | -| `currentChannels` | `array` | Output only. Current channels with scores. | +| `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | +| `state` | `string` | Output only. Device state. | | `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | +| `currentChannels` | `array` | Output only. Current channels with scores. | +| `activeConfig` | `object` | Information about the device configuration. | | `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | -| `preloadedConfig` | `object` | Information about the device configuration. | -| `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. | -| `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | +| `preloadedConfig` | `object` | Information about the device configuration. | | `grants` | `array` | Output only. Grants held by the device. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/prod_tt_sasportal/index.md b/docs/google-docs/providers/google/prod_tt_sasportal/index.md index 95ccbce5e6..c956830946 100644 --- a/docs/google-docs/providers/google/prod_tt_sasportal/index.md +++ b/docs/google-docs/providers/google/prod_tt_sasportal/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 10
total selectable resources: 7
-total methods: 95
+total methods: 96
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleSAS Portal API (Testing) Description -Idprod_tt_sasportal:v23.08.00161 +Idprod_tt_sasportal:v23.08.00163 ## Resources 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 040da1850d..eb87aefbc7 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. | -| `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/publicca/index.md b/docs/google-docs/providers/google/publicca/index.md index b7528eb47f..08e659391f 100644 --- a/docs/google-docs/providers/google/publicca/index.md +++ b/docs/google-docs/providers/google/publicca/index.md @@ -33,7 +33,7 @@ The Public Certificate Authority API May Be Used To Create And Manage ACME Exter TypeService TitlePublic Certificate Authority API DescriptionThe Public Certificate Authority API May Be Used To Create And Manage ACME External Account Binding Keys Associated With Google Trust Services' Publicly Trusted Certificate Authority. -Idpublicca:v23.08.00161 +Idpublicca:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/pubsub/index.md b/docs/google-docs/providers/google/pubsub/index.md index 2cc669e598..26715885ec 100644 --- a/docs/google-docs/providers/google/pubsub/index.md +++ b/docs/google-docs/providers/google/pubsub/index.md @@ -33,7 +33,7 @@ Provides Reliable, Many-To-Many, Asynchronous Messaging Between Applications. TypeService TitleCloud Pub/Sub API DescriptionProvides Reliable, Many-To-Many, Asynchronous Messaging Between Applications. -Idpubsub:v23.08.00161 +Idpubsub:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/pubsub/schemas/index.md b/docs/google-docs/providers/google/pubsub/schemas/index.md index 9d4ecce0c3..c9f6c75f20 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}`. | +| `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. | | `revisionId` | `string` | Output only. Immutable. The revision ID of the schema. | -| `type` | `string` | The type of the schema definition. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 5c970337a0..7080a5378e 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 | |:-----|:---------|:------------| -| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | 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 365de5ca38..bba0475ab1 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}`. | +| `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. | -| `revisionId` | `string` | Output only. Immutable. The revision ID of the schema. | ## 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 3c65cca2bc..be558961ff 100644 --- a/docs/google-docs/providers/google/pubsub/snapshots/index.md +++ b/docs/google-docs/providers/google/pubsub/snapshots/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Optional. The name of the snapshot. | +| `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. | -| `labels` | `object` | Optional. See [Creating and managing labels] (https://cloud.google.com/pubsub/docs/labels). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_snapshots_get` | `SELECT` | `projectsId, snapshotsId` | Gets the configuration details of a snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_snapshots_list` | `SELECT` | `projectsId` | Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_topics_snapshots_list` | `SELECT` | `projectsId, topicsId` | Lists the names of the snapshots on this topic. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_snapshots_delete` | `DELETE` | `projectsId, snapshotsId` | Removes an existing snapshot. Snapshots are used in [Seek] (https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. When the snapshot is deleted, all messages retained in the snapshot are immediately dropped. After a snapshot is deleted, a new one may be created with the same name, but the new one has no association with the old snapshot or its subscription, unless the same subscription is specified. | | `_projects_snapshots_list` | `EXEC` | `projectsId` | Lists the existing snapshots. Snapshots are used in [Seek]( https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `_projects_topics_snapshots_list` | `EXEC` | `projectsId, topicsId` | Lists the names of the snapshots on this topic. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_snapshots_create` | `EXEC` | `projectsId, snapshotsId` | Creates a snapshot from the requested subscription. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. If the snapshot already exists, returns `ALREADY_EXISTS`. If the requested subscription doesn't exist, returns `NOT_FOUND`. If the backlog in the subscription is too old -- and the resulting snapshot would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned. See also the `Snapshot.expire_time` field. If the name is not provided in the request, the server will assign a random name for this snapshot on the same project as the subscription, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Snapshot object. Note that for REST API requests, you must specify a name in the request. | -| `projects_snapshots_get` | `EXEC` | `projectsId, snapshotsId` | Gets the configuration details of a snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | | `projects_snapshots_patch` | `EXEC` | `projectsId, snapshotsId` | Updates an existing snapshot. Snapshots are used in [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations, which allow you to manage message acknowledgments in bulk. That is, you can set the acknowledgment state of messages in an existing subscription to the state captured by a snapshot. | 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 900398bb3a..43c2c309da 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsub/subscriptions/index.md b/docs/google-docs/providers/google/pubsub/subscriptions/index.md index 94163b1e98..8d6b296dac 100644 --- a/docs/google-docs/providers/google/pubsub/subscriptions/index.md +++ b/docs/google-docs/providers/google/pubsub/subscriptions/index.md @@ -28,26 +28,27 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. The name of the subscription. It must have the format `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` 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"`. | -| `state` | `string` | Output only. An output-only field indicating whether or not the subscription can receive messages. | -| `bigqueryConfig` | `object` | Configuration for a BigQuery subscription. | -| `expirationPolicy` | `object` | A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion). | -| `retryPolicy` | `object` | A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. | -| `detached` | `boolean` | Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. | -| `pushConfig` | `object` | Configuration for a push delivery endpoint. | -| `topicMessageRetentionDuration` | `string` | Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. | -| `retainAckedMessages` | `boolean` | Optional. Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages. | | `enableExactlyOnceDelivery` | `boolean` | Optional. If true, Pub/Sub provides the following guarantees for the delivery of a message with a given value of `message_id` on this subscription: * The message sent to a subscriber is guaranteed not to be resent before the message's acknowledgement deadline expires. * An acknowledged message will not be resent to a subscriber. Note that subscribers may still receive multiple copies of a message when `enable_exactly_once_delivery` is true if the message was published multiple times by a publisher client. These copies are considered distinct by Pub/Sub and have distinct `message_id` values. | -| `deadLetterPolicy` | `object` | Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail. | -| `enableMessageOrdering` | `boolean` | Optional. If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. | +| `detached` | `boolean` | Optional. Indicates whether the subscription is detached from its topic. Detached subscriptions don't receive messages from their topic and don't retain any backlog. `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will not be made. | | `messageRetentionDuration` | `string` | Optional. How long to retain unacknowledged messages in the subscription's backlog, from the moment a message is published. If `retain_acked_messages` is true, then this also configures the retention of acknowledged messages, and thus configures how far back in time a `Seek` can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10 minutes. | -| `cloudStorageConfig` | `object` | Configuration for a Cloud Storage subscription. | +| `enableMessageOrdering` | `boolean` | Optional. If true, messages published with the same `ordering_key` in `PubsubMessage` will be delivered to the subscribers in the order in which they are received by the Pub/Sub system. Otherwise, they may be delivered in any order. | +| `retainAckedMessages` | `boolean` | Optional. Indicates whether to retain acknowledged messages. If true, then messages are not expunged from the subscription's backlog, even if they are acknowledged, until they fall out of the `message_retention_duration` window. This must be true if you would like to [`Seek` to a timestamp] (https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time) in the past to replay previously-acknowledged messages. | | `filter` | `string` | Optional. An expression written in the Pub/Sub [filter language](https://cloud.google.com/pubsub/docs/filtering). If non-empty, then only `PubsubMessage`s whose `attributes` field matches the filter are delivered on this subscription. If empty, then no messages are filtered out. | +| `topicMessageRetentionDuration` | `string` | Output only. Indicates the minimum duration for which a message is retained after it is published to the subscription's topic. If this field is set, messages published to the subscription's topic in the last `topic_message_retention_duration` are always available to subscribers. See the `message_retention_duration` field in `Topic`. This field is set only in responses from the server; it is ignored if it is set in any requests. | +| `bigqueryConfig` | `object` | Configuration for a BigQuery subscription. | +| `expirationPolicy` | `object` | A policy that specifies the conditions for resource expiration (i.e., automatic resource deletion). | +| `deadLetterPolicy` | `object` | Dead lettering is done on a best effort basis. The same message might be dead lettered multiple times. If validation on any of the fields fails at subscription creation/updation, the create/update subscription request will fail. | | `labels` | `object` | Optional. See [Creating and managing labels](https://cloud.google.com/pubsub/docs/labels). | | `topic` | `string` | Required. The name of the topic from which this subscription is receiving messages. Format is `projects/{project}/topics/{topic}`. The value of this field will be `_deleted-topic_` if the topic has been deleted. | +| `pushConfig` | `object` | Configuration for a push delivery endpoint. | +| `retryPolicy` | `object` | A policy that specifies how Pub/Sub retries message delivery. Retry delay will be exponential based on provided minimum and maximum backoffs. https://en.wikipedia.org/wiki/Exponential_backoff. RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded events for a given message. Retry Policy is implemented on a best effort basis. At times, the delay between consecutive deliveries may not match the configuration. That is, delay can be more or less than configured backoff. | | `ackDeadlineSeconds` | `integer` | Optional. The approximate amount of time (on a best-effort basis) Pub/Sub waits for the subscriber to acknowledge receipt before resending the message. In the interval after the message is delivered and before it is acknowledged, it is considered to be _outstanding_. During that time period, the message will not be redelivered (on a best-effort basis). For pull subscriptions, this value is used as the initial value for the ack deadline. To override this value for a given message, call `ModifyAckDeadline` with the corresponding `ack_id` if using non-streaming pull or send the `ack_id` in a `StreamingModifyAckDeadlineRequest` if using streaming pull. The minimum custom deadline you can specify is 10 seconds. The maximum custom deadline you can specify is 600 seconds (10 minutes). If this parameter is 0, a default value of 10 seconds is used. For push delivery, this value is also used to set the request timeout for the call to the push endpoint. If the subscriber never acknowledges the message, the Pub/Sub system will eventually redeliver the message. | +| `cloudStorageConfig` | `object` | Configuration for a Cloud Storage subscription. | +| `state` | `string` | Output only. An output-only field indicating whether or not the subscription can receive messages. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_subscriptions_get` | `SELECT` | `projectsId, subscriptionsId` | Gets the configuration details of a subscription. | | `projects_subscriptions_list` | `SELECT` | `projectsId` | Lists matching subscriptions. | | `projects_topics_subscriptions_list` | `SELECT` | `projectsId, topicsId` | Lists the names of the attached subscriptions on this topic. | | `projects_subscriptions_delete` | `DELETE` | `projectsId, subscriptionsId` | Deletes an existing subscription. All messages retained in the subscription are immediately dropped. Calls to `Pull` after deletion will return `NOT_FOUND`. After a subscription is deleted, a new one may be created with the same name, but the new one has no association with the old subscription or its topic unless the same topic is specified. | @@ -56,7 +57,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_subscriptions_acknowledge` | `EXEC` | `projectsId, subscriptionsId` | Acknowledges the messages associated with the `ack_ids` in the `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages from the subscription. Acknowledging a message whose ack deadline has expired may succeed, but such a message may be redelivered later. Acknowledging a message more than once will not result in an error. | | `projects_subscriptions_create` | `EXEC` | `projectsId, subscriptionsId` | Creates a subscription to a given topic. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). If the subscription already exists, returns `ALREADY_EXISTS`. If the corresponding topic doesn't exist, returns `NOT_FOUND`. If the name is not provided in the request, the server will assign a random name for this subscription on the same project as the topic, conforming to the [resource name format] (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated name is populated in the returned Subscription object. Note that for REST API requests, you must specify a name in the request. | | `projects_subscriptions_detach` | `EXEC` | `projectsId, subscriptionsId` | Detaches a subscription from this topic. All messages retained in the subscription are dropped. Subsequent `Pull` and `StreamingPull` requests will return FAILED_PRECONDITION. If the subscription is a push subscription, pushes to the endpoint will stop. | -| `projects_subscriptions_get` | `EXEC` | `projectsId, subscriptionsId` | Gets the configuration details of a subscription. | | `projects_subscriptions_modify_ack_deadline` | `EXEC` | `projectsId, subscriptionsId` | Modifies the ack deadline for a specific message. This method is useful to indicate that more time is needed to process a message by the subscriber, or to make the message available for redelivery if the processing was interrupted. Note that this does not modify the subscription-level `ackDeadlineSeconds` used for subsequent messages. | | `projects_subscriptions_modify_push_config` | `EXEC` | `projectsId, subscriptionsId` | Modifies the `PushConfig` for a specified subscription. This may be used to change a push subscription to a pull one (signified by an empty `PushConfig`) or vice versa, or change the endpoint URL and other attributes of a push subscription. Messages will accumulate for delivery continuously through the call regardless of changes to the `PushConfig`. | | `projects_subscriptions_patch` | `EXEC` | `projectsId, subscriptionsId` | Updates an existing subscription. Note that certain properties of a subscription, such as its topic, are not modifiable. | 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 25b932031d..0ed872a330 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## 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 4ce4a69c25..4319e2fad7 100644 --- a/docs/google-docs/providers/google/pubsub/topics/index.md +++ b/docs/google-docs/providers/google/pubsub/topics/index.md @@ -37,10 +37,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_topics_get` | `SELECT` | `projectsId, topicsId` | Gets the configuration of a topic. | | `projects_topics_list` | `SELECT` | `projectsId` | Lists matching topics. | | `projects_topics_delete` | `DELETE` | `projectsId, topicsId` | Deletes the topic with the given name. Returns `NOT_FOUND` if the topic does not exist. After a topic is deleted, a new topic may be created with the same name; this is an entirely new topic with none of the old configuration or subscriptions. Existing subscriptions to this topic are not deleted, but their `topic` field is set to `_deleted-topic_`. | | `_projects_topics_list` | `EXEC` | `projectsId` | Lists matching topics. | | `projects_topics_create` | `EXEC` | `projectsId, topicsId` | Creates the given topic with the given name. See the [resource name rules] (https://cloud.google.com/pubsub/docs/admin#resource_names). | -| `projects_topics_get` | `EXEC` | `projectsId, topicsId` | Gets the configuration of a topic. | | `projects_topics_patch` | `EXEC` | `projectsId, topicsId` | Updates an existing topic. Note that certain properties of a topic are not modifiable. | | `projects_topics_publish` | `EXEC` | `projectsId, topicsId` | Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic does not exist. | diff --git a/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md b/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md index 48f3d6cb37..e37f16e0c4 100644 --- a/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md +++ b/docs/google-docs/providers/google/pubsub/topics_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/pubsublite/index.md b/docs/google-docs/providers/google/pubsublite/index.md index 2821fc4740..a7f10297f5 100644 --- a/docs/google-docs/providers/google/pubsublite/index.md +++ b/docs/google-docs/providers/google/pubsublite/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitlePub/Sub Lite API Description -Idpubsublite:v23.08.00161 +Idpubsublite:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/pubsublite/operations/index.md b/docs/google-docs/providers/google/pubsublite/operations/index.md index c91571917a..779cb4c88d 100644 --- a/docs/google-docs/providers/google/pubsublite/operations/index.md +++ b/docs/google-docs/providers/google/pubsublite/operations/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, 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 | |:-----|:--------------|:----------------|:------------| +| `admin_projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `admin_projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `admin_projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_admin_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `admin_projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `admin_projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/pubsublite/subscriptions/index.md b/docs/google-docs/providers/google/pubsublite/subscriptions/index.md index c66eb3db6f..b6694bec59 100644 --- a/docs/google-docs/providers/google/pubsublite/subscriptions/index.md +++ b/docs/google-docs/providers/google/pubsublite/subscriptions/index.md @@ -25,12 +25,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -| Name | Datatype | Description | -|:-----|:---------|:------------| -| `name` | `string` | The name of the subscription. Structured like: projects/{project_number}/locations/{location}/subscriptions/{subscription_id} | -| `deliveryConfig` | `object` | The settings for a subscription's message delivery. | -| `exportConfig` | `object` | Configuration for a Pub/Sub Lite subscription that writes messages to a destination. User subscriber clients must not connect to this subscription. | -| `topic` | `string` | The name of the topic this subscription is attached to. Structured like: projects/{project_number}/locations/{location}/topics/{topic_id} | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md b/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md index a54fdf1ba1..5209fa8350 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/firewallpolicies/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | The resource name for the FirewallPolicy in the format "projects/{project}/firewallpolicies/{firewallpolicy}". | | `description` | `string` | A description of what this policy aims to achieve, for convenience purposes. The description can at most include 256 UTF-8 characters. | +| `path` | `string` | The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters. | | `actions` | `array` | The actions that the caller should take regarding user access. There should be at most one terminal action. A terminal action is any action that forces a response, such as AllowAction, BlockAction or SubstituteAction. Zero or more non-terminal actions such as SetHeader might be specified. A single policy can contain up to 16 actions. | | `condition` | `string` | A CEL (Common Expression Language) conditional expression that specifies if this policy applies to an incoming user request. If this condition evaluates to true and the requested path matched the path pattern, the associated actions should be executed by the caller. The condition string is checked for CEL syntax correctness on creation. For more information, see the [CEL spec](https://github.com/google/cel-spec) and its [language definition](https://github.com/google/cel-spec/blob/master/doc/langdef.md). A condition has a max length of 500 characters. | -| `path` | `string` | The path for which this policy applies, specified as a glob pattern. For more information on glob, see the [manual page](https://man7.org/linux/man-pages/man7/glob.7.html). A path has a max length of 200 characters. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recaptchaenterprise/index.md b/docs/google-docs/providers/google/recaptchaenterprise/index.md index cd6f8b5fa5..87da22a50a 100644 --- a/docs/google-docs/providers/google/recaptchaenterprise/index.md +++ b/docs/google-docs/providers/google/recaptchaenterprise/index.md @@ -33,7 +33,7 @@ Help Protect Your Website From Fraudulent Activity, Spam, And Abuse Without Crea TypeService TitleReCAPTCHA Enterprise API DescriptionHelp Protect Your Website From Fraudulent Activity, Spam, And Abuse Without Creating Friction. -Idrecaptchaenterprise:v23.08.00161 +Idrecaptchaenterprise:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md b/docs/google-docs/providers/google/recaptchaenterprise/keys/index.md index 2e573958f4..dd43cc20c1 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}". | -| `testingOptions` | `object` | Options for user acceptance testing. | -| `wafSettings` | `object` | Settings specific to keys that can be used for WAF (Web Application Firewall). | -| `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. | -| `displayName` | `string` | Human-readable display name of this key. Modifiable by user. | | `labels` | `object` | See Creating and managing labels. | +| `webSettings` | `object` | Settings specific to keys that can be used by websites. | +| `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. | | `createTime` | `string` | Output only. The timestamp corresponding to the creation of this key. | +| `displayName` | `string` | Human-readable display name of this key. Modifiable by user. | ## 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 9da6a370b4..50247d51e3 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". | -| `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. | | `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. | ## 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 4d8b870c0e..e21adf78a4 100644 --- a/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md +++ b/docs/google-docs/providers/google/recommendationengine/catalog_items/index.md @@ -29,13 +29,13 @@ 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. | -| `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. | -| `itemAttributes` | `object` | FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features. | -| `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. | | `title` | `string` | Required. Catalog item title. UTF-8 encoded string with a length limit of 1 KiB. | +| `itemAttributes` | `object` | FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features. | | `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"] } ] | +| `productMetadata` | `object` | ProductCatalogItem captures item metadata specific to retail products. | | `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). | +| `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 | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommendationengine/catalogs/index.md b/docs/google-docs/providers/google/recommendationengine/catalogs/index.md index 75c298a991..b67720de54 100644 --- a/docs/google-docs/providers/google/recommendationengine/catalogs/index.md +++ b/docs/google-docs/providers/google/recommendationengine/catalogs/index.md @@ -28,9 +28,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The fully qualified resource name of the catalog. | -| `catalogItemLevelConfig` | `object` | Configures the catalog level that users send events to, and the level at which predictions are made. | | `defaultEventStoreId` | `string` | Required. The ID of the default event store. | | `displayName` | `string` | Required. The catalog display name. | +| `catalogItemLevelConfig` | `object` | Configures the catalog level that users send events to, and the level at which predictions are made. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommendationengine/index.md b/docs/google-docs/providers/google/recommendationengine/index.md index 54039bb2e7..9356e8a13c 100644 --- a/docs/google-docs/providers/google/recommendationengine/index.md +++ b/docs/google-docs/providers/google/recommendationengine/index.md @@ -33,7 +33,7 @@ Note That We Now Highly Recommend New Customers To Use Retail API, Which Incorpo TypeService TitleRecommendations AI (Beta) DescriptionNote That We Now Highly Recommend New Customers To Use Retail API, Which Incorporates The GA Version Of The Recommendations AI Funtionalities. To Enable Retail API, Please Visit Https://Console.Cloud.Google.Com/Apis/Library/Retail.Googleapis.Com. The Recommendations AI Service Enables Customers To Build End-To-End Personalized Recommendation Systems Without Requiring A High Level Of Expertise In Machine Learning, Recommendation System, Or Google Cloud. -Idrecommendationengine:v23.08.00161 +Idrecommendationengine:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/recommendationengine/operations/index.md b/docs/google-docs/providers/google/recommendationengine/operations/index.md index 3073f6fa79..fd43403e3a 100644 --- a/docs/google-docs/providers/google/recommendationengine/operations/index.md +++ b/docs/google-docs/providers/google/recommendationengine/operations/index.md @@ -28,16 +28,16 @@ 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 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_catalogs_event_stores_operations_get` | `SELECT` | `catalogsId, eventStoresId, locationsId, 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. | | `projects_locations_catalogs_event_stores_operations_list` | `SELECT` | `catalogsId, eventStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_catalogs_operations_get` | `SELECT` | `catalogsId, locationsId, 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. | | `projects_locations_catalogs_operations_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_catalogs_event_stores_operations_list` | `EXEC` | `catalogsId, eventStoresId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_catalogs_operations_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `projects_locations_catalogs_event_stores_operations_get` | `EXEC` | `catalogsId, eventStoresId, locationsId, 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. | -| `projects_locations_catalogs_operations_get` | `EXEC` | `catalogsId, locationsId, 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. | 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 cd1f8b5f60..1a98a04ea0 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 | |:-----|:---------|:------------| +| `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. | -| `userInfo` | `object` | Information of end users. | -| `eventDetail` | `object` | User event details shared by all recommendation types. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommender/index.md b/docs/google-docs/providers/google/recommender/index.md index 2bcb5fa6ca..284451c9d3 100644 --- a/docs/google-docs/providers/google/recommender/index.md +++ b/docs/google-docs/providers/google/recommender/index.md @@ -20,7 +20,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 4
-total selectable resources: 2
+total selectable resources: 4
total methods: 56
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleRecommender API Description -Idrecommender:v23.08.00161 +Idrecommender:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/recommender/insight_types_config/index.md b/docs/google-docs/providers/google/recommender/insight_types_config/index.md index c61230b62d..8125dd7593 100644 --- a/docs/google-docs/providers/google/recommender/insight_types_config/index.md +++ b/docs/google-docs/providers/google/recommender/insight_types_config/index.md @@ -25,13 +25,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Name of insight type config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/insightTypes/[INSIGHT_TYPE_ID]/config | +| `etag` | `string` | Fingerprint of the InsightTypeConfig. Provides optimistic locking when updating. | +| `insightTypeGenerationConfig` | `object` | A configuration to customize the generation of insights. Eg, customizing the lookback period considered when generating a insight. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string. | +| `updateTime` | `string` | Last time when the config was updated. | +| `annotations` | `object` | Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. 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. | +| `displayName` | `string` | A user-settable field to provide a human-readable name to be used in user interfaces. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `billing_accounts_locations_insight_types_get_config` | `EXEC` | `billingAccountsId, insightTypesId, locationsId` | Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType. | +| `billing_accounts_locations_insight_types_get_config` | `SELECT` | `billingAccountsId, insightTypesId, locationsId` | Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType. | +| `organizations_locations_insight_types_get_config` | `SELECT` | `insightTypesId, locationsId, organizationsId` | Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType. | +| `projects_locations_insight_types_get_config` | `SELECT` | `insightTypesId, locationsId, projectsId` | Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType. | | `billing_accounts_locations_insight_types_update_config` | `EXEC` | `billingAccountsId, insightTypesId, locationsId` | Updates an InsightTypeConfig change. This will create a new revision of the config. | -| `organizations_locations_insight_types_get_config` | `EXEC` | `insightTypesId, locationsId, organizationsId` | Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType. | | `organizations_locations_insight_types_update_config` | `EXEC` | `insightTypesId, locationsId, organizationsId` | Updates an InsightTypeConfig change. This will create a new revision of the config. | -| `projects_locations_insight_types_get_config` | `EXEC` | `insightTypesId, locationsId, projectsId` | Gets the requested InsightTypeConfig. There is only one instance of the config for each InsightType. | | `projects_locations_insight_types_update_config` | `EXEC` | `insightTypesId, locationsId, projectsId` | Updates an InsightTypeConfig change. This will create a new revision of the config. | diff --git a/docs/google-docs/providers/google/recommender/insights/index.md b/docs/google-docs/providers/google/recommender/insights/index.md index 7ec70799b9..b2d29c3268 100644 --- a/docs/google-docs/providers/google/recommender/insights/index.md +++ b/docs/google-docs/providers/google/recommender/insights/index.md @@ -29,32 +29,32 @@ 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. | -| `associatedRecommendations` | `array` | Recommendations derived from this insight. | +| `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). | | `lastRefreshTime` | `string` | Timestamp of the latest data used to generate the insight. | +| `associatedRecommendations` | `array` | Recommendations derived from this insight. | +| `content` | `object` | A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000" | +| `stateInfo` | `object` | Information related to insight state. | | `category` | `string` | Category being targeted by the insight. | -| `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). | +| `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. | | `severity` | `string` | Insight's severity. | -| `stateInfo` | `object` | Information related to insight state. | -| `content` | `object` | A struct of custom fields to explain the insight. Example: "grantedPermissionsCount": "1000" | -| `etag` | `string` | Fingerprint of the Insight. Provides optimistic locking when updating states. | +| `insightSubtype` | `string` | Insight subtype. Insight content schema will be stable for a given subtype. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `billing_accounts_locations_insight_types_insights_get` | `SELECT` | `billingAccountsId, insightTypesId, insightsId, locationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `billing_accounts_locations_insight_types_insights_list` | `SELECT` | `billingAccountsId, insightTypesId, locationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | +| `folders_locations_insight_types_insights_get` | `SELECT` | `foldersId, insightTypesId, insightsId, locationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `folders_locations_insight_types_insights_list` | `SELECT` | `foldersId, insightTypesId, locationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | +| `organizations_locations_insight_types_insights_get` | `SELECT` | `insightTypesId, insightsId, locationsId, organizationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `organizations_locations_insight_types_insights_list` | `SELECT` | `insightTypesId, locationsId, organizationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | +| `projects_locations_insight_types_insights_get` | `SELECT` | `insightTypesId, insightsId, locationsId, projectsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `projects_locations_insight_types_insights_list` | `SELECT` | `insightTypesId, locationsId, projectsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | | `_billing_accounts_locations_insight_types_insights_list` | `EXEC` | `billingAccountsId, insightTypesId, locationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | | `_folders_locations_insight_types_insights_list` | `EXEC` | `foldersId, insightTypesId, locationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | | `_organizations_locations_insight_types_insights_list` | `EXEC` | `insightTypesId, locationsId, organizationsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | | `_projects_locations_insight_types_insights_list` | `EXEC` | `insightTypesId, locationsId, projectsId` | Lists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. | -| `billing_accounts_locations_insight_types_insights_get` | `EXEC` | `billingAccountsId, insightTypesId, insightsId, locationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `billing_accounts_locations_insight_types_insights_mark_accepted` | `EXEC` | `billingAccountsId, insightTypesId, insightsId, locationsId` | Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. | -| `folders_locations_insight_types_insights_get` | `EXEC` | `foldersId, insightTypesId, insightsId, locationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `folders_locations_insight_types_insights_mark_accepted` | `EXEC` | `foldersId, insightTypesId, insightsId, locationsId` | Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. | -| `organizations_locations_insight_types_insights_get` | `EXEC` | `insightTypesId, insightsId, locationsId, organizationsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `organizations_locations_insight_types_insights_mark_accepted` | `EXEC` | `insightTypesId, insightsId, locationsId, organizationsId` | Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. | -| `projects_locations_insight_types_insights_get` | `EXEC` | `insightTypesId, insightsId, locationsId, projectsId` | Gets the requested insight. Requires the recommender.*.get IAM permission for the specified insight type. | | `projects_locations_insight_types_insights_mark_accepted` | `EXEC` | `insightTypesId, insightsId, locationsId, projectsId` | Marks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight. This stops the insight content from being updated. MarkInsightAccepted can be applied to insights in ACTIVE state. Requires the recommender.*.update IAM permission for the specified insight. | diff --git a/docs/google-docs/providers/google/recommender/recommendations/index.md b/docs/google-docs/providers/google/recommender/recommendations/index.md index 3ce6e0f1e3..67aa21d4eb 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. | -| `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. | -| `primaryImpact` | `object` | Contains the impact a recommendation can have for a given category. | -| `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. | -| `content` | `object` | Contains what resources are changing and how they are changing. | +| `priority` | `string` | Recommendation's priority. | +| `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. | -| `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" | +| `primaryImpact` | `object` | Contains the impact a recommendation can have for a given category. | | `etag` | `string` | Fingerprint of the Recommendation. Provides optimistic locking when updating states. | -| `associatedInsights` | `array` | Insights that led to this recommendation. | -| `priority` | `string` | Recommendation's priority. | +| `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. | +| `stateInfo` | `object` | Information for state. Contains state and metadata. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/recommender/recommenders_config/index.md b/docs/google-docs/providers/google/recommender/recommenders_config/index.md index af26f3e570..c73e3ee814 100644 --- a/docs/google-docs/providers/google/recommender/recommenders_config/index.md +++ b/docs/google-docs/providers/google/recommender/recommenders_config/index.md @@ -25,13 +25,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Name of recommender config. Eg, projects/[PROJECT_NUMBER]/locations/[LOCATION]/recommenders/[RECOMMENDER_ID]/config | +| `updateTime` | `string` | Last time when the config was updated. | +| `annotations` | `object` | Allows clients to store small amounts of arbitrary data. Annotations must follow the Kubernetes syntax. 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. | +| `displayName` | `string` | A user-settable field to provide a human-readable name to be used in user interfaces. | +| `etag` | `string` | Fingerprint of the RecommenderConfig. Provides optimistic locking when updating. | +| `recommenderGenerationConfig` | `object` | A Configuration to customize the generation of recommendations. Eg, customizing the lookback period considered when generating a recommendation. | +| `revisionId` | `string` | Output only. Immutable. The revision ID of the config. A new revision is committed whenever the config is changed in any way. The format is an 8-character hexadecimal string. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `billing_accounts_locations_recommenders_get_config` | `EXEC` | `billingAccountsId, locationsId, recommendersId` | Gets the requested Recommender Config. There is only one instance of the config for each Recommender. | +| `billing_accounts_locations_recommenders_get_config` | `SELECT` | `billingAccountsId, locationsId, recommendersId` | Gets the requested Recommender Config. There is only one instance of the config for each Recommender. | +| `organizations_locations_recommenders_get_config` | `SELECT` | `locationsId, organizationsId, recommendersId` | Gets the requested Recommender Config. There is only one instance of the config for each Recommender. | +| `projects_locations_recommenders_get_config` | `SELECT` | `locationsId, projectsId, recommendersId` | Gets the requested Recommender Config. There is only one instance of the config for each Recommender. | | `billing_accounts_locations_recommenders_update_config` | `EXEC` | `billingAccountsId, locationsId, recommendersId` | Updates a Recommender Config. This will create a new revision of the config. | -| `organizations_locations_recommenders_get_config` | `EXEC` | `locationsId, organizationsId, recommendersId` | Gets the requested Recommender Config. There is only one instance of the config for each Recommender. | | `organizations_locations_recommenders_update_config` | `EXEC` | `locationsId, organizationsId, recommendersId` | Updates a Recommender Config. This will create a new revision of the config. | -| `projects_locations_recommenders_get_config` | `EXEC` | `locationsId, projectsId, recommendersId` | Gets the requested Recommender Config. There is only one instance of the config for each Recommender. | | `projects_locations_recommenders_update_config` | `EXEC` | `locationsId, projectsId, recommendersId` | Updates a Recommender Config. This will create a new revision of the config. | diff --git a/docs/google-docs/providers/google/redis/index.md b/docs/google-docs/providers/google/redis/index.md index 19b228b921..23f4e0ffc7 100644 --- a/docs/google-docs/providers/google/redis/index.md +++ b/docs/google-docs/providers/google/redis/index.md @@ -33,7 +33,7 @@ Creates And Manages Redis Instances On The Google Cloud Platform. TypeService TitleGoogle Cloud Memorystore For Redis API DescriptionCreates And Manages Redis Instances On The Google Cloud Platform. -Idredis:v23.08.00161 +Idredis:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/redis/instances/index.md b/docs/google-docs/providers/google/redis/instances/index.md index 06a1ca3445..bc332f1ea1 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. | -| `createTime` | `string` | Output only. The time the instance was created. | | `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. | -| `customerManagedKey` | `string` | Optional. The KMS key reference that the customer provides when trying to create the instance. | -| `readReplicasMode` | `string` | Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. | -| `maintenanceSchedule` | `object` | Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. | -| `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". | -| `readEndpointPort` | `integer` | Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. | -| `state` | `string` | Output only. The current state of this instance. | -| `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 | -| `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. | -| `serverCaCerts` | `array` | Output only. List of server CA certificates for the instance. | -| `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. | +| `availableMaintenanceVersions` | `array` | Optional. The available maintenance versions that an instance could update to. | +| `maintenancePolicy` | `object` | Maintenance policy for an instance. | | `statusMessage` | `string` | Output only. Additional information about the current status of this instance, if available. | -| `transitEncryptionMode` | `string` | Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled 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 | +| `memorySizeGb` | `integer` | Required. Redis memory size in GiB. | | `connectMode` | `string` | Optional. The network connect mode of the Redis instance. If not provided, the connect mode defaults to DIRECT_PEERING. | +| `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. | +| `maintenanceSchedule` | `object` | Upcoming maintenance schedule. If no maintenance is scheduled, fields are not populated. | | `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. | -| `availableMaintenanceVersions` | `array` | Optional. The available maintenance versions that an instance could update to. | +| `readReplicasMode` | `string` | Optional. Read replicas mode for the instance. Defaults to READ_REPLICAS_DISABLED. | +| `suspensionReasons` | `array` | Optional. reasons that causes instance in "SUSPENDED" state. | +| `createTime` | `string` | Output only. The time the instance was created. | | `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. | -| `labels` | `object` | Resource labels to represent user provided metadata | -| `tier` | `string` | Required. The service tier of the instance. | -| `nodes` | `array` | Output only. Info per node. | -| `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. | | `port` | `integer` | Output only. The port number of the exposed Redis endpoint. | -| `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 | -| `persistenceConfig` | `object` | Configuration of the persistence functionality. | -| `suspensionReasons` | `array` | Optional. reasons that causes instance in "SUSPENDED" state. | +| `state` | `string` | Output only. The current state of this instance. | +| `readEndpointPort` | `integer` | Output only. The port number of the exposed readonly redis endpoint. Standard tier only. Write requests should target 'port'. | +| `maintenanceVersion` | `string` | Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". | +| `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. | +| `serverCaCerts` | `array` | Output only. List of server CA certificates for the instance. | +| `transitEncryptionMode` | `string` | Optional. The TLS mode of the Redis instance. If not provided, TLS is disabled for the instance. | +| `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 | +| `customerManagedKey` | `string` | Optional. The KMS key reference that the customer provides when trying to create the instance. | | `host` | `string` | Output only. Hostname or IP address of the exposed Redis endpoint used by clients to connect to the service. | +| `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. | +| `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. | +| `nodes` | `array` | Output only. Info per node. | +| `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". | | `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'. | -| `maintenanceVersion` | `string` | Optional. The self service update maintenance version. The version is date based such as "20210712_00_00". | | `displayName` | `string` | An arbitrary and optional user-provided name for the instance. | -| `memorySizeGb` | `integer` | Required. Redis memory size in GiB. | -| `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. | -| `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. | -| `maintenancePolicy` | `object` | Maintenance policy for an instance. | +| `labels` | `object` | Resource labels to represent user provided metadata | +| `persistenceConfig` | `object` | Configuration of the persistence functionality. | +| `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. | ## 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..4a3d2354fc 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". | +| `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. | | `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/redis/operations/index.md b/docs/google-docs/providers/google/redis/operations/index.md index 8e3bbd5c8c..2ad3d02c4f 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}`. | +| `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, 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/resourcesettings/index.md b/docs/google-docs/providers/google/resourcesettings/index.md index 29d09293ea..528089f3e3 100644 --- a/docs/google-docs/providers/google/resourcesettings/index.md +++ b/docs/google-docs/providers/google/resourcesettings/index.md @@ -33,7 +33,7 @@ The Resource Settings API Allows Users To Control And Modify The Behavior Of The TypeService TitleResource Settings API DescriptionThe Resource Settings API Allows Users To Control And Modify The Behavior Of Their GCP Resources (E.G., VM, Firewall, Project, Etc.) Across The Cloud Resource Hierarchy. -Idresourcesettings:v23.08.00161 +Idresourcesettings:v23.08.00163 ## Resources 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 cfa1206190..eb8e1529ec 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. | -| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/retail/catalogs_attributes_config/index.md b/docs/google-docs/providers/google/retail/catalogs_attributes_config/index.md index db18d58523..41e47dec63 100644 --- a/docs/google-docs/providers/google/retail/catalogs_attributes_config/index.md +++ b/docs/google-docs/providers/google/retail/catalogs_attributes_config/index.md @@ -25,9 +25,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | Required. Immutable. The fully qualified resource name of the attribute config. Format: `projects/*/locations/*/catalogs/*/attributesConfig` | +| `attributeConfigLevel` | `string` | Output only. The AttributeConfigLevel used for this catalog. | +| `catalogAttributes` | `object` | Enable attribute(s) config at catalog level. For example, indexable, dynamic_facetable, or searchable for each attribute. The key is catalog attribute's name. For example: `color`, `brands`, `attributes.custom_attribute`, such as `attributes.xyz`. The maximum number of catalog attributes allowed in a request is 1000. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| -| `projects_locations_catalogs_get_attributes_config` | `EXEC` | `catalogsId, locationsId, projectsId` | Gets an AttributesConfig. | +| `projects_locations_catalogs_get_attributes_config` | `SELECT` | `catalogsId, locationsId, projectsId` | Gets an AttributesConfig. | | `projects_locations_catalogs_update_attributes_config` | `EXEC` | `catalogsId, locationsId, projectsId` | Updates the AttributesConfig. The catalog attributes in the request will be updated in the catalog, or inserted if they do not exist. Existing catalog attributes not included in the request will remain unchanged. Attributes that are assigned to products, but do not exist at the catalog level, are always included in the response. The product attribute is assigned default values for missing catalog attribute fields, e.g., searchable and dynamic facetable options. | 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 0327462a41..87d42957ed 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,15 +28,15 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Required. Immutable. Fully qualified name `projects/*/locations/*/catalogs/*/completionConfig` | -| `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. | -| `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. | | `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. | +| `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. | | `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. | -| `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'. | -| `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. | | `denylistInputConfig` | `object` | The input config source for completion data. | +| `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. | +| `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. | +| `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'. | | `allowlistInputConfig` | `object` | The input config source for completion data. | ## 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..91425a4da0 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 | |:-----|:---------|:------------| +| `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. | | `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. | ## 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/index.md b/docs/google-docs/providers/google/retail/index.md index e37109cf1d..2881d28378 100644 --- a/docs/google-docs/providers/google/retail/index.md +++ b/docs/google-docs/providers/google/retail/index.md @@ -20,7 +20,7 @@ Cloud Retail Service Enables Customers To Build End-To-End Personalized Recommen
total resources: 17
-total selectable resources: 8
+total selectable resources: 9
total methods: 69
@@ -33,7 +33,7 @@ Cloud Retail Service Enables Customers To Build End-To-End Personalized Recommen TypeService TitleRetail API DescriptionCloud Retail Service Enables Customers To Build End-To-End Personalized Recommendation Systems Without Requiring A High Level Of Expertise In Machine Learning, Recommendation System, Or Google Cloud. -Idretail:v23.08.00161 +Idretail:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/retail/models/index.md b/docs/google-docs/providers/google/retail/models/index.md index 652088c8c6..0195fbb0de 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. | -| `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. | -| `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`. | +| `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. | +| `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. | | `filteringOption` | `string` | Optional. If `RECOMMENDATIONS_FILTERING_ENABLED`, recommendation filtering by attributes is enabled for the model. | | `lastTuneTime` | `string` | Output only. The timestamp when the latest successful tune finished. | -| `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. | +| `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. | | `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. | -| `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. | -| `modelFeaturesConfig` | `object` | Additional model features config. | -| `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. | | `servingState` | `string` | Output only. The serving state of the model: `ACTIVE`, `NOT_ACTIVE`. | -| `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. | -| `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. | | `createTime` | `string` | Output only. Timestamp the Recommendation Model was created at. | +| `servingConfigLists` | `array` | Output only. The list of valid serving configs associated with the PageOptimizationConfig. | +| `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. | +| `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. | +| `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 44fa8abf60..853beaa9fa 100644 --- a/docs/google-docs/providers/google/retail/operations/index.md +++ b/docs/google-docs/providers/google/retail/operations/index.md @@ -35,13 +35,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_catalogs_branches_operations_get` | `SELECT` | `branchesId, catalogsId, locationsId, 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. | +| `projects_locations_catalogs_operations_get` | `SELECT` | `catalogsId, locationsId, 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. | | `projects_locations_catalogs_operations_list` | `SELECT` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `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. | | `projects_operations_list` | `SELECT` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_catalogs_operations_list` | `EXEC` | `catalogsId, locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_operations_list` | `EXEC` | `projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `projects_locations_catalogs_branches_operations_get` | `EXEC` | `branchesId, catalogsId, locationsId, 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. | -| `projects_locations_catalogs_operations_get` | `EXEC` | `catalogsId, locationsId, 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. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | -| `projects_operations_get` | `EXEC` | `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. | diff --git a/docs/google-docs/providers/google/retail/products/index.md b/docs/google-docs/providers/google/retail/products/index.md index 55a8a2bf11..b55fdb7350 100644 --- a/docs/google-docs/providers/google/retail/products/index.md +++ b/docs/google-docs/providers/google/retail/products/index.md @@ -30,45 +30,45 @@ 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). | -| `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). | -| `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. | -| `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). | +| `rating` | `object` | The rating of a Product. | +| `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. | | `availableQuantity` | `integer` | The available quantity of the item. | -| `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). | -| `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). | +| `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). | | `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. | +| `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). | | `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 | +| `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). | +| `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). | +| `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. | +| `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. | +| `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. | | `colorInfo` | `object` | The color information of a Product. | | `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). | -| `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. | -| `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). | -| `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. | -| `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. | -| `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. | -| `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. | -| `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). | | `audience` | `object` | An intended audience of the Product for whom it's sold. | -| `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. | | `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. | -| `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. | -| `type` | `string` | Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset. | -| `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. | -| `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). | -| `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). | -| `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). | -| `rating` | `object` | The rating of a Product. | | `priceInfo` | `object` | The price information of a Product. | +| `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). | +| `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. | +| `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). | +| `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). | +| `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). | +| `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. | | `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. | -| `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). | -| `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). | +| `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). | +| `type` | `string` | Immutable. The type of the product. Default to Catalog.product_level_config.ingestion_product_type if unset. | +| `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. | +| `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). | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_catalogs_branches_products_get` | `SELECT` | `branchesId, catalogsId, locationsId, productsId, projectsId` | Gets a Product. | | `projects_locations_catalogs_branches_products_list` | `SELECT` | `branchesId, catalogsId, locationsId, projectsId` | Gets a list of Products. | | `projects_locations_catalogs_branches_products_create` | `INSERT` | `branchesId, catalogsId, locationsId, projectsId` | Creates a Product. | | `projects_locations_catalogs_branches_products_delete` | `DELETE` | `branchesId, catalogsId, locationsId, productsId, projectsId` | Deletes a Product. | | `_projects_locations_catalogs_branches_products_list` | `EXEC` | `branchesId, catalogsId, locationsId, projectsId` | Gets a list of Products. | -| `projects_locations_catalogs_branches_products_get` | `EXEC` | `branchesId, catalogsId, locationsId, productsId, projectsId` | Gets a Product. | | `projects_locations_catalogs_branches_products_import` | `EXEC` | `branchesId, catalogsId, locationsId, projectsId` | Bulk import of multiple Products. Request processing may be synchronous. Non-existing items are created. Note that it is possible for a subset of the Products to be successfully updated. | | `projects_locations_catalogs_branches_products_patch` | `EXEC` | `branchesId, catalogsId, locationsId, productsId, projectsId` | Updates a Product. | | `projects_locations_catalogs_branches_products_purge` | `EXEC` | `branchesId, catalogsId, locationsId, projectsId` | Permanently deletes all selected Products under a branch. This process is asynchronous. If the request is valid, the removal will be enqueued and processed offline. Depending on the number of Products, this operation could take hours to complete. Before the operation completes, some Products may still be returned by ProductService.GetProduct or ProductService.ListProducts. Depending on the number of Products, this operation could take hours to complete. To get a sample of Products that would be deleted, set PurgeProductsRequest.force to false. | 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 8e19b70c1b..df5fa4a480 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/*` | -| `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. | -| `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. | -| `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. | -| `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. | -| `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. | -| `personalizationSpec` | `object` | The specification for personalization. | -| `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. | -| `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. | -| `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. | -| `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. | +| `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. | | `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. | | `diversityType` | `string` | What kind of diversity to use - data driven or rule based. If unset, the server behavior defaults to RULE_BASED_DIVERSITY. | +| `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. | +| `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. | +| `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. | +| `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. | +| `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. | +| `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. | | `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. | -| `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. | +| `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. | | `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. | -| `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. | -| `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. | +| `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. | +| `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. | +| `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. | +| `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. | ## 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 d5aab0bd81..14c633253a 100644 --- a/docs/google-docs/providers/google/run/executions/index.md +++ b/docs/google-docs/providers/google/run/executions/index.md @@ -28,32 +28,32 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The unique name of this Execution. | -| `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. | +| `cancelledCount` | `integer` | Output only. The number of tasks which reached phase Cancelled. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `runningCount` | `integer` | Output only. The number of actively running tasks. | | `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. | | `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. | +| `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. | | `failedCount` | `integer` | Output only. The number of tasks which reached phase Failed. | +| `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. | +| `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. | +| `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 | +| `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. | | `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. | -| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | -| `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. | -| `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. | | `updateTime` | `string` | Output only. The last-modified time. | -| `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 | -| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | -| `job` | `string` | Output only. The name of the parent Job. | -| `cancelledCount` | `integer` | Output only. The number of tasks which reached phase Cancelled. | -| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | | `succeededCount` | `integer` | Output only. The number of tasks which reached phase Succeeded. | -| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | -| `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. | -| `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. | +| `job` | `string` | Output only. The name of the parent Job. | +| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `observedGeneration` | `string` | Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | | `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. | | `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. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `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. | -| `observedGeneration` | `string` | Output only. The generation of this Execution. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `runningCount` | `integer` | Output only. The number of actively running tasks. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/index.md b/docs/google-docs/providers/google/run/index.md index 448d191887..f2aecdb310 100644 --- a/docs/google-docs/providers/google/run/index.md +++ b/docs/google-docs/providers/google/run/index.md @@ -33,7 +33,7 @@ Deploy And Manage User Provided Container Images That Scale Automatically Based TypeService TitleCloud Run Admin API DescriptionDeploy And Manage User Provided Container Images That Scale Automatically Based On Incoming Requests. The Cloud Run Admin API V1 Follows The Knative Serving API Specification, While V2 Is Aligned With Google Cloud AIP-Based API Standards, As Described In Https://Google.Aip.Dev/. -Idrun:v23.08.00161 +Idrun:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/run/jobs/index.md b/docs/google-docs/providers/google/run/jobs/index.md index b61698885d..5c207e9e4d 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} | -| `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. | -| `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. | -| `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. | -| `client` | `string` | Arbitrary identifier for the API client. | -| `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`. | -| `creator` | `string` | Output only. Email address of the authenticated creator. | -| `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. | -| `deleteTime` | `string` | Output only. The deletion time. | | `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. | -| `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. | +| `executionCount` | `integer` | Output only. Number of executions created for this job. | +| `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. | +| `createTime` | `string` | Output only. The creation time. | +| `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. | +| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | | `updateTime` | `string` | Output only. The last-modified time. | +| `terminalCondition` | `object` | Defines a status condition for a resource. | +| `creator` | `string` | Output only. Email address of the authenticated creator. | | `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | | `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | -| `clientVersion` | `string` | Arbitrary version identifier for the API client. | -| `template` | `object` | ExecutionTemplate describes the data an execution should have when created from a template. | -| `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. | -| `observedGeneration` | `string` | Output only. The generation of this Job. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | | `latestCreatedExecution` | `object` | Reference to an Execution. Use /Executions.GetExecution with the given name to get full execution including the latest status. | -| `executionCount` | `integer` | Output only. Number of executions created for this job. | -| `createTime` | `string` | Output only. The creation time. | +| `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`. | +| `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. | +| `client` | `string` | Arbitrary identifier for the API client. | +| `template` | `object` | ExecutionTemplate describes the data an execution should have when created from a template. | +| `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. | +| `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. | +| `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. | +| `clientVersion` | `string` | Arbitrary version identifier for the API client. | +| `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. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/jobs_iam_policies/index.md b/docs/google-docs/providers/google/run/jobs_iam_policies/index.md index a8c760af66..a7a23e19d3 100644 --- a/docs/google-docs/providers/google/run/jobs_iam_policies/index.md +++ b/docs/google-docs/providers/google/run/jobs_iam_policies/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/operations/index.md b/docs/google-docs/providers/google/run/operations/index.md index 6ab4d9d55e..3e94478178 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, 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/run/revisions/index.md b/docs/google-docs/providers/google/run/revisions/index.md index b039a0f171..2c6a7ab9dd 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. | -| `createTime` | `string` | Output only. The creation time. | -| `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. | -| `maxInstanceRequestConcurrency` | `integer` | Sets the maximum number of requests that each serving instance can receive. | +| `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 | +| `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. | +| `containers` | `array` | Holds the single container that defines the unit of execution for this Revision. | +| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | | `updateTime` | `string` | Output only. The last-modified time. | -| `sessionAffinity` | `boolean` | Enable session affinity. | -| `timeout` | `string` | Max allowed time for an instance to respond to a request. | +| `createTime` | `string` | Output only. The creation time. | +| `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. | +| `service` | `string` | Output only. The name of the parent service. | | `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 | -| `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. | | `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 Revision currently serving traffic. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `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 | -| `containers` | `array` | Holds the single container that defines the unit of execution for this Revision. | +| `timeout` | `string` | Max allowed time for an instance to respond to a request. | +| `executionEnvironment` | `string` | The execution environment being used to host this Revision. | | `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. | +| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `sessionAffinity` | `boolean` | Enable session affinity. | +| `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. | | `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. | -| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | -| `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. The Google Console URI to obtain logs for the Revision. | -| `encryptionKeyRevocationAction` | `string` | The action to take if the encryption key is revoked. | -| `executionEnvironment` | `string` | The execution environment being used to host this Revision. | | `volumes` | `array` | A list of Volumes to make available to containers. | -| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | -| `scaling` | `object` | Settings for revision-level scaling settings. | -| `encryptionKeyShutdownDuration` | `string` | If encryption_key_revocation_action is SHUTDOWN, the duration before shutting down all instances. The minimum increment is 1 hour. | -| `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. | -| `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | -| `service` | `string` | Output only. The name of the parent service. | -| `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. | | `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `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. | +| `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. | +| `encryptionKeyRevocationAction` | `string` | The action to take if the encryption key is revoked. | +| `maxInstanceRequestConcurrency` | `integer` | Sets the maximum number of requests that each serving instance can receive. | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | +| `scaling` | `object` | Settings for revision-level scaling settings. | +| `logUri` | `string` | Output only. The Google Console URI to obtain logs for the Revision. | ## 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 90100447e2..7949167790 100644 --- a/docs/google-docs/providers/google/run/services/index.md +++ b/docs/google-docs/providers/google/run/services/index.md @@ -29,35 +29,35 @@ 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. | +| `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. | +| `trafficTagsCleanupThreshold` | `string` | Optional. Override the traffic tag threshold limit. Garbage collection will start cleaning up non-serving tagged traffic targets based on creation item. The default value is 2000. | +| `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. | +| `uri` | `string` | Output only. The main URI in which this Service is serving traffic. | +| `creator` | `string` | Output only. Email address of the authenticated creator. | | `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. | | `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | -| `template` | `object` | RevisionTemplate describes the data a revision should have when created from a template. | -| `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`. | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `createTime` | `string` | Output only. The creation time. | | `updateTime` | `string` | Output only. The last-modified time. | -| `trafficTagsCleanupThreshold` | `string` | Optional. Override the traffic tag threshold limit. Garbage collection will start cleaning up non-serving tagged traffic targets based on creation item. The default value is 2000. | -| `trafficStatuses` | `array` | Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `creator` | `string` | Output only. Email address of the authenticated creator. | -| `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. | -| `clientVersion` | `string` | Arbitrary version 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. | -| `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. | -| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | +| `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. | +| `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`. | | `client` | `string` | Arbitrary identifier for the API client. | -| `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. | -| `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`. | | `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. | | `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. | -| `latestCreatedRevision` | `string` | Output only. Name of the last created revision. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | -| `deleteTime` | `string` | Output only. The deletion time. | -| `uri` | `string` | Output only. The main URI in which this Service is serving traffic. | +| `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | +| `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. | | `expireTime` | `string` | Output only. For a deleted resource, the time after which it will be permamently deleted. | | `terminalCondition` | `object` | Defines a status condition for a resource. | +| `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`. | +| `template` | `object` | RevisionTemplate describes the data a revision should have when created from a template. | +| `binaryAuthorization` | `object` | Settings for Binary Authorization feature. | +| `trafficStatuses` | `array` | Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `clientVersion` | `string` | Arbitrary version identifier for the API client. | +| `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. | +| `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. | | `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. | -| `lastModifier` | `string` | Output only. Email address of the last authenticated modifier. | -| `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`. | +| `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`. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 e3f1f50d20..5953123b33 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/run/tasks/index.md b/docs/google-docs/providers/google/run/tasks/index.md index 9eb063a62d..b603777085 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. | -| `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. | -| `retried` | `integer` | Output only. The number of times this Task was retried. Tasks are retried when they fail up to the maxRetries limit. | -| `maxRetries` | `integer` | Number of retries allowed per Task, before marking this Task failed. | -| `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. | -| `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. | | `observedGeneration` | `string` | Output only. The generation of this Task. See comments in `Job.reconciling` for additional information on reconciliation process in Cloud Run. | -| `createTime` | `string` | Output only. Represents time when the task was created by the system. 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. | +| `index` | `integer` | Output only. Index of the Task, unique per execution, and beginning at 0. | | `executionEnvironment` | `string` | The execution environment being used to host this Task. | -| `execution` | `string` | Output only. The name of the parent Execution. | -| `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. | -| `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. | | `updateTime` | `string` | Output only. The last-modified time. | -| `lastAttemptResult` | `object` | Result of a task attempt. | +| `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. | +| `maxRetries` | `integer` | Number of retries allowed per Task, before marking this Task failed. | +| `createTime` | `string` | Output only. Represents time when the task was created by the system. 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. | | `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. | -| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | -| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | -| `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. | -| `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 | -| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | -| `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. | -| `etag` | `string` | Output only. A system-generated fingerprint for this version of the resource. May be used to detect modification conflict during updates. | +| `lastAttemptResult` | `object` | Result of a task attempt. | +| `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. | | `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 | -| `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 | +| `generation` | `string` | Output only. A number that monotonically increases every time the user modifies the desired state. | | `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 | -| `index` | `integer` | Output only. Index of the Task, unique per execution, and beginning at 0. | -| `volumes` | `array` | A list of Volumes to make available to containers. | | `deleteTime` | `string` | Output only. For a deleted resource, the deletion time. It is only populated as a response to a Delete request. | -| `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. | +| `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. | +| `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. | +| `execution` | `string` | Output only. The name of the parent Execution. | +| `volumes` | `array` | A list of Volumes to make available to containers. | +| `job` | `string` | Output only. The name of the parent Job. | +| `satisfiesPzs` | `boolean` | Output only. Reserved for future use. | +| `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. | +| `logUri` | `string` | Output only. URI where logs for this execution can be found in Cloud Console. | +| `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. | +| `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/index.md b/docs/google-docs/providers/google/runtimeconfig/index.md index 4178e1d18f..c051a2f332 100644 --- a/docs/google-docs/providers/google/runtimeconfig/index.md +++ b/docs/google-docs/providers/google/runtimeconfig/index.md @@ -33,7 +33,7 @@ The Runtime Configurator Allows You To Dynamically Configure And Expose Variable TypeService TitleCloud Runtime Configuration API DescriptionThe Runtime Configurator Allows You To Dynamically Configure And Expose Variables Through Google Cloud Platform. In Addition, You Can Also Set Watchers And Waiters That Will Watch For Changes To Your Data And Return Based On Certain Conditions. -Idruntimeconfig:v23.08.00161 +Idruntimeconfig:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/runtimeconfig/operations/index.md b/docs/google-docs/providers/google/runtimeconfig/operations/index.md index 305a7dc0dc..4eddf7c6a4 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}`. | -| `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/sasportal/customer_node/index.md b/docs/google-docs/providers/google/sasportal/customer_node/index.md index 3e411ba9e9..0581d630ab 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. | -| `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/sasportal/customers/index.md b/docs/google-docs/providers/google/sasportal/customers/index.md index 65fa44b882..6c6b72626c 100644 --- a/docs/google-docs/providers/google/sasportal/customers/index.md +++ b/docs/google-docs/providers/google/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. | -| `displayName` | `string` | Required. Name of the organization that the customer entity represents. | | `sasUserIds` | `array` | User IDs used by the devices belonging to this customer. | +| `displayName` | `string` | Required. Name of the organization that the customer entity represents. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| @@ -40,3 +40,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `customers_migrate_organization` | `EXEC` | | Migrates a SAS organization to the cloud. This will create GCP projects for each deployment and associate them. The SAS Organization is linked to the gcp project that called the command. go/sas-legacy-customer-migration | | `customers_patch` | `EXEC` | `customersId` | Updates an existing customer. | | `customers_provision_deployment` | `EXEC` | | Creates a new SAS deployment through the GCP workflow. Creates a SAS organization if an organization match is not found. | +| `customers_setup_sas_analytics` | `EXEC` | | Setups the a GCP Project to receive SAS Analytics messages via GCP Pub/Sub with a subscription to BigQuery. All the Pub/Sub topics and BigQuery tables are created automatically as part of this service. | diff --git a/docs/google-docs/providers/google/sasportal/deployments/index.md b/docs/google-docs/providers/google/sasportal/deployments/index.md index 1457442c8b..fef51077f0 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 7a3e3a2d4e..dbb86b5a88 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. | -| `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | -| `currentChannels` | `array` | Output only. Current channels with scores. | | `serialNumber` | `string` | A serial number assigned to the device by the device manufacturer. | | `activeConfig` | `object` | Information about the device configuration. | +| `grants` | `array` | Output only. Grants held by the device. | +| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | +| `currentChannels` | `array` | Output only. Current channels with scores. | | `preloadedConfig` | `object` | Information about the device configuration. | | `displayName` | `string` | Device display name. | -| `deviceMetadata` | `object` | Device data overridable by both SAS Portal and registration requests. | -| `fccId` | `string` | The FCC identifier of the device. | +| `grantRangeAllowlists` | `array` | Only ranges that are within the allowlists are available for new grants. | | `state` | `string` | Output only. Device state. | -| `grants` | `array` | Output only. Grants held by the device. | +| `fccId` | `string` | The FCC identifier of the device. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sasportal/index.md b/docs/google-docs/providers/google/sasportal/index.md index 4cc428d8b8..339b17eedb 100644 --- a/docs/google-docs/providers/google/sasportal/index.md +++ b/docs/google-docs/providers/google/sasportal/index.md @@ -21,7 +21,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png
total resources: 10
total selectable resources: 7
-total methods: 95
+total methods: 96
@@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleSAS Portal API Description -Idsasportal:v23.08.00161 +Idsasportal:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/sasportal/node/index.md b/docs/google-docs/providers/google/sasportal/node/index.md index 05b31bf839..c06c3c4612 100644 --- a/docs/google-docs/providers/google/sasportal/node/index.md +++ b/docs/google-docs/providers/google/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/sasportal/nodes/index.md b/docs/google-docs/providers/google/sasportal/nodes/index.md index fe4adabdbb..4577898198 100644 --- a/docs/google-docs/providers/google/sasportal/nodes/index.md +++ b/docs/google-docs/providers/google/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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/secretmanager/index.md b/docs/google-docs/providers/google/secretmanager/index.md index 13683bcded..17a07fc3f7 100644 --- a/docs/google-docs/providers/google/secretmanager/index.md +++ b/docs/google-docs/providers/google/secretmanager/index.md @@ -33,7 +33,7 @@ Stores Sensitive Data Such As API Keys, Passwords, And Certificates. Provides Co TypeService TitleSecret Manager API DescriptionStores Sensitive Data Such As API Keys, Passwords, And Certificates. Provides Convenience While Improving Security. -Idsecretmanager:v23.08.00161 +Idsecretmanager:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/secretmanager/secrets/index.md b/docs/google-docs/providers/google/secretmanager/secrets/index.md index 68a07d43b7..f1e3f6db1a 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/*`. | -| `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. | -| `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. | -| `ttl` | `string` | Input only. The TTL for the Secret. | | `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. | -| `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. | | `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. | +| `ttl` | `string` | Input only. The TTL for the Secret. | +| `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. | +| `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. | +| `etag` | `string` | Optional. Etag of the currently stored Secret. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 c3e38197c4..f9af6235f9 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/secretmanager/versions/index.md b/docs/google-docs/providers/google/secretmanager/versions/index.md index d709f39f75..d94088be8e 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. | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/attack_paths/index.md b/docs/google-docs/providers/google/securitycenter/attack_paths/index.md index d69cca8498..9a52cc2c89 100644 --- a/docs/google-docs/providers/google/securitycenter/attack_paths/index.md +++ b/docs/google-docs/providers/google/securitycenter/attack_paths/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The attack path name, for example, `organizations/12/simulation/34/valuedResources/56/attackPaths/78` | -| `pathNodes` | `array` | A list of nodes that exist in this attack path. | | `edges` | `array` | A list of the edges between nodes in this attack path. | +| `pathNodes` | `array` | A list of nodes that exist in this attack path. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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..c52eaf10e1 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). | +| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/custom_modules/index.md b/docs/google-docs/providers/google/securitycenter/custom_modules/index.md index c77a629d7b..91fcfbad6d 100644 --- a/docs/google-docs/providers/google/securitycenter/custom_modules/index.md +++ b/docs/google-docs/providers/google/securitycenter/custom_modules/index.md @@ -25,12 +25,21 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | +| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `organizations_event_threat_detection_settings_custom_modules_get` | `SELECT` | `customModulesId, organizationsId` | Gets an Event Threat Detection custom module. | | `folders_security_health_analytics_settings_custom_modules_patch` | `EXEC` | `customModulesId, foldersId` | Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only. | -| `organizations_event_threat_detection_settings_custom_modules_get` | `EXEC` | `customModulesId, organizationsId` | Gets an Event Threat Detection custom module. | | `organizations_event_threat_detection_settings_custom_modules_patch` | `EXEC` | `customModulesId, organizationsId` | Updates an Event Threat Detection custom module. | | `organizations_security_health_analytics_settings_custom_modules_patch` | `EXEC` | `customModulesId, organizationsId` | Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only. | | `projects_security_health_analytics_settings_custom_modules_patch` | `EXEC` | `customModulesId, projectsId` | Updates the SecurityHealthAnalyticsCustomModule under the given name based on the given update mask. Updating the enablement state is supported on both resident and inherited modules (though resident modules cannot have an enablement state of "inherited"). Updating the display name and custom config of a module is supported on resident modules only. | diff --git a/docs/google-docs/providers/google/securitycenter/effective_custom_modules/index.md b/docs/google-docs/providers/google/securitycenter/effective_custom_modules/index.md index ced43c21ab..7106939e45 100644 --- a/docs/google-docs/providers/google/securitycenter/effective_custom_modules/index.md +++ b/docs/google-docs/providers/google/securitycenter/effective_custom_modules/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 custom module. Its format is "organizations/{organization}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "folders/{folder}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}", or "projects/{project}/securityHealthAnalyticsSettings/effectiveCustomModules/{customModule}" | -| `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` | Output only. The display name for the custom module. The name must be between 1 and 128 characters, start with a lowercase letter, and contain alphanumeric characters or underscores only. | | `enablementState` | `string` | Output only. The effective state of enablement for the module at the given level of the hierarchy. | +| `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. | ## 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 349613db64..385b83b224 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 | |:-----|:---------|:------------| -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/securitycenter/index.md b/docs/google-docs/providers/google/securitycenter/index.md index 81bf48b3b6..94b026acab 100644 --- a/docs/google-docs/providers/google/securitycenter/index.md +++ b/docs/google-docs/providers/google/securitycenter/index.md @@ -20,7 +20,7 @@ Security Command Center API Provides Access To Temporal Views Of Assets And Find
total resources: 22
-total selectable resources: 17
+total selectable resources: 18
total methods: 171
@@ -33,7 +33,7 @@ Security Command Center API Provides Access To Temporal Views Of Assets And Find TypeService TitleSecurity Command Center API DescriptionSecurity Command Center API Provides Access To Temporal Views Of Assets And Findings Within An Organization. -Idsecuritycenter:v23.08.00161 +Idsecuritycenter:v23.08.00163 ## Resources 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 a7946840b9..312f13272b 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. | +| `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. | | `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. | ## 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 fe820b04f2..71851aa2dd 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 cb370d7a64..a3b9dc14ca 100644 --- a/docs/google-docs/providers/google/securitycenter/operations/index.md +++ b/docs/google-docs/providers/google/securitycenter/operations/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, 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 | |:-----|:--------------|:----------------|:------------| +| `organizations_operations_get` | `SELECT` | `operationsId, organizationsId` | 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. | | `organizations_operations_list` | `SELECT` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_operations_delete` | `DELETE` | `operationsId, organizationsId` | 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`. | | `_organizations_operations_list` | `EXEC` | `organizationsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `organizations_operations_cancel` | `EXEC` | `operationsId, organizationsId` | 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`. | -| `organizations_operations_get` | `EXEC` | `operationsId, organizationsId` | 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. | 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 b856ca7750..7defc8a72b 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,19 +29,19 @@ 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. | +| `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 | +| `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. | | `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. | -| `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. | -| `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 | | `resourceValue` | `string` | Required. Resource value level this expression represents | -| `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. | +| `updateTime` | `string` | Output only. Timestamp this resource value config was last updated. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `organizations_resource_value_configs_get` | `SELECT` | `organizationsId, resourceValueConfigsId` | Gets a ResourceValueConfig. | | `organizations_resource_value_configs_list` | `SELECT` | `organizationsId` | Lists all ResourceValueConfigs. | | `organizations_resource_value_configs_delete` | `DELETE` | `organizationsId, resourceValueConfigsId` | Deletes a ResourceValueConfig. | | `_organizations_resource_value_configs_list` | `EXEC` | `organizationsId` | Lists all ResourceValueConfigs. | | `organizations_resource_value_configs_batch_create` | `EXEC` | `organizationsId` | Creates a ResourceValueConfig for an organization. Maps user's tags to difference resource values for use by the attack path simulation. | -| `organizations_resource_value_configs_get` | `EXEC` | `organizationsId, resourceValueConfigsId` | Gets a ResourceValueConfig. | | `organizations_resource_value_configs_patch` | `EXEC` | `organizationsId, resourceValueConfigsId` | Updates an existing ResourceValueConfigs with new rules. | 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 bd60a2ab45..9f1ae1fbde 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 | -| `createTime` | `string` | Output only. Time simulation was created | | `resourceValueConfigsMetadata` | `array` | Resource value configurations' metadata used in this simulation. Maximum of 100. | +| `createTime` | `string` | Output only. Time simulation was created | ## 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_policies/index.md b/docs/google-docs/providers/google/securitycenter/sources_iam_policies/index.md index dc4262f11b..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 | |:-----|:---------|:------------| -| `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/securitycenter/valued_resources/index.md b/docs/google-docs/providers/google/securitycenter/valued_resources/index.md index 576dd8665c..56ec2e9cf0 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` | -| `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. | +| `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. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/index.md index 8bda18ddca..459d1b1e95 100644 --- a/docs/google-docs/providers/google/serviceconsumermanagement/index.md +++ b/docs/google-docs/providers/google/serviceconsumermanagement/index.md @@ -33,7 +33,7 @@ Manages The Service Consumers Of A Service Infrastructure Service. TypeService TitleService Consumer Management API DescriptionManages The Service Consumers Of A Service Infrastructure Service. -Idserviceconsumermanagement:v23.08.00161 +Idserviceconsumermanagement:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md b/docs/google-docs/providers/google/serviceconsumermanagement/operations/index.md index c20aa72f09..69baf0e54e 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 a74e93bec6..ab897049e7 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}" | -| `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'. | +| `tenantResources` | `array` | Resources constituting the tenancy unit. There can be at most 512 tenant resources in a tenancy unit. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicecontrol/index.md b/docs/google-docs/providers/google/servicecontrol/index.md index 3e7e57b770..03dd2542f4 100644 --- a/docs/google-docs/providers/google/servicecontrol/index.md +++ b/docs/google-docs/providers/google/servicecontrol/index.md @@ -33,7 +33,7 @@ Provides Admission Control And Telemetry Reporting For Services Integrated With TypeService TitleService Control API DescriptionProvides Admission Control And Telemetry Reporting For Services Integrated With Service Infrastructure. -Idservicecontrol:v23.08.00161 +Idservicecontrol:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/servicedirectory/endpoints/index.md b/docs/google-docs/providers/google/servicedirectory/endpoints/index.md index a378391735..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/*`. | +| `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]`. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicedirectory/index.md b/docs/google-docs/providers/google/servicedirectory/index.md index 9e3e76e059..dce2020fd8 100644 --- a/docs/google-docs/providers/google/servicedirectory/index.md +++ b/docs/google-docs/providers/google/servicedirectory/index.md @@ -33,7 +33,7 @@ Service Directory Is A Platform For Discovering, Publishing, And Connecting Serv TypeService TitleService Directory API DescriptionService Directory Is A Platform For Discovering, Publishing, And Connecting Services. -Idservicedirectory:v23.08.00161 +Idservicedirectory:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/servicedirectory/namespaces/index.md b/docs/google-docs/providers/google/servicedirectory/namespaces/index.md index 4849124f94..b98ec98109 100644 --- a/docs/google-docs/providers/google/servicedirectory/namespaces/index.md +++ b/docs/google-docs/providers/google/servicedirectory/namespaces/index.md @@ -28,8 +28,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Immutable. The resource name for the namespace in the format `projects/*/locations/*/namespaces/*`. | -| `uid` | `string` | Output only. The globally unique identifier of the namespace in the UUID4 format. | | `labels` | `object` | Optional. Resource labels associated with this namespace. No more than 64 user labels can be associated with a given resource. Label keys and values can be no longer than 63 characters. | +| `uid` | `string` | Output only. The globally unique identifier of the namespace in the UUID4 format. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 a8c5600594..54e2166a1e 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | Description | |:-----|:--------------|:----------------|:------------| 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 64b6f28c82..3c88067312 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 | |:-----|:---------|:------------| +| `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | -| `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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicemanagement/configs/index.md b/docs/google-docs/providers/google/servicemanagement/configs/index.md index e945644d22..539c04756f 100644 --- a/docs/google-docs/providers/google/servicemanagement/configs/index.md +++ b/docs/google-docs/providers/google/servicemanagement/configs/index.md @@ -29,31 +29,31 @@ 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. | -| `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 | -| `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. | -| `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. | -| `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. | -| `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 | | `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | -| `logs` | `array` | Defines the logs used by this service. | -| `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 | -| `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | -| `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. | | `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. | -| `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 | -| `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. | -| `producerProjectId` | `string` | The Google project that owns this service. | -| `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | +| `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. | +| `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. | | `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 | +| `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. | +| `sourceInfo` | `object` | Source information used to create a 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 | +| `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 | +| `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. | +| `usage` | `object` | Configuration controlling usage of a service. | | `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. | +| `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | +| `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 | +| `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. | +| `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. | | `metrics` | `array` | Defines the metrics used by this service. | -| `usage` | `object` | Configuration controlling usage of a service. | -| `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 | +| `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 | +| `backend` | `object` | `Backend` defines the backend configuration for a service. | +| `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | +| `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. | +| `logs` | `array` | Defines the logs used by this service. | +| `producerProjectId` | `string` | The Google project that owns this service. | | `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 | ## Methods | Name | Accessible by | Required Params | Description | 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 52c38009f2..0f8b25f928 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicemanagement/index.md b/docs/google-docs/providers/google/servicemanagement/index.md index fb2d398868..ce721d9270 100644 --- a/docs/google-docs/providers/google/servicemanagement/index.md +++ b/docs/google-docs/providers/google/servicemanagement/index.md @@ -33,7 +33,7 @@ Google Service Management Allows Service Producers To Publish Their Services On TypeService TitleService Management API DescriptionGoogle Service Management Allows Service Producers To Publish Their Services On Google Cloud Platform So That They Can Be Discovered And Used By Service Consumers. -Idservicemanagement:v23.08.00161 +Idservicemanagement:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/servicemanagement/operations/index.md b/docs/google-docs/providers/google/servicemanagement/operations/index.md index dd15feab3e..84c4e8a9a3 100644 --- a/docs/google-docs/providers/google/servicemanagement/operations/index.md +++ b/docs/google-docs/providers/google/servicemanagement/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/servicemanagement/rollouts/index.md b/docs/google-docs/providers/google/servicemanagement/rollouts/index.md index c4708db114..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 | |:-----|:---------|:------------| -| `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 6ebc2ed522..c8f8f9bf5a 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. | +| `producerProjectId` | `string` | The Google project that owns this service. | +| `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. | | `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 | -| `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 | -| `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. | -| `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. | -| `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. | -| `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | -| `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 | +| `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 | +| `logs` | `array` | Defines the logs used by this service. | | `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. | +| `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 | | `control` | `object` | Selects and configures the service controller used by the service. Example: control: environment: servicecontrol.googleapis.com | +| `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. | +| `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 | +| `usage` | `object` | Configuration controlling usage of a service. | +| `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 | | `backend` | `object` | `Backend` defines the backend configuration for a service. | -| `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. | +| `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. | | `sourceInfo` | `object` | Source information used to create a Service Config | -| `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. | -| `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. | +| `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. | | `metrics` | `array` | Defines the metrics used by this service. | | `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 | -| `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. | -| `logs` | `array` | Defines the logs used by this service. | -| `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. | +| `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. | | `monitoredResources` | `array` | Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. | -| `producerProjectId` | `string` | The Google project that owns this 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. | | `title` | `string` | The product title for this service, it is the name displayed in Google Cloud Console. | +| `configVersion` | `integer` | Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. | | `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 | -| `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. | -| `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 | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| 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 1434bbbc32..f23e597a65 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | +| `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 | 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 2c603711da..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 | |:-----|:---------|:------------| -| `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_zones/index.md b/docs/google-docs/providers/google/servicenetworking/dns_zones/index.md index 3ef47bf7b8..ea50114ebd 100644 --- a/docs/google-docs/providers/google/servicenetworking/dns_zones/index.md +++ b/docs/google-docs/providers/google/servicenetworking/dns_zones/index.md @@ -25,6 +25,10 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | +|:-----|:---------| +| `producerPrivateZone` | `object` | +| `consumerPeeringZone` | `object` | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/servicenetworking/index.md b/docs/google-docs/providers/google/servicenetworking/index.md index 90db48c111..a5cec16a32 100644 --- a/docs/google-docs/providers/google/servicenetworking/index.md +++ b/docs/google-docs/providers/google/servicenetworking/index.md @@ -33,7 +33,7 @@ Provides Automatic Management Of Network Configurations Necessary For Certain Se TypeService TitleService Networking API DescriptionProvides Automatic Management Of Network Configurations Necessary For Certain Services. -Idservicenetworking:v23.08.00161 +Idservicenetworking:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/servicenetworking/networks/index.md b/docs/google-docs/providers/google/servicenetworking/networks/index.md index 8b3d142c7e..5079bbe521 100644 --- a/docs/google-docs/providers/google/servicenetworking/networks/index.md +++ b/docs/google-docs/providers/google/servicenetworking/networks/index.md @@ -28,18 +28,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `usedIpRanges` | `array` | Output only. The IP ranges already in use by consumer or producer | -| `consumerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from consumer to producer. | -| `producerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from producer to consumer. | -| `consumerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from consumer to producer. | | `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. | -| `cloudsqlConfigs` | `array` | Represents one or multiple Cloud SQL configurations. | | `producerExportCustomRoutes` | `boolean` | Export custom routes 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. | | `producerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from producer to consumer. | -| `vpcScReferenceArchitectureEnabled` | `boolean` | Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network. | +| `consumerExportSubnetRoutesWithPublicIp` | `boolean` | Export subnet routes with public ip flag value for peering from consumer to producer. | +| `cloudsqlConfigs` | `array` | Represents one or multiple Cloud SQL configurations. | +| `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. | | `reservedRanges` | `array` | Output only. The reserved ranges associated with this private service access connection. | | `consumerImportSubnetRoutesWithPublicIp` | `boolean` | Import subnet routes with public ip flag value for peering from consumer to producer. | +| `producerImportCustomRoutes` | `boolean` | Import custom routes flag value for peering from producer to consumer. | +| `vpcScReferenceArchitectureEnabled` | `boolean` | Output only. Indicates whether the VPC Service Controls reference architecture is configured for the producer VPC host network. | ## 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 1be6d33af9..6ff0cda11a 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}`. | -| `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/serviceusage/index.md b/docs/google-docs/providers/google/serviceusage/index.md index 8f7a757ea2..d502b06d59 100644 --- a/docs/google-docs/providers/google/serviceusage/index.md +++ b/docs/google-docs/providers/google/serviceusage/index.md @@ -33,7 +33,7 @@ Enables Services That Service Consumers Want To Use On Google Cloud Platform, Li TypeService TitleService Usage API DescriptionEnables Services That Service Consumers Want To Use On Google Cloud Platform, Lists The Available Or Enabled Services, Or Disables Services That Service Consumers No Longer Use. -Idserviceusage:v23.08.00161 +Idserviceusage:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/serviceusage/services/index.md b/docs/google-docs/providers/google/serviceusage/services/index.md index f183ad57f6..3160cc83ec 100644 --- a/docs/google-docs/providers/google/serviceusage/services/index.md +++ b/docs/google-docs/providers/google/serviceusage/services/index.md @@ -38,4 +38,4 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `list` | `SELECT` | `parent` | List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project. WARNING: If you need to query enabled services frequently or across an organization, you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which provides higher throughput and richer filtering capability. | | `_list` | `EXEC` | `parent` | List all services available to the specified project, and the current state of those services with respect to the project. The list includes all public services, all services for which the calling user has the `servicemanagement.services.bind` permission, and all services that have already been enabled on the project. The list can be filtered to only include services in a specific state, for example to only include services enabled on the project. WARNING: If you need to query enabled services frequently or across an organization, you should use [Cloud Asset Inventory API](https://cloud.google.com/asset-inventory/docs/apis), which provides higher throughput and richer filtering capability. | | `batch_enable` | `EXEC` | `parent` | Enable multiple services on a project. The operation is atomic: if enabling any service fails, then the entire batch fails, and no state changes occur. To enable a single service, use the `EnableService` method instead. | -| `disable` | `EXEC` | `name` | Disable a service so that it can no longer be used with a project. This prevents unintended usage that may cause unexpected billing charges or security leaks. It is not valid to call the disable method on a service that is not currently enabled. Callers will receive a `FAILED_PRECONDITION` status if the target service is not currently enabled. | +| `enable` | `EXEC` | `name` | Enable a service so that it can be used with a project. | diff --git a/docs/google-docs/providers/google/sourcerepo/config/index.md b/docs/google-docs/providers/google/sourcerepo/config/index.md index d7185bb8a7..d3fc02c7d1 100644 --- a/docs/google-docs/providers/google/sourcerepo/config/index.md +++ b/docs/google-docs/providers/google/sourcerepo/config/index.md @@ -25,9 +25,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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 | Description | |:-----|:--------------|:----------------|:------------| -| `get_config` | `EXEC` | `projectsId` | Returns the Cloud Source Repositories configuration of the project. | +| `get_config` | `SELECT` | `projectsId` | Returns the Cloud Source Repositories configuration of the project. | | `update_config` | `EXEC` | `projectsId` | Updates the Cloud Source Repositories configuration of the project. | diff --git a/docs/google-docs/providers/google/sourcerepo/index.md b/docs/google-docs/providers/google/sourcerepo/index.md index a04226c88a..91d33726f7 100644 --- a/docs/google-docs/providers/google/sourcerepo/index.md +++ b/docs/google-docs/providers/google/sourcerepo/index.md @@ -20,7 +20,7 @@ Accesses Source Code Repositories Hosted By Google.
total resources: 3
-total selectable resources: 2
+total selectable resources: 3
total methods: 13
@@ -33,7 +33,7 @@ Accesses Source Code Repositories Hosted By Google. TypeService TitleCloud Source Repositories API DescriptionAccesses Source Code Repositories Hosted By Google. -Idsourcerepo:v23.08.00161 +Idsourcerepo:v23.08.00163 ## Resources 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 818b147bb3..4d8212e9e3 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,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## 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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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. | | `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 | 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 3ceb9ebfe2..ceafcaa7b2 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}`. | -| `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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/spanner/backups/index.md b/docs/google-docs/providers/google/spanner/backups/index.md index b07a14a90b..0f4973eb55 100644 --- a/docs/google-docs/providers/google/spanner/backups/index.md +++ b/docs/google-docs/providers/google/spanner/backups/index.md @@ -29,16 +29,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `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/`. | | `sizeBytes` | `string` | Output only. Size of the backup in bytes. | +| `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. | | `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/`. | | `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. | -| `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. | +| `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`. | | `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. | +| `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. | | `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`. | -| `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`. | | `encryptionInfo` | `object` | Encryption information for a Cloud Spanner database or backup. | +| `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. | | `databaseDialect` | `string` | Output only. The database dialect information for the backup. | -| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/database_operations/index.md b/docs/google-docs/providers/google/spanner/database_operations/index.md index 151ccb63c2..3bc52be6a9 100644 --- a/docs/google-docs/providers/google/spanner/database_operations/index.md +++ b/docs/google-docs/providers/google/spanner/database_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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/spanner/databases/index.md b/docs/google-docs/providers/google/spanner/databases/index.md index 3247b3e342..09033e96fa 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. | +| `databaseDialect` | `string` | Output only. The dialect of the Cloud Spanner Database. | +| `restoreInfo` | `object` | Information about the database restore. | +| `state` | `string` | Output only. The current database state. | +| `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. | | `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). | +| `reconciling` | `boolean` | Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. | +| `createTime` | `string` | Output only. If exists, the time at which the database creation started. | | `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. | -| `restoreInfo` | `object` | Information about the database restore. | | `encryptionConfig` | `object` | Encryption configuration for a Cloud Spanner database. | | `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. | -| `reconciling` | `boolean` | Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. | -| `databaseDialect` | `string` | Output only. The dialect of the 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. | -| `createTime` | `string` | Output only. If exists, the time at which the database creation started. | -| `state` | `string` | Output only. The current database state. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/spanner/databases_scans/index.md b/docs/google-docs/providers/google/spanner/databases_scans/index.md index ef7352c2e3..592c1f77c4 100644 --- a/docs/google-docs/providers/google/spanner/databases_scans/index.md +++ b/docs/google-docs/providers/google/spanner/databases_scans/index.md @@ -25,8 +25,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `name` | `string` | The unique name of the scan, specific to the Database service implementing this interface. | +| `scanData` | `object` | ScanData contains Cloud Key Visualizer scan data used by the caller to construct a visualization. | +| `startTime` | `string` | A range of time (inclusive) for when the scan is defined. The lower bound for when the scan is defined. | +| `details` | `object` | Additional information provided by the implementer. | +| `endTime` | `string` | The upper bound for when the scan is defined. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| -| `projects_instances_databases_get_scans` | `EXEC` | `databasesId, instancesId, projectsId` | +| `projects_instances_databases_get_scans` | `SELECT` | `databasesId, instancesId, projectsId` | diff --git a/docs/google-docs/providers/google/spanner/index.md b/docs/google-docs/providers/google/spanner/index.md index 76f5144da5..c1fd7fb976 100644 --- a/docs/google-docs/providers/google/spanner/index.md +++ b/docs/google-docs/providers/google/spanner/index.md @@ -20,7 +20,7 @@ Cloud Spanner Is A Managed, Mission-Critical, Globally Consistent And Scalable R
total resources: 17
-total selectable resources: 15
+total selectable resources: 16
total methods: 90
@@ -33,7 +33,7 @@ Cloud Spanner Is A Managed, Mission-Critical, Globally Consistent And Scalable R TypeService TitleCloud Spanner API DescriptionCloud Spanner Is A Managed, Mission-Critical, Globally Consistent And Scalable Relational Database Service. -Idspanner:v23.08.00161 +Idspanner:v23.08.00163 ## Resources 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 324f0b4367..8d9c7866d1 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}`. | -| `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 | |:-----|:--------------|:----------------| 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 fe25ed8c6d..3b57a53ce5 100644 --- a/docs/google-docs/providers/google/spanner/instance_configs/index.md +++ b/docs/google-docs/providers/google/spanner/instance_configs/index.md @@ -28,23 +28,23 @@ 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*`. | -| `leaderOptions` | `array` | Allowed values of the "default_leader" schema option for databases in instances that use this instance 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. | -| `optionalReplicas` | `array` | Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. | +| `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. | | `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. | +| `optionalReplicas` | `array` | Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. | +| `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. | +| `leaderOptions` | `array` | Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. | | `displayName` | `string` | The name of this instance configuration as it appears in UIs. | | `configType` | `string` | Output only. Whether this instance config is a Google or User Managed Configuration. | | `freeInstanceAvailability` | `string` | Output only. Describes whether free instances are available to be created in this instance config. | -| `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. | -| `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. | -| `state` | `string` | Output only. The current instance config state. Applicable only for USER_MANAGED configs. | +| `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. | | `replicas` | `array` | The geographic placement of nodes in this instance configuration and their replication properties. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_instance_configs_get` | `SELECT` | `instanceConfigsId, projectsId` | Gets information about a particular instance configuration. | | `projects_instance_configs_list` | `SELECT` | `projectsId` | Lists the supported instance configurations for a given project. | | `projects_instance_configs_create` | `INSERT` | `projectsId` | Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent. | | `projects_instance_configs_delete` | `DELETE` | `instanceConfigsId, projectsId` | Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name. | | `_projects_instance_configs_list` | `EXEC` | `projectsId` | Lists the supported instance configurations for a given project. | -| `projects_instance_configs_get` | `EXEC` | `instanceConfigsId, projectsId` | Gets information about a particular instance configuration. | | `projects_instance_configs_patch` | `EXEC` | `instanceConfigsId, projectsId` | Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name. | diff --git a/docs/google-docs/providers/google/spanner/instances/index.md b/docs/google-docs/providers/google/spanner/instances/index.md index c870122087..bce272f864 100644 --- a/docs/google-docs/providers/google/spanner/instances/index.md +++ b/docs/google-docs/providers/google/spanner/instances/index.md @@ -28,23 +28,23 @@ 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. | -| `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. | -| `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. | | `updateTime` | `string` | Output only. The time at which the instance was most recently updated. | +| `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. | +| `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. | +| `endpointUris` | `array` | Deprecated. This field is not populated. | | `instanceType` | `string` | The `InstanceType` of the current instance. | | `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. | -| `freeInstanceMetadata` | `object` | Free instance specific metadata that is kept even after an instance has been upgraded for tracking purposes. | -| `endpointUris` | `array` | Deprecated. This field is not populated. | | `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_instances_get` | `SELECT` | `instancesId, projectsId` | Gets information about a particular instance. | | `projects_instances_list` | `SELECT` | `projectsId` | Lists all instances in the given project. | | `projects_instances_create` | `INSERT` | `projectsId` | Creates an instance and begins preparing it to begin serving. The returned long-running operation can be used to track the progress of preparing the new instance. The instance name is assigned by the caller. If the named instance already exists, `CreateInstance` returns `ALREADY_EXISTS`. Immediately upon completion of this request: * The instance is readable via the API, with all requested attributes but no allocated resources. Its state is `CREATING`. Until completion of the returned operation: * Cancelling the operation renders the instance immediately unreadable via the API. * The instance can be deleted. * All other attempts to modify the instance are rejected. Upon completion of the returned operation: * Billing for all successfully-allocated resources begins (some types may have lower than the requested levels). * Databases can be created in the instance. * The instance's allocated resource levels are readable via the API. * The instance's state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance. The metadata field type is CreateInstanceMetadata. The response field type is Instance, if successful. | | `projects_instances_delete` | `DELETE` | `instancesId, projectsId` | Deletes an instance. Immediately upon completion of the request: * Billing ceases for all of the instance's reserved resources. Soon afterward: * The instance and *all of its databases* immediately and irrevocably disappear from the API. All data in the databases is permanently deleted. | | `_projects_instances_list` | `EXEC` | `projectsId` | Lists all instances in the given project. | -| `projects_instances_get` | `EXEC` | `instancesId, projectsId` | Gets information about a particular instance. | | `projects_instances_patch` | `EXEC` | `instancesId, projectsId` | Updates an instance, and begins allocating or releasing resources as requested. The returned long-running operation can be used to track the progress of updating the instance. If the named instance does not exist, returns `NOT_FOUND`. Immediately upon completion of this request: * For resource types for which a decrease in the instance's allocation has been requested, billing is based on the newly-requested level. Until completion of the returned operation: * Cancelling the operation sets its metadata's cancel_time, and begins restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance are rejected. * Reading the instance via the API continues to give the pre-request resource levels. Upon completion of the returned operation: * Billing begins for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources are available for serving the instance's tables. * The instance's new resource levels are readable via the API. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance modification. The metadata field type is UpdateInstanceMetadata. The response field type is Instance, if successful. Authorization requires `spanner.instances.update` permission on the resource name. | 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 0135a5c170..04655a39db 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 22f2c71a2b..299d7a69cc 100644 --- a/docs/google-docs/providers/google/spanner/operations/index.md +++ b/docs/google-docs/providers/google/spanner/operations/index.md @@ -28,17 +28,22 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_instance_configs_operations_get` | `SELECT` | `instanceConfigsId, 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. | | `projects_instance_configs_operations_list` | `SELECT` | `instanceConfigsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_instances_backups_operations_get` | `SELECT` | `backupsId, instancesId, 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. | | `projects_instances_backups_operations_list` | `SELECT` | `backupsId, instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_instances_databases_operations_get` | `SELECT` | `databasesId, instancesId, 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. | | `projects_instances_databases_operations_list` | `SELECT` | `databasesId, instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_instances_instance_partitions_operations_get` | `SELECT` | `instancePartitionsId, instancesId, 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. | | `projects_instances_instance_partitions_operations_list` | `SELECT` | `instancePartitionsId, instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_instances_operations_get` | `SELECT` | `instancesId, 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. | | `projects_instances_operations_list` | `SELECT` | `instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_instance_configs_operations_delete` | `DELETE` | `instanceConfigsId, operationsId, projectsId` | 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`. | | `projects_instances_backups_operations_delete` | `DELETE` | `backupsId, instancesId, operationsId, projectsId` | 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`. | @@ -51,12 +56,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `_projects_instances_instance_partitions_operations_list` | `EXEC` | `instancePartitionsId, instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `_projects_instances_operations_list` | `EXEC` | `instancesId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_instance_configs_operations_cancel` | `EXEC` | `instanceConfigsId, 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. 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`. | -| `projects_instance_configs_operations_get` | `EXEC` | `instanceConfigsId, 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. | | `projects_instances_backups_operations_cancel` | `EXEC` | `backupsId, instancesId, 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. 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`. | -| `projects_instances_backups_operations_get` | `EXEC` | `backupsId, instancesId, 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. | | `projects_instances_databases_operations_cancel` | `EXEC` | `databasesId, instancesId, 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. 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`. | -| `projects_instances_databases_operations_get` | `EXEC` | `databasesId, instancesId, 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. | | `projects_instances_instance_partitions_operations_cancel` | `EXEC` | `instancePartitionsId, instancesId, 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. 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`. | -| `projects_instances_instance_partitions_operations_get` | `EXEC` | `instancePartitionsId, instancesId, 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. | | `projects_instances_operations_cancel` | `EXEC` | `instancesId, 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. 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`. | -| `projects_instances_operations_get` | `EXEC` | `instancesId, 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. | diff --git a/docs/google-docs/providers/google/spanner/sessions/index.md b/docs/google-docs/providers/google/spanner/sessions/index.md index 4843a21bdb..ade93ca6cf 100644 --- a/docs/google-docs/providers/google/spanner/sessions/index.md +++ b/docs/google-docs/providers/google/spanner/sessions/index.md @@ -28,13 +28,14 @@ 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. | -| `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. | | `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_instances_databases_sessions_get` | `SELECT` | `databasesId, instancesId, projectsId, sessionsId` | Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive. | | `projects_instances_databases_sessions_list` | `SELECT` | `databasesId, instancesId, projectsId` | Lists all sessions in a given database. | | `projects_instances_databases_sessions_create` | `INSERT` | `databasesId, instancesId, projectsId` | Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions. Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit. Active sessions use additional server resources, so it is a good idea to delete idle and unneeded sessions. Aside from explicit deletes, Cloud Spanner may delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return `NOT_FOUND`. Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., `"SELECT 1"`. | | `projects_instances_databases_sessions_delete` | `DELETE` | `databasesId, instancesId, projectsId, sessionsId` | Ends a session, releasing server resources associated with it. This will asynchronously trigger cancellation of any operations that are running with this session. | @@ -45,7 +46,6 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `projects_instances_databases_sessions_execute_batch_dml` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Executes a batch of SQL DML statements. This method allows many statements to be run with lower latency than submitting them sequentially with ExecuteSql. Statements are executed in sequential order. A request can succeed even if a statement fails. The ExecuteBatchDmlResponse.status field in the response provides information about the statement that failed. Clients must inspect this field to determine whether an error occurred. Execution stops after the first failed statement; the remaining statements are not executed. | | `projects_instances_databases_sessions_execute_sql` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Executes an SQL statement, returning all results in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a `FAILED_PRECONDITION` error. Operations inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead. | | `projects_instances_databases_sessions_execute_streaming_sql` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB. | -| `projects_instances_databases_sessions_get` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Gets a session. Returns `NOT_FOUND` if the session does not exist. This is mainly useful for determining whether a session is still alive. | | `projects_instances_databases_sessions_partition_query` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Creates a set of partition tokens that can be used to execute a query operation in parallel. Each of the returned partition tokens can be used by ExecuteStreamingSql to specify a subset of the query result to read. The same session and read-only transaction must be used by the PartitionQueryRequest used to create the partition tokens and the ExecuteSqlRequests that use the partition tokens. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the query, and the whole operation must be restarted from the beginning. | | `projects_instances_databases_sessions_partition_read` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Creates a set of partition tokens that can be used to execute a read operation in parallel. Each of the returned partition tokens can be used by StreamingRead to specify a subset of the read result to read. The same session and read-only transaction must be used by the PartitionReadRequest used to create the partition tokens and the ReadRequests that use the partition tokens. There are no ordering guarantees on rows returned among the returned partition tokens, or even within each individual StreamingRead call issued with a partition_token. Partition tokens become invalid when the session used to create them is deleted, is idle for too long, begins a new transaction, or becomes too old. When any of these happen, it is not possible to resume the read, and the whole operation must be restarted from the beginning. | | `projects_instances_databases_sessions_read` | `EXEC` | `databasesId, instancesId, projectsId, sessionsId` | Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a `FAILED_PRECONDITION` error. Reads inside read-write transactions might return `ABORTED`. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details. Larger result sets can be yielded in streaming fashion by calling StreamingRead instead. | diff --git a/docs/google-docs/providers/google/speech/index.md b/docs/google-docs/providers/google/speech/index.md index 612947509f..e9633d8b17 100644 --- a/docs/google-docs/providers/google/speech/index.md +++ b/docs/google-docs/providers/google/speech/index.md @@ -33,7 +33,7 @@ Converts Audio To Text By Applying Powerful Neural Network Models. TypeService TitleCloud Speech-To-Text API DescriptionConverts Audio To Text By Applying Powerful Neural Network Models. -Idspeech:v23.08.00161 +Idspeech:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/speech/operations/index.md b/docs/google-docs/providers/google/speech/operations/index.md index 0d27b4ff85..fb2ee3a8fb 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}`. | +| `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/sqladmin/backup_runs/index.md b/docs/google-docs/providers/google/sqladmin/backup_runs/index.md index 1b9311df6e..a8abe0460f 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. | -| `location` | `string` | Location of the backups. | -| `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. | -| `selfLink` | `string` | The URI of this resource. | -| `timeZone` | `string` | Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server. | -| `instance` | `string` | Name of the database instance. | +| `error` | `object` | Database instance operation error. | | `status` | `string` | The status of this run. | | `diskEncryptionConfiguration` | `object` | Disk encryption configuration 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. | | `kind` | `string` | This is always `sql#backupRun`. | -| `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`. | -| `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`. | +| `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. | +| `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`. | +| `location` | `string` | Location of the backups. | +| `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`. | +| `instance` | `string` | Name of the database instance. | | `backupKind` | `string` | Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT. | -| `error` | `object` | Database instance operation error. | -| `diskEncryptionStatus` | `object` | Disk encryption status for an instance. | +| `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`. | +| `selfLink` | `string` | The URI of this resource. | +| `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`. | ## 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 a8c9bbb598..0525e4569c 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 | |:-----|:---------|:------------| -| `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. | | `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`. | ## 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 d6a0044294..b57fff025b 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. | +| `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. | | `kind` | `string` | This is always `sql#database`. | -| `sqlserverDatabaseDetails` | `object` | Represents a Sql Server database on the Cloud SQL instance. | -| `charset` | `string` | The Cloud SQL charset value. | | `selfLink` | `string` | The URI of this resource. | -| `etag` | `string` | This field is deprecated and will be removed from a future version of the API. | | `collation` | `string` | The Cloud SQL collation value. | -| `instance` | `string` | The name of the Cloud SQL instance. This does not include the project ID. | +| `etag` | `string` | This field is deprecated and will be removed from a future version of the API. | +| `charset` | `string` | The Cloud SQL charset value. | | `project` | `string` | The project ID of the project containing the Cloud SQL database. The Google apps domain is prefixed if applicable. | +| `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 0798e2964e..7cedb94b4a 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` | -| `allowedStringValues` | `array` | For `STRING` flags, a list of strings that the value can be set to. | -| `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`. | +| `minValue` | `string` | For `INTEGER` flags, the minimum allowed value. | +| `kind` | `string` | This is always `sql#flag`. | | `requiresRestart` | `boolean` | Indicates whether changing this flag will trigger a database restart. Only applicable to Second Generation instances. | +| `maxValue` | `string` | For `INTEGER` flags, the maximum allowed value. | | `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). | -| `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. | +| `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. | -| `maxValue` | `string` | For `INTEGER` flags, the maximum allowed value. | -| `kind` | `string` | This is always `sql#flag`. | -| `minValue` | `string` | For `INTEGER` flags, the minimum allowed value. | +| `inBeta` | `boolean` | Whether or not the flag is considered in beta. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/index.md b/docs/google-docs/providers/google/sqladmin/index.md index 0a2ee4da37..b26c781513 100644 --- a/docs/google-docs/providers/google/sqladmin/index.md +++ b/docs/google-docs/providers/google/sqladmin/index.md @@ -33,7 +33,7 @@ API For Cloud SQL Database Instance Management TypeService TitleCloud SQL Admin API DescriptionAPI For Cloud SQL Database Instance Management -Idsqladmin:v23.08.00161 +Idsqladmin:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/sqladmin/instances/index.md b/docs/google-docs/providers/google/sqladmin/instances/index.md index 30006c21c3..fbf2813c94 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. | -| `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. | -| `maxDiskSize` | `string` | The maximum disk size of the instance in bytes. | -| `instanceType` | `string` | The instance type. | -| `state` | `string` | The current serving state of the Cloud SQL instance. | -| `serviceAccountEmailAddress` | `string` | The service account email address assigned to the instance.\This property is read-only. | -| `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`. | -| `outOfDiskReport` | `object` | This message wraps up the information written by out-of-disk detection job. | | `suspensionReason` | `array` | If the instance state is SUSPENDED, the reason for the suspension. | -| `maintenanceVersion` | `string` | The current software version on the instance. | -| `scheduledMaintenance` | `object` | Any scheduled maintenance for this instance. | -| `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. | -| `failoverReplica` | `object` | The name and status of the failover replica. | | `diskEncryptionStatus` | `object` | Disk encryption status 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`. | -| `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. | -| `etag` | `string` | This field is deprecated and will be removed from a future version of the API. Use the `settings.settingsVersion` field instead. | -| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | -| `project` | `string` | The project ID of the project containing the Cloud SQL instance. The Google apps domain is prefixed if applicable. | -| `settings` | `object` | Database instance settings. | -| `onPremisesConfiguration` | `object` | On-premises instance configuration. | -| `dnsName` | `string` | Output only. The dns name of the instance. | -| `masterInstanceName` | `string` | The name of the instance which will act as primary in the replication setup. | -| `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. | | `availableMaintenanceVersions` | `array` | Output only. List all maintenance versions applicable on the instance | +| `settings` | `object` | Database instance settings. | +| `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. | +| `state` | `string` | The current serving state of the Cloud SQL instance. | +| `instanceType` | `string` | The instance type. | +| `outOfDiskReport` | `object` | This message wraps up the information written by out-of-disk detection job. | | `ipAddresses` | `array` | The assigned IP addresses for the instance. | | `serverCaCert` | `object` | SslCerts Resource | +| `connectionName` | `string` | Connection name of the Cloud SQL instance used in connection strings. | +| `dnsName` | `string` | Output only. The dns name of 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. | +| `databaseVersion` | `string` | The database engine type and version. The `databaseVersion` field cannot be changed after instance creation. | +| `serviceAccountEmailAddress` | `string` | The service account email address assigned to the instance.\This property is read-only. | +| `replicaConfiguration` | `object` | Read-replica configuration for connecting to the primary instance. | | `selfLink` | `string` | The URI of this resource. | -| `rootPassword` | `string` | Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. | +| `ipv6Address` | `string` | The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. | +| `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. | +| `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. | +| `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. | +| `masterInstanceName` | `string` | The name of the instance which will act as primary in the replication setup. | +| `scheduledMaintenance` | `object` | Any scheduled maintenance for this instance. | +| `replicaNames` | `array` | The replicas of the instance. | | `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. | | `satisfiesPzs` | `boolean` | The status indicating if instance satisfiesPzs. Reserved for future use. | -| `replicaNames` | `array` | The replicas of 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. | +| `onPremisesConfiguration` | `object` | On-premises instance configuration. | | `kind` | `string` | This is always `sql#instance`. | -| `connectionName` | `string` | Connection name of the Cloud SQL instance used in connection strings. | -| `ipv6Address` | `string` | The IPv6 address assigned to the instance. (Deprecated) This property was applicable only to First Generation instances. | -| `pscServiceAttachmentLink` | `string` | Output only. The link to service attachment of PSC instance. | +| `rootPassword` | `string` | Initial root password. Use only on creation. You must set root passwords before you can connect to PostgreSQL instances. | +| `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. | +| `failoverReplica` | `object` | The name and status of the failover replica. | +| `diskEncryptionConfiguration` | `object` | Disk encryption configuration for an instance. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/instances_latest_recovery_time/index.md b/docs/google-docs/providers/google/sqladmin/instances_latest_recovery_time/index.md index 20a8d52ce8..f1a29b4a77 100644 --- a/docs/google-docs/providers/google/sqladmin/instances_latest_recovery_time/index.md +++ b/docs/google-docs/providers/google/sqladmin/instances_latest_recovery_time/index.md @@ -27,8 +27,8 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `kind` | `string` | This is always `sql#getLatestRecoveryTime`. | | `latestRecoveryTime` | `string` | Timestamp, identifies the latest recovery time of the source instance. | +| `kind` | `string` | This is always `sql#getLatestRecoveryTime`. | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md b/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md index cbfb6bc9c7..da2f979679 100644 --- a/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md +++ b/docs/google-docs/providers/google/sqladmin/instances_server_cas/index.md @@ -27,9 +27,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields | Name | Datatype | Description | |:-----|:---------|:------------| -| `kind` | `string` | This is always `sql#instancesListServerCas`. | | `activeVersion` | `string` | | | `certs` | `array` | List of server CA certificates for the instance. | +| `kind` | `string` | This is always `sql#instancesListServerCas`. | ## 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 be2fd0ebe5..8b66f56bb5 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. | -| `targetProject` | `string` | The project ID of the target instance related to this operation. | -| `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` | +| `selfLink` | `string` | The URI of this resource. | +| `error` | `object` | Database instance operation errors list wrapper. | | `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`. | -| `exportContext` | `object` | Database instance export context. | -| `importContext` | `object` | Database instance import context. | -| `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`. | | `user` | `string` | The email address of the user who initiated this operation. | -| `error` | `object` | Database instance operation errors list wrapper. | -| `backupContext` | `object` | Backup context. | +| `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`. | -| `targetLink` | `string` | | +| `targetProject` | `string` | The project ID of the target instance related to this operation. | | `status` | `string` | The status of an operation. | -| `selfLink` | `string` | The URI of this resource. | -| `targetId` | `string` | Name of the database instance related to this operation. | +| `targetLink` | `string` | | +| `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. | +| `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. | ## 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 d626c098ae..11d5afd36b 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 | |:-----|:---------|:------------| +| `kind` | `string` | This is always `sql#sslCert`. | +| `cert` | `string` | PEM representation. | +| `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` | | `selfLink` | `string` | The URI of this resource. | | `sha1Fingerprint` | `string` | Sha1 Fingerprint. | +| `instance` | `string` | Name of the database instance. | | `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` | -| `commonName` | `string` | User supplied name. Constrained to [a-zA-Z.-_ ]+. | | `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`. | -| `instance` | `string` | Name of the database instance. | -| `kind` | `string` | This is always `sql#sslCert`. | -| `cert` | `string` | PEM representation. | +| `commonName` | `string` | User supplied name. Constrained to [a-zA-Z.-_ ]+. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/sqladmin/users/index.md b/docs/google-docs/providers/google/sqladmin/users/index.md index b061c27481..5a2fd61269 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. | -| `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. | -| `dualPasswordType` | `string` | Dual password status for the user. | -| `sqlserverUserDetails` | `object` | Represents a Sql Server user on the Cloud SQL instance. | -| `password` | `string` | The password for the user. | -| `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. | -| `kind` | `string` | This is always `sql#user`. | -| `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. | +| `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. | +| `kind` | `string` | This is always `sql#user`. | +| `password` | `string` | The password for the 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. | +| `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. | +| `sqlserverUserDetails` | `object` | Represents a Sql Server user on the Cloud SQL instance. | +| `dualPasswordType` | `string` | Dual password status for the user. | ## 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 e567691286..e6a269f5e4 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,16 +28,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `id` | `string` | The ID of 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. | +| `selfLink` | `string` | The link to this access-control entry. | | `bucket` | `string` | The name of the bucket. | | `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | -| `email` | `string` | The email address 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. | | `role` | `string` | The access permission for the entity. | | `domain` | `string` | The domain associated with the entity, if any. | -| `projectTeam` | `object` | The project team associated with the entity, if any. | -| `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. | | `kind` | `string` | The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl. | +| `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/buckets/index.md b/docs/google-docs/providers/google/storage/buckets/index.md index 7543a472a1..b35f3d4dd9 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. | -| `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. | -| `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. | -| `lifecycle` | `object` | The bucket's lifecycle configuration. See lifecycle management for more information. | -| `metageneration` | `string` | The metadata generation of this bucket. | -| `locationType` | `string` | The type of the bucket location. | +| `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. | +| `autoclass` | `object` | The bucket's Autoclass configuration. | | `projectNumber` | `string` | The project number of the project the bucket belongs to. | -| `labels` | `object` | User-provided labels, in key/value pairs. | -| `rpo` | `string` | The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a 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. | +| `metageneration` | `string` | The metadata generation of this bucket. | +| `selfLink` | `string` | The URI of this bucket. | +| `versioning` | `object` | The bucket's versioning configuration. | | `iamConfiguration` | `object` | The bucket's IAM configuration. | -| `encryption` | `object` | Encryption configuration for a bucket. | -| `timeCreated` | `string` | The creation time of the bucket in RFC 3339 format. | +| `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. | | `cors` | `array` | The bucket's Cross-Origin Resource Sharing (CORS) configuration. | -| `autoclass` | `object` | The bucket's Autoclass configuration. | +| `billing` | `object` | The bucket's billing configuration. | +| `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. | +| `encryption` | `object` | Encryption configuration for a bucket. | +| `owner` | `object` | The owner of the bucket. This is always the project team's owner group. | +| `customPlacementConfig` | `object` | The bucket's custom placement configuration for Custom Dual Regions. | +| `updated` | `string` | The modification time of the bucket in RFC 3339 format. | +| `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. | | `acl` | `array` | Access controls on the bucket. | -| `etag` | `string` | HTTP 1.1 Entity tag for the bucket. | +| `labels` | `object` | User-provided labels, in key/value pairs. | +| `rpo` | `string` | The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket. | | `logging` | `object` | The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs. | -| `defaultObjectAcl` | `array` | Default access controls to apply to new objects when no ACL is provided. | -| `customPlacementConfig` | `object` | The bucket's custom placement configuration for Custom Dual Regions. | -| `owner` | `object` | The owner of the bucket. This is always the project team's owner group. | +| `lifecycle` | `object` | The bucket's lifecycle configuration. See lifecycle management for more information. | +| `locationType` | `string` | The type of the bucket location. | | `satisfiesPZS` | `boolean` | Reserved for future use. | -| `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. | -| `updated` | `string` | The modification time of the bucket in RFC 3339 format. | -| `selfLink` | `string` | The URI of this bucket. | -| `versioning` | `object` | The bucket's versioning configuration. | -| `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. | -| `billing` | `object` | The bucket's billing configuration. | -| `kind` | `string` | The kind of item this is. For buckets, this is always storage#bucket. | +| `etag` | `string` | HTTP 1.1 Entity tag for the bucket. | +| `timeCreated` | `string` | The creation time of the bucket in RFC 3339 format. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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 5b470a3e41..c3d1a6097c 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. | -| `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. | -| `email` | `string` | The email address associated with the entity, if any. | -| `selfLink` | `string` | The link to this access-control entry. | -| `entityId` | `string` | The ID for the entity, if any. | -| `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | -| `projectTeam` | `object` | The project team associated with the entity, if any. | | `role` | `string` | The access permission for the entity. | | `generation` | `string` | The content generation of the object, if applied to an object. | -| `object` | `string` | The name of the object, if applied to an object. | | `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. | +| `etag` | `string` | HTTP 1.1 Entity tag for the access-control entry. | +| `entityId` | `string` | The ID for the entity, if any. | | `bucket` | `string` | The name of the bucket. | +| `object` | `string` | The name of the object, if applied to an object. | +| `projectTeam` | `object` | The project team associated with the entity, if any. | +| `selfLink` | `string` | The link to this access-control entry. | +| `email` | `string` | The email address associated with the entity, if any. | +| `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 bb4aa14c25..992e0606ef 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. | +| `accessId` | `string` | The ID of the HMAC Key. | | `selfLink` | `string` | The link to this resource. | -| `serviceAccountEmail` | `string` | The email address of the key's associated service account. | +| `updated` | `string` | The last modification time of the HMAC key metadata in RFC 3339 format. | | `timeCreated` | `string` | The creation time of the HMAC key in RFC 3339 format. | +| `serviceAccountEmail` | `string` | The email address of the key's associated service account. | | `kind` | `string` | The kind of item this is. For HMAC Key metadata, this is always storage#hmacKeyMetadata. | +| `etag` | `string` | HTTP 1.1 Entity tag for the HMAC key. | | `projectId` | `string` | Project ID owning the service account to which the key authenticates. | -| `updated` | `string` | The last modification time of the HMAC key metadata in RFC 3339 format. | -| `accessId` | `string` | The ID of the HMAC Key. | | `state` | `string` | The state of the key. Can be one of ACTIVE, INACTIVE, or DELETED. | -| `etag` | `string` | HTTP 1.1 Entity tag for the HMAC key. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/index.md b/docs/google-docs/providers/google/storage/index.md index 72e8df00e3..1ec0a70453 100644 --- a/docs/google-docs/providers/google/storage/index.md +++ b/docs/google-docs/providers/google/storage/index.md @@ -33,7 +33,7 @@ Stores And Retrieves Potentially Large, Immutable Data Objects. TypeService TitleCloud Storage JSON API DescriptionStores And Retrieves Potentially Large, Immutable Data Objects. -Idstorage:v23.08.00161 +Idstorage:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/storage/notifications/index.md b/docs/google-docs/providers/google/storage/notifications/index.md index f0c4e1391b..ebfc9b8d46 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. | -| `kind` | `string` | The kind of item this is. For notifications, this is always storage#notification. | -| `etag` | `string` | HTTP 1.1 Entity tag for this subscription notification. | -| `event_types` | `array` | If present, only send notifications about listed event types. If empty, sent notifications for all event types. | -| `topic` | `string` | The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' | | `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. | | `selfLink` | `string` | The canonical URL of this notification. | +| `topic` | `string` | The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}' | +| `event_types` | `array` | If present, only send notifications about listed event types. If empty, sent notifications for all event types. | | `object_name_prefix` | `string` | If present, only apply this notification configuration to object names that begin with this prefix. | | `payload_format` | `string` | The desired content of the Payload. | +| `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 226b2b0fe3..3b0d6d9252 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 @@ -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. | -| `selfLink` | `string` | The link to this access-control entry. | -| `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. | -| `generation` | `string` | The content generation of the object, if applied to an object. | +| `bucket` | `string` | The name of the bucket. | +| `projectTeam` | `object` | The project team 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. | -| `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. | +| `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. | +| `email` | `string` | The email address associated with the entity, if any. | | `object` | `string` | The name of the object, if applied to an object. | +| `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. | | `role` | `string` | The access permission for the entity. | -| `email` | `string` | The email address associated with the entity, if any. | +| `domain` | `string` | The domain associated with the entity, if any. | +| `selfLink` | `string` | The link to this access-control entry. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/storage/objects/index.md b/docs/google-docs/providers/google/storage/objects/index.md index c9ed1b449b..cde69cab41 100644 --- a/docs/google-docs/providers/google/storage/objects/index.md +++ b/docs/google-docs/providers/google/storage/objects/index.md @@ -25,6 +25,40 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `id` | `string` | The ID of the object, including the bucket name, object name, and generation number. | +| `name` | `string` | The name of the object. Required if not specified by URL parameter. | +| `storageClass` | `string` | Storage class of the object. | +| `bucket` | `string` | The name of the bucket containing this object. | +| `mediaLink` | `string` | Media download link. | +| `md5Hash` | `string` | MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices. | +| `customerEncryption` | `object` | Metadata of customer-supplied encryption key, if the object is encrypted by such a key. | +| `timeCreated` | `string` | The creation time of the object in RFC 3339 format. | +| `metageneration` | `string` | The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object. | +| `retentionExpirationTime` | `string` | A server-determined value that specifies the earliest time that the object's retention period expires. This value is in RFC 3339 format. Note 1: This field is not provided for objects with an active event-based hold, since retention expiration is unknown until the hold is removed. Note 2: This value can be provided even when temporary hold is set (so that the user can reason about policy without having to first unset the temporary hold). | +| `timeStorageClassUpdated` | `string` | The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated. | +| `cacheControl` | `string` | Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600. | +| `kind` | `string` | The kind of item this is. For objects, this is always storage#object. | +| `timeDeleted` | `string` | The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. | +| `contentType` | `string` | Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream. | +| `contentEncoding` | `string` | Content-Encoding of the object data. | +| `eventBasedHold` | `boolean` | Whether an object is under event-based hold. Event-based hold is a way to retain objects until an event occurs, which is signified by the hold's release (i.e. this value is set to false). After being released (set to false), 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 the 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. | +| `selfLink` | `string` | The link to this object. | +| `temporaryHold` | `boolean` | Whether an object is under temporary hold. While this flag is set to true, the object is protected against deletion and overwrites. A common use case of this flag is regulatory investigations where objects need to be retained while the investigation is ongoing. Note that unlike event-based hold, temporary hold does not impact retention expiration time of an object. | +| `size` | `string` | Content-Length of the data in bytes. | +| `updated` | `string` | The modification time of the object metadata in RFC 3339 format. Set initially to object creation time and then updated whenever any metadata of the object changes. This includes changes made by a requester, such as modifying custom metadata, as well as changes made by Cloud Storage on behalf of a requester, such as changing the storage class based on an Object Lifecycle Configuration. | +| `crc32c` | `string` | CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices. | +| `owner` | `object` | The owner of the object. This will always be the uploader of the object. | +| `generation` | `string` | The content generation of this object. Used for object versioning. | +| `contentDisposition` | `string` | Content-Disposition of the object data. | +| `metadata` | `object` | User-provided metadata, in key/value pairs. | +| `componentCount` | `integer` | Number of underlying components that make up this object. Components are accumulated by compose operations. | +| `acl` | `array` | Access controls on the object. | +| `kmsKeyName` | `string` | Not currently supported. Specifying the parameter causes the request to fail with status code 400 - Bad Request. | +| `contentLanguage` | `string` | Content-Language of the object data. | +| `etag` | `string` | HTTP 1.1 Entity tag for the object. | +| `customTime` | `string` | A timestamp in RFC 3339 format specified by the user for an object. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| 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/index.md b/docs/google-docs/providers/google/storagetransfer/index.md index 1ef82393bc..bcf7c754e4 100644 --- a/docs/google-docs/providers/google/storagetransfer/index.md +++ b/docs/google-docs/providers/google/storagetransfer/index.md @@ -33,7 +33,7 @@ Transfers Data From External Data Sources To A Google Cloud Storage Bucket Or Be TypeService TitleStorage Transfer API DescriptionTransfers Data From External Data Sources To A Google Cloud Storage Bucket Or Between Google Cloud Storage Buckets. -Idstoragetransfer:v23.08.00161 +Idstoragetransfer:v23.08.00163 ## Resources 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 c019319b4c..76eb17381e 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. | -| `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`. | -| `schedule` | `object` | Transfers can be scheduled to recur or to run just once. | -| `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. | -| `projectId` | `string` | The ID of the Google Cloud project that owns the job. | | `transferSpec` | `object` | Configuration for running a transfer. | -| `creationTime` | `string` | Output only. The time that the transfer job was created. | -| `lastModificationTime` | `string` | Output only. The time that the transfer job was last modified. | | `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`. | | `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. | +| `creationTime` | `string` | Output only. The time that the transfer job was created. | +| `lastModificationTime` | `string` | Output only. The time that the transfer job was last modified. | +| `projectId` | `string` | The ID of the Google Cloud project that owns the job. | +| `deletionTime` | `string` | Output only. The time that the transfer job was deleted. | +| `schedule` | `object` | Transfers can be scheduled to recur or to run just once. | | `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. | +| `eventStream` | `object` | Specifies the Event-driven transfer options. Event-driven transfers listen to an event stream to transfer updated files. | ## 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 507198a4b0..b8237aa39f 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`. | -| `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. | | `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/testing/index.md b/docs/google-docs/providers/google/testing/index.md index 33e5b4f8a5..2419318471 100644 --- a/docs/google-docs/providers/google/testing/index.md +++ b/docs/google-docs/providers/google/testing/index.md @@ -33,7 +33,7 @@ Allows Developers To Run Automated Tests For Their Mobile Applications On Google TypeService TitleCloud Testing API DescriptionAllows Developers To Run Automated Tests For Their Mobile Applications On Google Infrastructure. -Idtesting:v23.08.00161 +Idtesting:v23.08.00163 ## Resources 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 32f33c7bc4..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 | |:-----|:---------|:------------| -| `androidDeviceCatalog` | `object` | The currently supported Android devices. | | `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. | ## 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 13cad5c064..f4b5d37e39 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 | |:-----|:---------|:------------| -| `testSpecification` | `object` | A description of how to run the test. | -| `resultStorage` | `object` | Locations where the results of running the test are stored. | -| `testMatrixId` | `string` | Output only. Unique id set by the service. | -| `outcomeSummary` | `string` | Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. | -| `invalidMatrixDetails` | `string` | Output only. Describes why the matrix is considered invalid. Only useful for matrices in the INVALID state. | -| `timestamp` | `string` | Output only. The time this test matrix was initially created. | | `clientInfo` | `object` | Information about the client which invoked the test. | -| `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. | | `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. | | `state` | `string` | Output only. Indicates the current progress of the test matrix. | | `projectId` | `string` | The cloud project that owns the test matrix. | -| `testExecutions` | `array` | Output only. The list of test executions that the service creates for this 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. | +| `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. | +| `testMatrixId` | `string` | Output only. Unique id set by the service. | +| `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. | +| `outcomeSummary` | `string` | Output Only. The overall outcome of the test. Only set when the test matrix state is FINISHED. | +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/texttospeech/index.md b/docs/google-docs/providers/google/texttospeech/index.md index eabde78fbf..f443dacd8e 100644 --- a/docs/google-docs/providers/google/texttospeech/index.md +++ b/docs/google-docs/providers/google/texttospeech/index.md @@ -33,7 +33,7 @@ Synthesizes Natural-Sounding Speech By Applying Powerful Neural Network Models. TypeService TitleCloud Text-To-Speech API DescriptionSynthesizes Natural-Sounding Speech By Applying Powerful Neural Network Models. -Idtexttospeech:v23.08.00161 +Idtexttospeech:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/texttospeech/operations/index.md b/docs/google-docs/providers/google/texttospeech/operations/index.md index 5cd51eb4fe..762d8c2c14 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/index.md b/docs/google-docs/providers/google/tpu/index.md index 40e1c86b19..b66442126f 100644 --- a/docs/google-docs/providers/google/tpu/index.md +++ b/docs/google-docs/providers/google/tpu/index.md @@ -33,7 +33,7 @@ TPU API Provides Customers With Access To Google TPU Technology. TypeService TitleCloud TPU API DescriptionTPU API Provides Customers With Access To Google TPU Technology. -Idtpu:v23.08.00161 +Idtpu:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/tpu/locations/index.md b/docs/google-docs/providers/google/tpu/locations/index.md index 7e1a2f3cb4..06bc6fbd2c 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"` | -| `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/tpu/nodes/index.md b/docs/google-docs/providers/google/tpu/nodes/index.md index 7066f61510..904a9fc59c 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. | -| `queuedResource` | `string` | Output only. The qualified name of the QueuedResource that requested 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. | -| `createTime` | `string` | Output only. The time when the node was created. | -| `metadata` | `object` | Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script | -| `runtimeVersion` | `string` | Required. The runtime version running in the Node. | -| `health` | `string` | The health status of the TPU node. | | `multisliceNode` | `boolean` | Output only. Whether the Node belongs to a Multislice group. | +| `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. | | `tags` | `array` | Tags to apply to the TPU Node. Tags are used to identify valid sources or targets for network firewalls. | -| `state` | `string` | Output only. The current state for the TPU Node. | +| `health` | `string` | The health status of the TPU node. | +| `networkConfig` | `object` | Network related configurations. | +| `metadata` | `object` | Custom metadata to apply to the TPU Node. Can set startup-script and shutdown-script | +| `acceleratorConfig` | `object` | A TPU accelerator configuration. | | `acceleratorType` | `string` | Optional. The type of hardware accelerators associated with this node. | -| `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. | +| `createTime` | `string` | Output only. The time when the node was created. | +| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | | `dataDisks` | `array` | The additional data disks for the Node. | -| `apiVersion` | `string` | Output only. The API version that created this Node. | | `serviceAccount` | `object` | A service account. | -| `shieldedInstanceConfig` | `object` | A set of Shielded Instance options. | | `symptoms` | `array` | Output only. The Symptoms that have occurred to the TPU Node. | -| `schedulingConfig` | `object` | Sets the scheduling options for this node. | -| `networkConfig` | `object` | Network related configurations. | | `labels` | `object` | Resource labels to represent user-provided metadata. | -| `acceleratorConfig` | `object` | A TPU accelerator configuration. | +| `schedulingConfig` | `object` | Sets the scheduling options for this node. | +| `state` | `string` | Output only. The current state for 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. | +| `runtimeVersion` | `string` | Required. The runtime version running in the Node. | +| `queuedResource` | `string` | Output only. The qualified name of the QueuedResource that requested this Node. | | `healthDescription` | `string` | Output only. If this field is populated, it contains a description of why the TPU Node is unhealthy. | +| `apiVersion` | `string` | Output only. The API version that created 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 38e6d14a31..7d1cef575b 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}`. | +| `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/trafficdirector/index.md b/docs/google-docs/providers/google/trafficdirector/index.md index e7ed82033d..fa248ccea7 100644 --- a/docs/google-docs/providers/google/trafficdirector/index.md +++ b/docs/google-docs/providers/google/trafficdirector/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleTraffic Director API Description -Idtrafficdirector:v23.08.00161 +Idtrafficdirector:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/transcoder/index.md b/docs/google-docs/providers/google/transcoder/index.md index c9e9f5334c..7c3e78d564 100644 --- a/docs/google-docs/providers/google/transcoder/index.md +++ b/docs/google-docs/providers/google/transcoder/index.md @@ -33,7 +33,7 @@ This API Converts Video Files Into Formats Suitable For Consumer Distribution. F TypeService TitleTranscoder API DescriptionThis API Converts Video Files Into Formats Suitable For Consumer Distribution. For More Information, See The Transcoder API Overview. -Idtranscoder:v23.08.00161 +Idtranscoder:v23.08.00163 ## Resources 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 1c635b152a..97fc74a5ef 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}` | -| `config` | `object` | Job configuration | | `labels` | `object` | The labels associated with this job template. You can use these to organize and group your job templates. | +| `config` | `object` | Job configuration | ## 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 c7468b0df6..4dd0069c02 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}` | -| `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}` | -| `labels` | `object` | The labels associated with this job. You can use these to organize and group your jobs. | -| `optimization` | `string` | Optional. The optimization strategy of the job. The default is `AUTODETECT`. | -| `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). | -| `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. | -| `mode` | `string` | The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`. | -| `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). | -| `startTime` | `string` | Output only. The time the transcoding started. | | `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). | -| `createTime` | `string` | Output only. The time the job was created. | +| `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). | +| `mode` | `string` | The processing mode of the job. The default is `PROCESSING_MODE_INTERACTIVE`. | +| `optimization` | `string` | Optional. The optimization strategy of the job. The default is `AUTODETECT`. | | `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. | +| `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. | | `endTime` | `string` | Output only. The time the transcoding finished. | | `state` | `string` | Output only. The current state of the job. | | `config` | `object` | Job configuration | +| `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). | +| `startTime` | `string` | Output only. The time the transcoding started. | +| `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. | ## 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 2c78dc819f..7331fe639e 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}` | -| `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. | -| `sourceLanguageCode` | `string` | The BCP-47 language code of the source language. | -| `testExampleCount` | `integer` | Output only. Number of test examples (sentence pairs). | | `trainExampleCount` | `integer` | Output only. Number of training examples (sentence pairs). | +| `testExampleCount` | `integer` | Output only. Number of test examples (sentence pairs). | | `createTime` | `string` | Output only. Timestamp when this dataset was created. | | `updateTime` | `string` | Output only. Timestamp when this dataset was last updated. | +| `validateExampleCount` | `integer` | Output only. Number of validation examples (sentence pairs). | +| `sourceLanguageCode` | `string` | The BCP-47 language code of the source language. | | `exampleCount` | `integer` | Output only. The number of examples in the dataset. | +| `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. | -| `validateExampleCount` | `integer` | Output only. Number of validation examples (sentence pairs). | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/glossaries/index.md b/docs/google-docs/providers/google/translate/glossaries/index.md index 86617cf582..222749fc6c 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}`. | +| `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. | | `inputConfig` | `object` | Input configuration for glossaries. | -| `languageCodesSet` | `object` | Used with equivalent term set glossaries. | -| `languagePair` | `object` | Used with unidirectional glossaries. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/translate/index.md b/docs/google-docs/providers/google/translate/index.md index b6d9de0041..28cfc0b2a5 100644 --- a/docs/google-docs/providers/google/translate/index.md +++ b/docs/google-docs/providers/google/translate/index.md @@ -33,7 +33,7 @@ Integrates Text Translation Into Your Website Or Application. TypeService TitleCloud Translation API DescriptionIntegrates Text Translation Into Your Website Or Application. -Idtranslate:v23.08.00161 +Idtranslate:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/translate/locations/index.md b/docs/google-docs/providers/google/translate/locations/index.md index d1d26479cb..29e8c7fb1e 100644 --- a/docs/google-docs/providers/google/translate/locations/index.md +++ b/docs/google-docs/providers/google/translate/locations/index.md @@ -35,12 +35,12 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `projects_locations_get` | `SELECT` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_list` | `SELECT` | `projectsId` | Lists information about the supported locations for this service. | | `_projects_locations_list` | `EXEC` | `projectsId` | Lists information about the supported locations for this service. | | `projects_locations_batch_translate_document` | `EXEC` | `locationsId, projectsId` | Translates a large volume of document in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call. | | `projects_locations_batch_translate_text` | `EXEC` | `locationsId, projectsId` | Translates a large volume of text in asynchronous batch mode. This function provides real-time output as the inputs are being processed. If caller cancels a request, the partial results (for an input file, it's all or nothing) may still be available on the specified output location. This call returns immediately and you can use google.longrunning.Operation.name to poll the status of the call. | | `projects_locations_detect_language` | `EXEC` | `locationsId, projectsId` | Detects the language of text within a request. | -| `projects_locations_get` | `EXEC` | `locationsId, projectsId` | Gets information about a location. | | `projects_locations_romanize_text` | `EXEC` | `locationsId, projectsId` | Romanize input text written in non-Latin scripts to Latin text. | | `projects_locations_translate_document` | `EXEC` | `locationsId, projectsId` | Translates documents in synchronous mode. | | `projects_locations_translate_text` | `EXEC` | `locationsId, projectsId` | Translates input text and returns translated text. | diff --git a/docs/google-docs/providers/google/translate/models/index.md b/docs/google-docs/providers/google/translate/models/index.md index fb2daf0407..16e0680b7f 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}` | -| `targetLanguageCode` | `string` | Output only. The BCP-47 language code of the target language. | -| `sourceLanguageCode` | `string` | Output only. The BCP-47 language code of the source 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}` | +| `createTime` | `string` | Output only. Timestamp when the model resource was created, which is also when the training started. | | `trainExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to train the model. | -| `testExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to test the model. | | `updateTime` | `string` | Output only. Timestamp when this model was last updated. | +| `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. | +| `targetLanguageCode` | `string` | Output only. The BCP-47 language code of the target language. | | `validateExampleCount` | `integer` | Output only. Number of examples (sentence pairs) used to validate the model. | | `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. | -| `createTime` | `string` | Output only. Timestamp when the model resource was created, which is also when the training started. | -| `dataset` | `string` | The dataset from which the model is trained, in form of `projects/{project-number-or-id}/locations/{location_id}/datasets/{dataset_id}` | ## 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 4af56d75af..6e2a03acbb 100644 --- a/docs/google-docs/providers/google/translate/operations/index.md +++ b/docs/google-docs/providers/google/translate/operations/index.md @@ -28,16 +28,16 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | | `projects_locations_operations_wait` | `EXEC` | `locationsId, operationsId, projectsId` | Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. | diff --git a/docs/google-docs/providers/google/videointelligence/index.md b/docs/google-docs/providers/google/videointelligence/index.md index 427957d1e8..cb5ffb4e44 100644 --- a/docs/google-docs/providers/google/videointelligence/index.md +++ b/docs/google-docs/providers/google/videointelligence/index.md @@ -20,7 +20,7 @@ Detects Objects, Explicit Content, And Scene Changes In Videos. It Also Specifie
total resources: 3
-total selectable resources: 1
+total selectable resources: 2
total methods: 9
@@ -33,7 +33,7 @@ Detects Objects, Explicit Content, And Scene Changes In Videos. It Also Specifie TypeService TitleCloud Video Intelligence API DescriptionDetects Objects, Explicit Content, And Scene Changes In Videos. It Also Specifies The Region For Annotation And Transcribes Speech To Text. Supports Both Asynchronous API And Streaming API. -Idvideointelligence:v23.08.00161 +Idvideointelligence:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/videointelligence/long_running_operations/index.md b/docs/google-docs/providers/google/videointelligence/long_running_operations/index.md index e1140407c9..a47d0eb55a 100644 --- a/docs/google-docs/providers/google/videointelligence/long_running_operations/index.md +++ b/docs/google-docs/providers/google/videointelligence/long_running_operations/index.md @@ -25,10 +25,16 @@ image: /img/providers/google/stackql-google-provider-featured-image.png ## Fields -`SELECT` not supported for this resource, use `SHOW METHODS` to view available operations for the resource and then invoke a supported method using the `EXEC` command +| Name | Datatype | Description | +|:-----|:---------|:------------| +| `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. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| +| `operations_projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `operations_projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `operations_projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `operations_projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/videointelligence/operations/index.md b/docs/google-docs/providers/google/videointelligence/operations/index.md index 4fe537156b..c41fcf912e 100644 --- a/docs/google-docs/providers/google/videointelligence/operations/index.md +++ b/docs/google-docs/providers/google/videointelligence/operations/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, 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 | |:-----|:--------------|:----------------|:------------| +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | | `projects_locations_operations_list` | `SELECT` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_delete` | `DELETE` | `locationsId, operationsId, projectsId` | 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`. | | `_projects_locations_operations_list` | `EXEC` | `locationsId, projectsId` | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | | `projects_locations_operations_cancel` | `EXEC` | `locationsId, 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. 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`. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | diff --git a/docs/google-docs/providers/google/vision/index.md b/docs/google-docs/providers/google/vision/index.md index c2d778034f..afeb2f811e 100644 --- a/docs/google-docs/providers/google/vision/index.md +++ b/docs/google-docs/providers/google/vision/index.md @@ -33,7 +33,7 @@ Integrates Google Vision Features, Including Image Labeling, Face, Logo, And Lan TypeService TitleCloud Vision API DescriptionIntegrates Google Vision Features, Including Image Labeling, Face, Logo, And Landmark Detection, Optical Character Recognition (OCR), And Detection Of Explicit Content, Into Applications. -Idvision:v23.08.00161 +Idvision:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/vision/operations/index.md b/docs/google-docs/providers/google/vision/operations/index.md index 5d0112f487..52a3b0c888 100644 --- a/docs/google-docs/providers/google/vision/operations/index.md +++ b/docs/google-docs/providers/google/vision/operations/index.md @@ -28,18 +28,18 @@ 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 | |:-----|:--------------|:----------------|:------------| +| `locations_operations_get` | `SELECT` | `locationsId, 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. | +| `operations_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. | | `operations_list` | `SELECT` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | +| `projects_locations_operations_get` | `SELECT` | `locationsId, 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. | +| `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. | | `operations_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`. | | `_operations_list` | `EXEC` | | Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. | -| `locations_operations_get` | `EXEC` | `locationsId, 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. | | `operations_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`. | -| `operations_get` | `EXEC` | `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. | -| `projects_locations_operations_get` | `EXEC` | `locationsId, 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. | -| `projects_operations_get` | `EXEC` | `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. | diff --git a/docs/google-docs/providers/google/vision/product_sets/index.md b/docs/google-docs/providers/google/vision/product_sets/index.md index b93bd87ee5..12f44d4d37 100644 --- a/docs/google-docs/providers/google/vision/product_sets/index.md +++ b/docs/google-docs/providers/google/vision/product_sets/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 ProductSet. Format is: `projects/PROJECT_ID/locations/LOC_ID/productSets/PRODUCT_SET_ID`. This field is ignored when creating a ProductSet. | +| `indexTime` | `string` | Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. | | `displayName` | `string` | The user-provided name for this ProductSet. Must not be empty. Must be at most 4096 characters long. | | `indexError` | `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). | -| `indexTime` | `string` | Output only. The time at which this ProductSet was last indexed. Query results will reflect all updates before this time. If this ProductSet has never been indexed, this timestamp is the default value "1970-01-01T00:00:00Z". This field is ignored when creating a ProductSet. | ## 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 35bef9b1a0..72c97e4df7 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. | +| `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. | | `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. | ## 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 9a18856ae7..fd2d47f2fc 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. | -| `createTime` | `string` | Output only. The time the clone job was created (as an API call, not when it was actually created in the target). | +| `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. | -| `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). | -| `steps` | `array` | Output only. The clone steps list representing its progress. | +| `createTime` | `string` | Output only. The time the clone job was created (as an API call, not when it was actually created in the target). | | `endTime` | `string` | Output only. The time the clone job was ended. | -| `stateTime` | `string` | Output only. The time the state was last updated. | +| `state` | `string` | Output only. State of the clone job. | +| `steps` | `array` | Output only. The clone 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). | ## 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 a47bd8bb55..9a16d7085c 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. | -| `createTime` | `string` | Output only. The time the cutover job was created (as an API call, not when it was actually created in the target). | -| `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. | | `steps` | `array` | Output only. The cutover steps list representing its progress. | -| `computeEngineDisksTargetDetails` | `object` | ComputeEngineDisksTargetDetails is a collection of created Persistent Disks details. | | `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). | -| `progressPercent` | `integer` | Output only. The current progress in percentage of the cutover job. | -| `stateMessage` | `string` | Output only. A message providing possible extra details about the current state. | +| `state` | `string` | Output only. State of the cutover job. | | `stateTime` | `string` | Output only. The time the state was last updated. | +| `createTime` | `string` | Output only. The time the cutover job was created (as an API call, not when it was actually created in the target). | | `endTime` | `string` | Output only. The time the cutover job had finished. | -| `state` | `string` | Output only. State of the cutover job. | +| `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. | +| `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/datacenter_connectors/index.md b/docs/google-docs/providers/google/vmmigration/datacenter_connectors/index.md index a1779d05f7..14b975fe7c 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. | -| `version` | `string` | The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified. | -| `createTime` | `string` | Output only. The time the connector was created (as an API call, not when it was actually installed). | -| `updateTime` | `string` | Output only. The last time the connector was updated with an API call. | -| `serviceAccount` | `string` | The service account to use in the connector when communicating with 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). | | `bucket` | `string` | Output only. The communication channel between the datacenter connector and Google Cloud. | -| `availableVersions` | `object` | Holds informatiom about the available versions for upgrade. | +| `updateTime` | `string` | Output only. The last time the connector was updated with an API call. | | `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. | | `applianceSoftwareVersion` | `string` | Output only. Appliance last installed update bundle version. This is the version of the automatically updatable components on the appliance. | | `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. | -| `state` | `string` | Output only. State of the DatacenterConnector, as determined by the health checks. | | `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). | | `upgradeStatus` | `object` | UpgradeStatus contains information about upgradeAppliance operation. | +| `version` | `string` | The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified. | +| `availableVersions` | `object` | Holds informatiom about the available versions for upgrade. | +| `serviceAccount` | `string` | The service account to use in the connector when communicating with the cloud. | +| `state` | `string` | Output only. State of the DatacenterConnector, as determined by the health checks. | +| `createTime` | `string` | Output only. The time the connector was created (as an API call, not when it was actually installed). | ## 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 e96ecd552a..b8cba03875 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. | +| `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/index.md b/docs/google-docs/providers/google/vmmigration/index.md index 2d9126b2af..344080f281 100644 --- a/docs/google-docs/providers/google/vmmigration/index.md +++ b/docs/google-docs/providers/google/vmmigration/index.md @@ -33,7 +33,7 @@ Use The Migrate To Virtual Machines API To Programmatically Migrate Workloads. TypeService TitleVM Migration API DescriptionUse The Migrate To Virtual Machines API To Programmatically Migrate Workloads. -Idvmmigration:v23.08.00161 +Idvmmigration:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/vmmigration/locations/index.md b/docs/google-docs/providers/google/vmmigration/locations/index.md index 120132bad9..20c7df290a 100644 --- a/docs/google-docs/providers/google/vmmigration/locations/index.md +++ b/docs/google-docs/providers/google/vmmigration/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/vmmigration/migrating_vms/index.md b/docs/google-docs/providers/google/vmmigration/migrating_vms/index.md index d50d704675..786b4093db 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. | +| `stateTime` | `string` | Output only. The last time the migrating VM state was updated. | +| `computeEngineDisksTargetDefaults` | `object` | ComputeEngineDisksTargetDefaults is a collection of details for creating Persistent Disks in a target Compute Engine project. | +| `displayName` | `string` | The display name attached to the MigratingVm by the user. | +| `lastReplicationCycle` | `object` | ReplicationCycle contains information about the current replication cycle status. | | `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). | +| `lastSync` | `object` | ReplicationSync contain information about the last replica sync to the cloud. | +| `labels` | `object` | The labels of the migrating VM. | +| `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. | | `awsSourceVmDetails` | `object` | Represent the source AWS VM details. | | `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. | | `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. State of the MigratingVm. | -| `stateTime` | `string` | Output only. The last time the migrating VM state was updated. | -| `computeEngineTargetDefaults` | `object` | ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. | -| `lastReplicationCycle` | `object` | ReplicationCycle contains information about the current replication cycle status. | -| `policy` | `object` | A policy for scheduling replications. | +| `cutoverForecast` | `object` | CutoverForecast holds information about future CutoverJobs of a MigratingVm. | | `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. | -| `displayName` | `string` | The display name attached to the MigratingVm by the user. | -| `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-. | | `currentSyncInfo` | `object` | ReplicationCycle contains information about the current replication cycle status. | -| `cutoverForecast` | `object` | CutoverForecast holds information about future CutoverJobs of a MigratingVm. | +| `state` | `string` | Output only. State of the MigratingVm. | +| `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-. | | `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. | -| `lastSync` | `object` | ReplicationSync contain information about the last replica sync to the cloud. | -| `labels` | `object` | The labels of the migrating VM. | -| `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. | +| `policy` | `object` | A policy for scheduling replications. | +| `computeEngineTargetDefaults` | `object` | ComputeEngineTargetDefaults is a collection of details for creating a VM in a target Compute Engine project. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/operations/index.md b/docs/google-docs/providers/google/vmmigration/operations/index.md index e341722daa..1b07501f6f 100644 --- a/docs/google-docs/providers/google/vmmigration/operations/index.md +++ b/docs/google-docs/providers/google/vmmigration/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 | 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 0cc780bcc6..c29f93b767 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. | -| `endTime` | `string` | The time the replication cycle has ended. | | `cycleNumber` | `integer` | The cycle's ordinal number. | -| `state` | `string` | State of the ReplicationCycle. | -| `steps` | `array` | The cycle's steps list representing its progress. | | `startTime` | `string` | The time the replication cycle has started. | -| `totalPauseDuration` | `string` | The accumulated duration the replication cycle was paused. | | `warnings` | `array` | Output only. Warnings that occurred during the cycle. | +| `totalPauseDuration` | `string` | The accumulated duration the replication cycle was paused. | +| `endTime` | `string` | The time the replication cycle has ended. | | `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). | | `progressPercent` | `integer` | The current progress in percentage of this cycle. Was replaced by 'steps' field, which breaks down the cycle progression more accurately. | +| `steps` | `array` | The cycle's steps list representing its progress. | +| `state` | `string` | State of the ReplicationCycle. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/sources/index.md b/docs/google-docs/providers/google/vmmigration/sources/index.md index 93f77d3d9b..66591b813b 100644 --- a/docs/google-docs/providers/google/vmmigration/sources/index.md +++ b/docs/google-docs/providers/google/vmmigration/sources/index.md @@ -29,11 +29,11 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The Source name. | | `description` | `string` | User-provided description of the source. | +| `updateTime` | `string` | Output only. The update time timestamp. | +| `vmware` | `object` | VmwareSourceDetails message describes a specific source details for the vmware source type. | | `aws` | `object` | AwsSourceDetails message describes a specific source details for the AWS source type. | | `createTime` | `string` | Output only. The create time timestamp. | | `labels` | `object` | The labels of the source. | -| `updateTime` | `string` | Output only. The update time timestamp. | -| `vmware` | `object` | VmwareSourceDetails message describes a specific source details for the vmware source type. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vmmigration/target_projects/index.md b/docs/google-docs/providers/google/vmmigration/target_projects/index.md index aab06398f9..ee528f2599 100644 --- a/docs/google-docs/providers/google/vmmigration/target_projects/index.md +++ b/docs/google-docs/providers/google/vmmigration/target_projects/index.md @@ -29,9 +29,9 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Output only. The name of the target project. | | `description` | `string` | The target project's description. | +| `project` | `string` | The target project ID (number) or project name. | | `updateTime` | `string` | Output only. The last time the target project resource was updated. | | `createTime` | `string` | Output only. The time this target project resource was created (not related to when the Compute Engine project it points to was created). | -| `project` | `string` | The target project ID (number) or project name. | ## 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 fdec5cfdcc..24ab27b9a9 100644 --- a/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md +++ b/docs/google-docs/providers/google/vmmigration/utilization_reports/index.md @@ -28,14 +28,14 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Output only. The report unique 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). | -| `displayName` | `string` | The report display name, as assigned by the user. | -| `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. | -| `stateTime` | `string` | Output only. The time the state was last set. | | `timeFrame` | `string` | Time frame of the report. | -| `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). | +| `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). | | `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. | +| `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). | +| `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. | | `vmCount` | `integer` | Output only. Total number of VMs included in the report. | +| `stateTime` | `string` | Output only. The time the state was last set. | +| `displayName` | `string` | The report display name, as assigned by the user. | | `state` | `string` | Output only. Current state of the report. | ## 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 662aad6256..a5a1eaa13e 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/*`. | -| `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. If both min-throughput and min-instances are provided, min-instances takes precedence over min-throughput. | +| `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. | +| `ipCidrRange` | `string` | The range of internal addresses that follows RFC 4632 notation. Example: `10.132.0.0/28`. | | `maxInstances` | `integer` | Maximum value of instances in autoscaling group underlying the connector. | +| `machineType` | `string` | Machine type of VM Instance underlying connector. Default is e2-micro | +| `connectedProjects` | `array` | Output only. List of projects using 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`. | -| `minThroughput` | `integer` | Minimum throughput of the connector in Mbps. Default and min is 200. | +| `maxThroughput` | `integer` | Maximum throughput of the connector in Mbps. Default is 300, max is 1000. If both max-throughput and max-instances are provided, max-instances takes precedence over max-throughput. | | `minInstances` | `integer` | Minimum value of instances in autoscaling group underlying the connector. | -| `machineType` | `string` | Machine type of VM Instance underlying connector. Default is e2-micro | -| `network` | `string` | Name of a VPC network. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/vpcaccess/index.md b/docs/google-docs/providers/google/vpcaccess/index.md index c4d201ef62..302176afb4 100644 --- a/docs/google-docs/providers/google/vpcaccess/index.md +++ b/docs/google-docs/providers/google/vpcaccess/index.md @@ -33,7 +33,7 @@ API For Managing VPC Access Connectors. TypeService TitleServerless VPC Access API DescriptionAPI For Managing VPC Access Connectors. -Idvpcaccess:v23.08.00161 +Idvpcaccess:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/vpcaccess/locations/index.md b/docs/google-docs/providers/google/vpcaccess/locations/index.md index 2fcf1f134f..4bbccd318a 100644 --- a/docs/google-docs/providers/google/vpcaccess/locations/index.md +++ b/docs/google-docs/providers/google/vpcaccess/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 | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/vpcaccess/operations/index.md b/docs/google-docs/providers/google/vpcaccess/operations/index.md index efb1beed40..c311ade84b 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}`. | +| `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. | +| `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/webrisk/index.md b/docs/google-docs/providers/google/webrisk/index.md index 17a795301a..c770100371 100644 --- a/docs/google-docs/providers/google/webrisk/index.md +++ b/docs/google-docs/providers/google/webrisk/index.md @@ -33,7 +33,7 @@ image: /img/providers/google/stackql-google-provider-featured-image.png TypeService TitleWeb Risk API Description -Idwebrisk:v23.08.00161 +Idwebrisk:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/webrisk/operations/index.md b/docs/google-docs/providers/google/webrisk/operations/index.md index 5d2266e771..5320962bde 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. | -| `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. | | `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. | ## 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 488f81a4ee..f1ae409db7 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 ee65fb0342..e761bba11f 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. | -| `finalUrl` | `string` | Output only. The URL where the browser lands when the vulnerability is detected. | -| `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. | -| `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. | | `vulnerableParameters` | `object` | Information about vulnerable request parameters. | -| `httpMethod` | `string` | Output only. The http method of the request that triggered the vulnerability, in uppercase. | | `body` | `string` | Output only. The body of the request that triggered the vulnerability. | -| `outdatedLibrary` | `object` | Information reported for an outdated library. | +| `reproductionUrl` | `string` | Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. | +| `httpMethod` | `string` | Output only. The http method of the request that triggered the vulnerability, in uppercase. | +| `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 | | `xss` | `object` | Information reported for an XSS. | +| `outdatedLibrary` | `object` | Information reported for an outdated library. | +| `vulnerableHeaders` | `object` | Information about vulnerable or missing HTTP Headers. | | `frameUrl` | `string` | Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. | -| `trackingId` | `string` | Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. | | `form` | `object` | ! Information about a vulnerability with an HTML. | +| `finalUrl` | `string` | Output only. The URL where the browser lands when the vulnerability is detected. | +| `severity` | `string` | Output only. The severity level of the reported vulnerability. | | `violatingResource` | `object` | Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. | -| `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. | +| `fuzzedUrl` | `string` | Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. | +| `trackingId` | `string` | Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/websecurityscanner/index.md b/docs/google-docs/providers/google/websecurityscanner/index.md index a857666274..7bc8b6b456 100644 --- a/docs/google-docs/providers/google/websecurityscanner/index.md +++ b/docs/google-docs/providers/google/websecurityscanner/index.md @@ -33,7 +33,7 @@ Scans Your Compute And App Engine Apps For Common Web Vulnerabilities. TypeService TitleWeb Security Scanner API DescriptionScans Your Compute And App Engine Apps For Common Web Vulnerabilities. -Idwebsecurityscanner:v23.08.00161 +Idwebsecurityscanner:v23.08.00163 ## Resources 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 4ade545eea..dfacca1841 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. | -| `staticIpScan` | `boolean` | Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. | -| `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 | -| `displayName` | `string` | Required. The user provided display name of the ScanConfig. | -| `managedScan` | `boolean` | Whether the scan config is managed by Web Security Scanner, output only. | -| `ignoreHttpStatusErrors` | `boolean` | Whether to keep scanning even if most requests return HTTP error codes. | -| `exportToSecurityCommandCenter` | `string` | Controls export of scan configurations and results to Security Command Center. | -| `userAgent` | `string` | The user agent used during scanning. | +| `schedule` | `object` | Scan schedule configuration. | | `authentication` | `object` | Scan authentication configuration. | +| `ignoreHttpStatusErrors` | `boolean` | Whether to keep scanning even if most requests return HTTP error codes. | | `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. | +| `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 | | `riskLevel` | `string` | The risk level selected for the scan | -| `schedule` | `object` | Scan schedule configuration. | +| `displayName` | `string` | Required. The user provided display name of the ScanConfig. | +| `staticIpScan` | `boolean` | Whether the scan configuration has enabled static IP address scan feature. If enabled, the scanner will access applications from static IP addresses. | +| `userAgent` | `string` | The user agent used during scanning. | +| `managedScan` | `boolean` | Whether the scan config is managed by Web Security Scanner, output only. | | `startingUrls` | `array` | Required. The starting URLs from which the scanner finds site pages. | +| `exportToSecurityCommandCenter` | `string` | Controls export of scan configurations and results to Security Command Center. | ## 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 658cb91ee6..351a133cc4 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. | -| `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". | -| `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. | -| `warningTraces` | `array` | Output only. A list of warnings, if such are encountered during this scan run. | -| `hasVulnerabilities` | `boolean` | Output only. Whether the scan run has found any vulnerabilities. | +| `endTime` | `string` | Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. | | `startTime` | `string` | Output only. The time at which the ScanRun started. | | `errorTrace` | `object` | Output only. Defines an error trace message for a ScanRun. | +| `warningTraces` | `array` | Output only. A list of warnings, if such are encountered during this scan run. | | `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. | -| `endTime` | `string` | Output only. The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user. | +| `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. | +| `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. | | `executionState` | `string` | Output only. The execution state of the ScanRun. | +| `hasVulnerabilities` | `boolean` | Output only. Whether the scan run has found any vulnerabilities. | ## 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 02c78c56ad..05bad74a0f 100644 --- a/docs/google-docs/providers/google/workflowexecutions/executions/index.md +++ b/docs/google-docs/providers/google/workflowexecutions/executions/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 execution. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution} | | `endTime` | `string` | Output only. Marks the end of execution, successful or not. | +| `duration` | `string` | Output only. Measures the duration of the 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\"}"}'` | +| `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. | | `stateError` | `object` | Describes an error related to the current state of the Execution resource. | | `workflowRevisionId` | `string` | Output only. Revision of the workflow this execution is using. | -| `status` | `object` | Represents the current status of this execution. | -| `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`. | | `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. | -| `duration` | `string` | Output only. Measures the duration of 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\"}"}'` | | `callLogLevel` | `string` | The call logging level associated to this execution. | +| `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`. | +| `status` | `object` | Represents the current status of this execution. | | `state` | `string` | Output only. Current state of the execution. | ## Methods | Name | Accessible by | Required Params | Description | diff --git a/docs/google-docs/providers/google/workflowexecutions/index.md b/docs/google-docs/providers/google/workflowexecutions/index.md index af02624cfe..f511e61591 100644 --- a/docs/google-docs/providers/google/workflowexecutions/index.md +++ b/docs/google-docs/providers/google/workflowexecutions/index.md @@ -33,7 +33,7 @@ Execute Workflows Created With Workflows API. TypeService TitleWorkflow Executions API DescriptionExecute Workflows Created With Workflows API. -Idworkflowexecutions:v23.08.00161 +Idworkflowexecutions:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/workflows/index.md b/docs/google-docs/providers/google/workflows/index.md index cfc416a629..85f2b6d4b2 100644 --- a/docs/google-docs/providers/google/workflows/index.md +++ b/docs/google-docs/providers/google/workflows/index.md @@ -33,7 +33,7 @@ Manage Workflow Definitions. To Execute Workflows And Manage Executions, See The TypeService TitleWorkflows API DescriptionManage Workflow Definitions. To Execute Workflows And Manage Executions, See The Workflows Executions API. -Idworkflows:v23.08.00161 +Idworkflows:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/workflows/locations/index.md b/docs/google-docs/providers/google/workflows/locations/index.md index abfa76ce21..9febd6769d 100644 --- a/docs/google-docs/providers/google/workflows/locations/index.md +++ b/docs/google-docs/providers/google/workflows/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/workflows/operations/index.md b/docs/google-docs/providers/google/workflows/operations/index.md index 2389a662ea..b82e7b8e92 100644 --- a/docs/google-docs/providers/google/workflows/operations/index.md +++ b/docs/google-docs/providers/google/workflows/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 | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workflows/workflows/index.md b/docs/google-docs/providers/google/workflows/workflows/index.md index 8807fd5f69..c561d49862 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. | -| `revisionCreateTime` | `string` | Output only. The timestamp for the latest revision of the workflow's creation. | -| `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. | -| `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. | -| `state` | `string` | Output only. State of the workflow deployment. | -| `sourceContents` | `string` | Workflow code to be executed. The size limit is 128KB. | -| `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. | -| `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. | -| `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. | +| `state` | `string` | Output only. State of the workflow deployment. | | `updateTime` | `string` | Output only. The timestamp for when the workflow was last updated. | +| `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. | +| `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. | | `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. | -| `stateError` | `object` | Describes an error related to the current state of the workflow. | +| `sourceContents` | `string` | Workflow code to be executed. The size limit is 128KB. | +| `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. | +| `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". | ## 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 992ff4c5df..68b1a27114 100644 --- a/docs/google-docs/providers/google/workloadmanager/evaluations/index.md +++ b/docs/google-docs/providers/google/workloadmanager/evaluations/index.md @@ -30,14 +30,14 @@ 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 | | `resourceStatus` | `object` | Message describing resource status | -| `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. | -| `labels` | `object` | Labels as key value pairs | -| `resourceFilter` | `object` | Message describing resource filters | +| `createTime` | `string` | Output only. [Output only] Create time stamp | | `ruleVersions` | `array` | Output only. [Output only] The updated rule ids if exist. | | `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 * *", | +| `resourceFilter` | `object` | Message describing resource filters | +| `ruleNames` | `array` | the name of the rule | | `updateTime` | `string` | Output only. [Output only] Update time stamp | +| `labels` | `object` | Labels as key value pairs | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workloadmanager/executions/index.md b/docs/google-docs/providers/google/workloadmanager/executions/index.md index 60e27f5244..b5436fadba 100644 --- a/docs/google-docs/providers/google/workloadmanager/executions/index.md +++ b/docs/google-docs/providers/google/workloadmanager/executions/index.md @@ -28,13 +28,13 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} | -| `labels` | `object` | Labels as key value pairs | | `runType` | `string` | type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. | | `startTime` | `string` | Output only. [Output only] Start time stamp | | `state` | `string` | Output only. [Output only] State | | `endTime` | `string` | Output only. [Output only] End time stamp | | `evaluationId` | `string` | Output only. [Output only] Evaluation ID | | `inventoryTime` | `string` | Output only. [Output only] Inventory time stamp | +| `labels` | `object` | Labels as key value pairs | ## Methods | Name | Accessible by | Required Params | Description | |:-----|:--------------|:----------------|:------------| diff --git a/docs/google-docs/providers/google/workloadmanager/index.md b/docs/google-docs/providers/google/workloadmanager/index.md index 0216a6987f..cd329dbbc3 100644 --- a/docs/google-docs/providers/google/workloadmanager/index.md +++ b/docs/google-docs/providers/google/workloadmanager/index.md @@ -33,7 +33,7 @@ Workload Manager Is A Service That Provides Tooling For Enterprise Workloads To TypeService TitleWorkload Manager API DescriptionWorkload Manager Is A Service That Provides Tooling For Enterprise Workloads To Automate The Deployment And Validation Of Your Workloads Against Best Practices And Recommendations. -Idworkloadmanager:v23.08.00161 +Idworkloadmanager:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/workloadmanager/locations/index.md b/docs/google-docs/providers/google/workloadmanager/locations/index.md index 70ff38f06d..535a4becb8 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"` | -| `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/workloadmanager/results/index.md b/docs/google-docs/providers/google/workloadmanager/results/index.md index d636394072..3bdc32485e 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 | |:-----|:---------|:------------| +| `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 | | `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 | ## 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 72b8ae9a8c..893b44d3ee 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 | +| `secondaryCategory` | `string` | the secondary category | | `primaryCategory` | `string` | the primary category | | `revisionId` | `string` | Output only. the version of the rule | +| `severity` | `string` | the severity of the rule | | `uri` | `string` | the docuement url for the rule | -| `displayName` | `string` | the name display in UI | -| `errorMessage` | `string` | the message template for rule | | `remediation` | `string` | the remediation for the rule | -| `severity` | `string` | the severity of the rule | -| `secondaryCategory` | `string` | the secondary category | +| `errorMessage` | `string` | the message template for rule | +| `displayName` | `string` | the name display in UI | ## Methods | Name | Accessible by | Required Params | |:-----|:--------------|:----------------| diff --git a/docs/google-docs/providers/google/workstations/index.md b/docs/google-docs/providers/google/workstations/index.md index 0f998011d7..62164fe6c4 100644 --- a/docs/google-docs/providers/google/workstations/index.md +++ b/docs/google-docs/providers/google/workstations/index.md @@ -33,7 +33,7 @@ Allows Administrators To Create Managed Developer Environments In The Cloud. TypeService TitleCloud Workstations API DescriptionAllows Administrators To Create Managed Developer Environments In The Cloud. -Idworkstations:v23.08.00161 +Idworkstations:v23.08.00163 ## Resources diff --git a/docs/google-docs/providers/google/workstations/operations/index.md b/docs/google-docs/providers/google/workstations/operations/index.md index 77ff6e76dc..a90169509b 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, 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/workstations/workstation_clusters/index.md b/docs/google-docs/providers/google/workstations/workstation_clusters/index.md index 5180adeda3..2b9b8dbcf3 100644 --- a/docs/google-docs/providers/google/workstations/workstation_clusters/index.md +++ b/docs/google-docs/providers/google/workstations/workstation_clusters/index.md @@ -30,18 +30,18 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | `name` | `string` | Full name of this workstation cluster. | | `etag` | `string` | Optional. 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. | | `controlPlaneIp` | `string` | Output only. The private IP address of the control plane for this workstation 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. | -| `subnetwork` | `string` | Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. | -| `uid` | `string` | Output only. A system-assigned unique identifier for this workstation cluster. | | `labels` | `object` | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. | -| `displayName` | `string` | Optional. Human-readable name for this workstation cluster. | | `reconciling` | `boolean` | Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. | | `privateClusterConfig` | `object` | Configuration options for private workstation clusters. | +| `subnetwork` | `string` | Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. | | `annotations` | `object` | Optional. Client-specified annotations. | -| `createTime` | `string` | Output only. Time when this workstation cluster was created. | -| `network` | `string` | Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. | | `deleteTime` | `string` | Output only. Time when this workstation cluster was soft-deleted. | -| `degraded` | `boolean` | Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. | +| `createTime` | `string` | Output only. Time when this workstation cluster was created. | | `conditions` | `array` | Output only. Status conditions describing the workstation cluster's current state. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this workstation cluster. | +| `degraded` | `boolean` | Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. | +| `displayName` | `string` | Optional. Human-readable name for this workstation cluster. | +| `network` | `string` | Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. | | `updateTime` | `string` | Output only. Time when this workstation cluster was most recently updated. | ## 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 ba5932997b..354ea35283 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 workstation configuration. | -| `conditions` | `array` | Output only. Status conditions describing the current resource state. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this workstation configuration. | | `reconciling` | `boolean` | Output only. Indicates whether this workstation configuration is currently being updated to match its intended state. | -| `etag` | `string` | Optional. 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. | -| `annotations` | `object` | Optional. Client-specified annotations. | -| `idleTimeout` | `string` | Optional. 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). | -| `enableAuditAgent` | `boolean` | Optional. 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` | Optional. Directories to persist across workstation sessions. | -| `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). | -| `container` | `object` | A Docker container. | -| `updateTime` | `string` | Output only. Time when this workstation configuration was most recently updated. | | `deleteTime` | `string` | Output only. Time when this workstation configuration was soft-deleted. | +| `enableAuditAgent` | `boolean` | Optional. 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). | +| `etag` | `string` | Optional. 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. | | `readinessChecks` | `array` | Optional. 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. | +| `updateTime` | `string` | Output only. Time when this workstation configuration was most recently updated. | +| `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). | +| `host` | `object` | Runtime host for a workstation. | | `labels` | `object` | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. | -| `uid` | `string` | Output only. A system-assigned unique identifier for this workstation configuration. | -| `displayName` | `string` | Optional. Human-readable name for this workstation configuration. | +| `annotations` | `object` | Optional. Client-specified annotations. | +| `container` | `object` | A Docker container. | | `createTime` | `string` | Output only. Time when this workstation configuration was created. | -| `runningTimeout` | `string` | Optional. 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 idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field 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 `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` 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. | -| `host` | `object` | Runtime host for a workstation. | | `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. | +| `persistentDirectories` | `array` | Optional. Directories to persist across workstation sessions. | +| `runningTimeout` | `string` | Optional. 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 idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field 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 `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` 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. | +| `displayName` | `string` | Optional. Human-readable name for this workstation configuration. | +| `idleTimeout` | `string` | Optional. 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). | +| `conditions` | `array` | Output only. Status conditions describing the current resource state. | ## 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 a2df977bf9..79e873e250 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 workstation configuration. | -| `deleteTime` | `string` | Output only. Time when this workstation configuration was soft-deleted. | -| `updateTime` | `string` | Output only. Time when this workstation configuration was most recently updated. | -| `conditions` | `array` | Output only. Status conditions describing the current resource state. | -| `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). | -| `etag` | `string` | Optional. 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. | -| `persistentDirectories` | `array` | Optional. Directories to persist across workstation sessions. | | `annotations` | `object` | Optional. Client-specified annotations. | | `displayName` | `string` | Optional. Human-readable name for this workstation configuration. | -| `enableAuditAgent` | `boolean` | Optional. 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). | +| `etag` | `string` | Optional. 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. | | `container` | `object` | A Docker container. | -| `idleTimeout` | `string` | Optional. 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 workstation configuration was created. | -| `host` | `object` | Runtime host for a workstation. | | `readinessChecks` | `array` | Optional. 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 workstation configuration. | -| `runningTimeout` | `string` | Optional. 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 idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field 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 `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` 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. | -| `reconciling` | `boolean` | Output only. Indicates whether this workstation configuration is currently being updated to match its intended state. | +| `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). | +| `createTime` | `string` | Output only. Time when this workstation configuration was created. | +| `idleTimeout` | `string` | Optional. 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). | | `labels` | `object` | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation configuration and that are also propagated to the underlying Compute Engine resources. | | `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. | +| `runningTimeout` | `string` | Optional. 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 idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field 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 `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` 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. | +| `conditions` | `array` | Output only. Status conditions describing the current resource state. | +| `reconciling` | `boolean` | Output only. Indicates whether this workstation configuration is currently being updated to match its intended state. | +| `host` | `object` | Runtime host for a workstation. | +| `enableAuditAgent` | `boolean` | Optional. 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). | +| `deleteTime` | `string` | Output only. Time when this workstation configuration was soft-deleted. | +| `persistentDirectories` | `array` | Optional. Directories to persist across workstation sessions. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this workstation configuration. | +| `updateTime` | `string` | Output only. Time when this workstation configuration was most recently updated. | ## 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 04812d5ae7..4692520610 100644 --- a/docs/google-docs/providers/google/workstations/workstations/index.md +++ b/docs/google-docs/providers/google/workstations/workstations/index.md @@ -29,17 +29,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png |:-----|:---------|:------------| | `name` | `string` | Full name of this workstation. | | `annotations` | `object` | Optional. Client-specified annotations. | -| `reconciling` | `boolean` | Output only. Indicates whether this workstation is currently being updated to match its intended state. | -| `uid` | `string` | Output only. A system-assigned unique identifier for this 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}`. | +| `updateTime` | `string` | Output only. Time when this workstation was most recently updated. | | `deleteTime` | `string` | Output only. Time when this workstation was soft-deleted. | -| `env` | `object` | Optional. Environment variables passed to the workstation container's entrypoint. | -| `displayName` | `string` | Optional. Human-readable name for this workstation. | | `etag` | `string` | Optional. 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. | | `labels` | `object` | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources. | -| `state` | `string` | Output only. Current state of the workstation. | -| `updateTime` | `string` | Output only. Time when this workstation was most recently updated. | +| `reconciling` | `boolean` | Output only. Indicates whether this workstation is currently being updated to match its intended state. | +| `displayName` | `string` | Optional. Human-readable name for this workstation. | +| `env` | `object` | Optional. Environment variables passed to the workstation container's entrypoint. | +| `uid` | `string` | Output only. A system-assigned unique identifier for this 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}`. | | `createTime` | `string` | Output only. Time when this workstation was created. | +| `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_usable/index.md b/docs/google-docs/providers/google/workstations/workstations_usable/index.md index 65ed90bbbe..b50d5a2ade 100644 --- a/docs/google-docs/providers/google/workstations/workstations_usable/index.md +++ b/docs/google-docs/providers/google/workstations/workstations_usable/index.md @@ -28,17 +28,17 @@ image: /img/providers/google/stackql-google-provider-featured-image.png | Name | Datatype | Description | |:-----|:---------|:------------| | `name` | `string` | Full name of this workstation. | -| `reconciling` | `boolean` | Output only. Indicates whether this workstation is currently being updated to match its intended state. | | `uid` | `string` | Output only. A system-assigned unique identifier for this workstation. | -| `updateTime` | `string` | Output only. Time when this workstation was most recently updated. | -| `deleteTime` | `string` | Output only. Time when this workstation was soft-deleted. | -| `displayName` | `string` | Optional. Human-readable name for this workstation. | +| `createTime` | `string` | Output only. Time when this workstation was created. | +| `etag` | `string` | Optional. 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. | | `state` | `string` | Output only. Current state of the workstation. | +| `displayName` | `string` | Optional. Human-readable name for this workstation. | +| `reconciling` | `boolean` | Output only. Indicates whether this workstation is currently being updated to match its intended state. | | `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}`. | -| `etag` | `string` | Optional. 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. | | `env` | `object` | Optional. Environment variables passed to the workstation container's entrypoint. | +| `deleteTime` | `string` | Output only. Time when this workstation was soft-deleted. | | `annotations` | `object` | Optional. Client-specified annotations. | -| `createTime` | `string` | Output only. Time when this workstation was created. | +| `updateTime` | `string` | Output only. Time when this workstation was most recently updated. | | `labels` | `object` | Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation and that are also propagated to the underlying Compute Engine resources. | ## Methods | Name | Accessible by | Required Params |