Gcp/dataform
@swamp/gcp/dataformv2026.09.11.1
01README
Google Cloud dataform infrastructure models
02Release Notes
- Updated: repositories, repositories_workflowconfigs, repositories_workflowinvocations
03Models
@swamp/gcp/dataform/foldersv2026.09.07.2folders.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. |
| containingFolder? | string | Optional. The containing Folder resource name. This should take the format: projects/{project}/locations/{location}/folders/{folder}, projects/{project}/locations/{location}/teamFolders/{teamFolder}, or just "" if this is a root Folder. This field can only be updated through MoveFolder. |
| displayName? | string | Required. The Folder's user-friendly name. |
| name? | string | Identifier. The Folder's name. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a folders
fn get(identifier: string)
Get a folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
fn update(identifier?: string)
Update folders attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific folders by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
fn sync(identifier?: string)
Sync folders state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific folders by name (e.g. one discovered by list) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn move(destinationContainingFolder?: any)
move
| Argument | Type | Description |
|---|---|---|
| destinationContainingFolder? | any |
fn query_folder_contents(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any)
query folder contents
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| orderBy? | any | |
| pageSize? | any | |
| pageToken? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— Represents a Dataform Folder. This is a resource that is used to organize Fil...
@swamp/gcp/dataform/locationsv2026.09.07.1locations.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 | The resource that owns the locations collection, if applicable. |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync(identifier?: string)
Sync locations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific locations by name (e.g. one discovered by list) |
fn list(extraLocationTypes?: string, filter?: string, pageSize?: number, maxPages?: number)
List locations resources
| Argument | Type | Description |
|---|---|---|
| extraLocationTypes? | string | Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. |
| filter? | string | A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160). |
| pageSize? | number | The maximum number of results to return. If not set, the service selects a default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_config()
get config
fn query_user_root_contents(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any)
query user root contents
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| orderBy? | any | |
| pageSize? | any | |
| pageToken? | any |
fn update_config(defaultKmsKeyName?: any, internalMetadata?: any, name?: any, updateMask?: any)
update config
| Argument | Type | Description |
|---|---|---|
| defaultKmsKeyName? | any | |
| internalMetadata? | any | |
| name? | any | |
| updateMask? | any |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/dataform/repositoriesv2026.09.11.1repositories.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. |
| containingFolder? | string | Optional. The name of the containing folder of the repository. The field is immutable and it can be modified via a MoveRepository operation. Format: `projects/*/locations/*/folders/*`. or `projects/*/locations/*/teamFolders/*`. |
| displayName? | string | Optional. The repository's user-friendly name. |
| endUserAuthConfig? | object | Optional. Includes configuration options for end user authentication. |
| gitRemoteSettings? | object | Optional. If set, configures this repository to be linked to a Git remote. |
| kmsKeyName? | string | Optional. The reference to a KMS encryption key. If provided, it will be used to encrypt user data in the repository and all child resources. It is not possible to add or update the encryption key after the repository is created. Example: `projects/{kms_project}/locations/{location}/keyRings/{key_location}/cryptoKeys/{key}` |
| labels? | record | Optional. Repository user labels. |
| name? | string | Identifier. The repository's name. |
| 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. |
| workspaceCompilationOverrides? | object | Optional. If set, fields of `workspace_compilation_overrides` override the default compilation settings that are specified in dataform.json when creating workspace-scoped compilation results. See documentation for `WorkspaceCompilationOverrides` for more information. |
| repositoryId? | string | Required. The ID to use for the repository, which will become the final component of the repository's resource name. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a repositories
fn get(identifier: string)
Get a repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
fn update(identifier?: string)
Update repositories attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific repositories by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
fn sync(identifier?: string)
Sync repositories state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific repositories by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List repositories resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter for the returned list. |
| orderBy? | string | Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. |
| pageSize? | number | Optional. Maximum number of repositories to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn commit(commitMetadata?: any, fileOperations?: any, requiredHeadCommitSha?: any)
commit
| Argument | Type | Description |
|---|---|---|
| commitMetadata? | any | |
| fileOperations? | any | |
| requiredHeadCommitSha? | any |
fn compute_access_token_status()
compute access token status
fn fetch_history(pageSize?: any, pageToken?: any)
fetch history
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any |
fn fetch_remote_branches()
fetch remote branches
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn move(destinationContainingFolder?: any)
move
| Argument | Type | Description |
|---|---|---|
| destinationContainingFolder? | any |
fn query_directory_contents(commitSha?: any, pageSize?: any, pageToken?: any, path?: any)
query directory contents
| Argument | Type | Description |
|---|---|---|
| commitSha? | any | |
| pageSize? | any | |
| pageToken? | any | |
| path? | any |
fn read_file(commitSha?: any, path?: any)
read file
| Argument | Type | Description |
|---|---|---|
| commitSha? | any | |
| path? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— Represents a Dataform Git repository.
@swamp/gcp/dataform/repositories-compilationresultsv2026.09.07.1repositories_compilationresults.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. |
| codeCompilationConfig? | object | Immutable. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json. |
| 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. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`. |
| workspace? | string | Immutable. The name of the workspace to compile. Must be in the format `projects/*/locations/*/repositories/*/workspaces/*`. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a compilationResults
fn get(identifier: string)
Get a compilationResults
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the compilationResults |
fn sync(identifier?: string)
Sync compilationResults state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific compilationResults by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List compilationResults resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter for the returned list. |
| orderBy? | string | Optional. This field only supports ordering by `name` and `create_time`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. |
| pageSize? | number | Optional. Maximum number of compilation results to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn query(filter?: any, pageSize?: any, pageToken?: any)
query
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| pageToken? | any |
Resources
state(infinite)— Represents the result of compiling a Dataform project.
@swamp/gcp/dataform/repositories-releaseconfigsv2026.08.12.2repositories_releaseconfigs.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. |
| codeCompilationConfig? | object | Optional. If set, fields of `code_compilation_config` override the default compilation settings that are specified in dataform.json. |
| cronSchedule? | string | Optional. Optional schedule (in cron format) for automatic creation of compilation results. |
| disabled? | boolean | Optional. Disables 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` |
| name? | string | Identifier. The release config's name. |
| releaseCompilationResult? | string | Optional. The name of the currently released compilation result for this release config. This value is updated when a compilation result is automatically created from this release config (using cron_schedule), 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`. |
| releaseConfigId? | string | Required. The ID to use for the release config, which will become the final component of the release config's resource name. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a releaseConfigs
fn get(identifier: string)
Get a releaseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the releaseConfigs |
fn update(identifier?: string)
Update releaseConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific releaseConfigs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the releaseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the releaseConfigs |
fn sync(identifier?: string)
Sync releaseConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific releaseConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List releaseConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. Maximum number of release configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Represents a Dataform release configuration.
@swamp/gcp/dataform/repositories-workflowconfigsv2026.09.11.1repositories_workflowconfigs.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. |
| cronSchedule? | string | Optional. Optional schedule (in cron format) for automatic execution of this workflow config. |
| disabled? | boolean | Optional. Disables automatic creation of workflow invocations. |
| invocationConfig? | object | Optional. If left unset, a default InvocationConfig will be used. |
| name? | string | Identifier. The workflow config's name. |
| 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`. |
| workflowConfigId? | string | Required. The ID to use for the workflow config, which will become the final component of the workflow config's resource name. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a workflowConfigs
fn get(identifier: string)
Get a workflowConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowConfigs |
fn update(identifier?: string)
Update workflowConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workflowConfigs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the workflowConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowConfigs |
fn sync(identifier?: string)
Sync workflowConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workflowConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List workflowConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. Maximum number of workflow configs to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Represents a Dataform workflow configuration.
@swamp/gcp/dataform/repositories-workflowinvocationsv2026.09.11.1repositories_workflowinvocations.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. |
| 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 | Immutable. If left unset, a default InvocationConfig will be used. |
| workflowConfig? | string | Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a workflowInvocations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a workflowInvocations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowInvocations |
fn delete(identifier: string)
Delete the workflowInvocations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowInvocations |
fn sync(identifier?: string)
Sync workflowInvocations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workflowInvocations by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List workflowInvocations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter for the returned list. |
| orderBy? | string | Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. |
| pageSize? | number | Optional. Maximum number of workflow invocations to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel()
cancel
fn query(pageSize?: any, pageToken?: any)
query
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any |
Resources
state(infinite)— Represents a single invocation of a compilation result.
@swamp/gcp/dataform/repositories-workspacesv2026.09.07.2repositories_workspaces.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. |
| disableMoves? | boolean | Optional. If set to true, workspaces will not be moved if its linked Repository is moved. Instead, it will be deleted. |
| name? | string | Identifier. The workspace's name. |
| workspaceId? | string | Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a workspaces
fn get(identifier: string)
Get a workspaces
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workspaces |
fn delete(identifier: string)
Delete the workspaces
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workspaces |
fn sync(identifier?: string)
Sync workspaces state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific workspaces by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List workspaces resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter for the returned list. |
| orderBy? | string | Optional. This field only supports ordering by `name`. If unspecified, the server will choose the ordering. If specified, the default order is ascending for the `name` field. |
| pageSize? | number | Optional. Maximum number of workspaces to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn commit(author?: any, commitMessage?: any, paths?: any)
commit
| Argument | Type | Description |
|---|---|---|
| author? | any | |
| commitMessage? | any | |
| paths? | any |
fn fetch_file_diff(path?: any)
fetch file diff
| Argument | Type | Description |
|---|---|---|
| path? | any |
fn fetch_file_git_statuses()
fetch file git statuses
fn fetch_git_ahead_behind(remoteBranch?: any)
fetch git ahead behind
| Argument | Type | Description |
|---|---|---|
| remoteBranch? | any |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn install_npm_packages(pipelineConfig?: any)
install npm packages
| Argument | Type | Description |
|---|---|---|
| pipelineConfig? | any |
fn make_directory(path?: any)
make directory
| Argument | Type | Description |
|---|---|---|
| path? | any |
fn move_directory(newPath?: any, path?: any)
move directory
| Argument | Type | Description |
|---|---|---|
| newPath? | any | |
| path? | any |
fn move_file(newPath?: any, path?: any)
move file
| Argument | Type | Description |
|---|---|---|
| newPath? | any | |
| path? | any |
fn pull(author?: any, remoteBranch?: any)
pull
| Argument | Type | Description |
|---|---|---|
| author? | any | |
| remoteBranch? | any |
fn push(remoteBranch?: any)
push
| Argument | Type | Description |
|---|---|---|
| remoteBranch? | any |
fn query_directory_contents(pageSize?: any, pageToken?: any, path?: any, view?: any)
query directory contents
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any | |
| path? | any | |
| view? | any |
fn read_file(path?: any, revision?: any)
read file
| Argument | Type | Description |
|---|---|---|
| path? | any | |
| revision? | any |
fn reset(clean?: any, paths?: any)
reset
| Argument | Type | Description |
|---|---|---|
| clean? | any | |
| paths? | any |
fn search_files(filter?: any, pageSize?: any, pageToken?: any)
search files
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| pageToken? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
fn write_file(contents?: any, path?: any)
write file
| Argument | Type | Description |
|---|---|---|
| contents? | any | |
| path? | any |
Resources
state(infinite)— Represents a Dataform Git workspace.
@swamp/gcp/dataform/teamfoldersv2026.09.07.2teamfolders.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. |
| displayName? | string | Required. The TeamFolder's user-friendly name. |
| name? | string | Identifier. The TeamFolder's name. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a teamFolders
fn get(identifier: string)
Get a teamFolders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamFolders |
fn update(identifier?: string)
Update teamFolders attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific teamFolders by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the teamFolders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamFolders |
fn sync(identifier?: string)
Sync teamFolders state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific teamFolders by name (e.g. one discovered by list) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn query_contents(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any)
query contents
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| orderBy? | any | |
| pageSize? | any | |
| pageToken? | any |
fn search(filter?: any, orderBy?: any, pageSize?: any, pageToken?: any)
search
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| orderBy? | any | |
| pageSize? | any | |
| pageToken? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn test_iam_permissions(permissions?: any)
test iam permissions
| Argument | Type | Description |
|---|---|---|
| permissions? | any |
Resources
state(infinite)— Represents a Dataform TeamFolder. This is a resource that sits at the project...
04Previous Versions
2026.09.07.2
- Updated: folders, repositories, repositories_workspaces, teamfolders
2026.08.12.2
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.08.06.1
- Updated: repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces
2026.07.29.1
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.07.21.4
- Updated: locations, folders, repositories
2026.07.21.1
- Updated: repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces
2026.07.20.2
- Updated: locations, folders, repositories
2026.07.20.1
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.07.18.2
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.07.17.2
- Updated: folders, repositories, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workspaces, teamfolders
2026.07.17.1
- Updated: folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.06.26.1
- Updated: repositories, repositories_compilationresults, repositories_releaseconfigs
2026.06.25.1
- Updated: repositories, repositories_compilationresults, repositories_releaseconfigs
2026.06.24.1
- Updated: repositories, repositories_compilationresults, repositories_releaseconfigs
2026.06.08.2
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.06.07.1
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.06.04.1
- Updated: repositories
05Stats
A
100 / 100
Downloads
0
Archive size
140.6 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels