@swamp/gcp/dataform
v2026.04.23.1
Google Cloud dataform infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-clouddataformcloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/dataform@swamp/gcp/dataform/foldersv2026.04.23.1folders.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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') |
createCreate a folders
getGet a folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
updateUpdate folders attributes
deleteDelete the folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
syncSync folders state from GCP
movemove
| Argument | Type | Description |
|---|---|---|
| destinationContainingFolder? | any |
query_folder_contentsquery folder contents
Resources
state(infinite)— Represents a Dataform Folder. This is a resource that is used to organize Fil...
@swamp/gcp/dataform/locationsv2026.04.23.1locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
syncSync locations state from GCP
get_configget config
query_user_root_contentsquery user root contents
update_configupdate config
| Argument | Type | Description |
|---|---|---|
| defaultKmsKeyName? | any | |
| internalMetadata? | any | |
| name? | any |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/dataform/repositoriesv2026.04.23.1repositories.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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/*`. |
| dataEncryptionState? | object | Describes encryption state of a resource. |
| displayName? | string | Optional. The repository's user-friendly name. |
| gitRemoteSettings? | object | Controls Git remote configuration for a repository. |
| 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 | Configures workspace compilation overrides for a repository. |
| 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') |
createCreate a repositories
getGet a repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
updateUpdate repositories attributes
deleteDelete the repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
syncSync repositories state from GCP
commitcommit
| Argument | Type | Description |
|---|---|---|
| commitMetadata? | any | |
| fileOperations? | any | |
| requiredHeadCommitSha? | any |
compute_access_token_statuscompute access token status
fetch_historyfetch history
fetch_remote_branchesfetch remote branches
movemove
| Argument | Type | Description |
|---|---|---|
| destinationContainingFolder? | any |
query_directory_contentsquery directory contents
read_fileread file
Resources
state(infinite)— Represents a Dataform Git repository.
@swamp/gcp/dataform/repositories-compilationresultsv2026.04.23.1repositories_compilationresults.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| codeCompilationConfig? | object | Configures various aspects of Dataform code compilation. |
| dataEncryptionState? | object | Describes encryption state of a resource. |
| 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` |
| privateResourceMetadata? | object | Metadata used to identify if a resource is user scoped. |
| 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/*`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a compilationResults
getGet a compilationResults
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the compilationResults |
syncSync compilationResults state from GCP
queryquery
Resources
state(infinite)— Represents the result of compiling a Dataform project.
@swamp/gcp/dataform/repositories-releaseconfigsv2026.04.23.1repositories_releaseconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| codeCompilationConfig? | object | Configures various aspects of Dataform code compilation. |
| 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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a releaseConfigs
getGet a releaseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the releaseConfigs |
updateUpdate releaseConfigs attributes
deleteDelete the releaseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the releaseConfigs |
syncSync releaseConfigs state from GCP
Resources
state(infinite)— Represents a Dataform release configuration.
@swamp/gcp/dataform/repositories-workflowconfigsv2026.04.23.1repositories_workflowconfigs.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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 | Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included. |
| 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. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a workflowConfigs
getGet a workflowConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowConfigs |
updateUpdate workflowConfigs attributes
deleteDelete the workflowConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowConfigs |
syncSync workflowConfigs state from GCP
Resources
state(infinite)— Represents a Dataform workflow configuration.
@swamp/gcp/dataform/repositories-workflowinvocationsv2026.04.23.1repositories_workflowinvocations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| compilationResult? | string | Immutable. The name of the compilation result to use for this invocation. Must be in the format `projects/*/locations/*/repositories/*/compilationResults/*`. |
| dataEncryptionState? | object | Describes encryption state of a resource. |
| 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. |
| privateResourceMetadata? | object | Metadata used to identify if a resource is user scoped. |
| workflowConfig? | string | Immutable. The name of the workflow config to invoke. Must be in the format `projects/*/locations/*/repositories/*/workflowConfigs/*`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a workflowInvocations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a workflowInvocations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowInvocations |
deleteDelete the workflowInvocations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowInvocations |
syncSync workflowInvocations state from GCP
cancelcancel
queryquery
Resources
state(infinite)— Represents a single invocation of a compilation result.
@swamp/gcp/dataform/repositories-workspacesv2026.04.23.1repositories_workspaces.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| dataEncryptionState? | object | Describes encryption state of a resource. |
| 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. |
| privateResourceMetadata? | object | Metadata used to identify if a resource is user scoped. |
| workspaceId? | string | Required. The ID to use for the workspace, which will become the final component of the workspace's resource name. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a workspaces
getGet a workspaces
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workspaces |
deleteDelete the workspaces
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workspaces |
syncSync workspaces state from GCP
commitcommit
| Argument | Type | Description |
|---|---|---|
| author? | any | |
| commitMessage? | any | |
| paths? | any |
fetch_file_difffetch file diff
fetch_file_git_statusesfetch file git statuses
fetch_git_ahead_behindfetch git ahead behind
install_npm_packagesinstall npm packages
make_directorymake directory
| Argument | Type | Description |
|---|---|---|
| path? | any |
move_directorymove directory
| Argument | Type | Description |
|---|---|---|
| newPath? | any | |
| path? | any |
move_filemove file
| Argument | Type | Description |
|---|---|---|
| newPath? | any | |
| path? | any |
pullpull
| Argument | Type | Description |
|---|---|---|
| author? | any | |
| remoteBranch? | any |
pushpush
| Argument | Type | Description |
|---|---|---|
| remoteBranch? | any |
query_directory_contentsquery directory contents
read_fileread file
resetreset
| Argument | Type | Description |
|---|---|---|
| clean? | any | |
| paths? | any |
search_filessearch files
write_filewrite file
| Argument | Type | Description |
|---|---|---|
| contents? | any | |
| path? | any |
Resources
state(infinite)— Represents a Dataform Git workspace.
@swamp/gcp/dataform/teamfoldersv2026.04.23.1teamfolders.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| 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') |
createCreate a teamFolders
getGet a teamFolders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamFolders |
updateUpdate teamFolders attributes
deleteDelete the teamFolders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamFolders |
syncSync teamFolders state from GCP
query_contentsquery contents
searchsearch
Resources
state(infinite)— Represents a Dataform TeamFolder. This is a resource that sits at the project...
2026.04.19.147.5 KBApr 19, 2026
Google Cloud dataform infrastructure models
Release Notes
- Updated: folders, repositories
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataformcloudinfrastructure
2026.04.03.347.0 KBApr 3, 2026
Google Cloud dataform infrastructure models
Release Notes
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataformcloudinfrastructure
2026.04.03.146.4 KBApr 3, 2026
Google Cloud dataform infrastructure models
Release Notes
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataformcloudinfrastructure
2026.04.02.246.2 KBApr 2, 2026
Google Cloud dataform infrastructure models
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataformcloudinfrastructure
2026.03.27.143.1 KBMar 27, 2026
Google Cloud dataform infrastructure models
Release Notes
- Added: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddataformcloudinfrastructure