Gcp/deepreview
@swamp/gcp/deepreviewv2026.10.23.1
01README
Google Cloud deepreview infrastructure models
02Release Notes
- Updated: documents, documents_reviews
03Behaviors
@swamp/gcp/deepreview/documentsv2026.10.23.1documents.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
fn delete(identifier: string)
Delete the documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
fn sync(identifier?: string)
Sync documents state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific documents by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List documents resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Supported AIP-160 filter expressions (e.g., `display_name = "..."`). |
| orderBy? | string | Optional. Supported AIP-132 order_by field. |
| pageSize? | number | Optional. The maximum number of documents to return in a single page. The server may return fewer than this value. If unspecified, at most 50 documents will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Document Resource Model representing an uploaded document for review. Documen...
@swamp/gcp/deepreview/documents-reviewsv2026.10.23.1documents_reviews.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| name? | string | Identifier. Resource name in format `documents/{document}/reviews/{review}`. |
| runConfig? | object | Optional. Run configuration parameters used for this review. |
| requestId? | string | Optional. Idempotency identifier for network retry safety (AIP-155). Must be a valid UUID4 string. |
| reviewId? | string | Optional. The ID to use for the review, which will become the final component of the review's resource name. If not provided, a unique server-generated UUID will be assigned. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
fn create(waitForReady?: boolean)
Create a reviews
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a reviews
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the reviews |
fn sync(identifier?: string)
Sync reviews state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific reviews by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List reviews resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Supported AIP-160 filter expressions. |
| orderBy? | string | Optional. Supported AIP-132 order_by field. |
| pageSize? | number | Optional. The maximum number of reviews to return in a single page. The server may return fewer than this value. If unspecified, at most 50 reviews will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Review Sub-Resource Model representing an evaluation run of a document.
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Added: documents, documents_reviews
05Stats
A
100 / 100
Downloads
4
Archive size
24.0 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels