Gcp/dataform
@swamp/gcp/dataformv2026.05.20.1
01README
Google Cloud dataform infrastructure models
02Release Notes
- Updated: folders, repositories, repositories_releaseconfigs
03Models
@swamp/gcp/dataform/foldersv2026.05.20.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') |
fn create()
Create a folders
fn get(identifier: string)
Get a folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
fn update()
Update folders attributes
fn delete(identifier: string)
Delete the folders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the folders |
fn sync()
Sync folders state from GCP
fn move(destinationContainingFolder?: any)
move
| Argument | Type | Description |
|---|---|---|
| destinationContainingFolder? | any |
fn query_folder_contents()
query folder contents
Resources
state(infinite)— Represents a Dataform Folder. This is a resource that is used to organize Fil...
@swamp/gcp/dataform/locationsv2026.05.19.2locations.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
fn get(identifier: string)
Get a locations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the locations |
fn sync()
Sync locations state from GCP
fn get_config()
get config
fn query_user_root_contents()
query user root contents
fn update_config(defaultKmsKeyName?: any, internalMetadata?: any, name?: any)
update 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.05.20.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') |
fn create()
Create a repositories
fn get(identifier: string)
Get a repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
fn update()
Update repositories attributes
fn delete(identifier: string)
Delete the repositories
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the repositories |
fn sync()
Sync repositories state from GCP
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()
fetch history
fn fetch_remote_branches()
fetch remote branches
fn move(destinationContainingFolder?: any)
move
| Argument | Type | Description |
|---|---|---|
| destinationContainingFolder? | any |
fn query_directory_contents()
query directory contents
fn read_file()
read file
Resources
state(infinite)— Represents a Dataform Git repository.
@swamp/gcp/dataform/repositories-compilationresultsv2026.05.19.2repositories_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') |
fn create()
Create a compilationResults
fn get(identifier: string)
Get a compilationResults
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the compilationResults |
fn sync()
Sync compilationResults state from GCP
fn query()
query
Resources
state(infinite)— Represents the result of compiling a Dataform project.
@swamp/gcp/dataform/repositories-releaseconfigsv2026.05.20.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. LINT.ThenChange(//depot/google3/google/cloud/dataform/v2main/data_pipelines.proto:CreateReleaseConfigRequest) |
| 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()
Update releaseConfigs attributes
fn delete(identifier: string)
Delete the releaseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the releaseConfigs |
fn sync()
Sync releaseConfigs state from GCP
Resources
state(infinite)— Represents a Dataform release configuration.
@swamp/gcp/dataform/repositories-workflowconfigsv2026.05.19.2repositories_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') |
fn create()
Create a workflowConfigs
fn get(identifier: string)
Get a workflowConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowConfigs |
fn update()
Update workflowConfigs attributes
fn delete(identifier: string)
Delete the workflowConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the workflowConfigs |
fn sync()
Sync workflowConfigs state from GCP
Resources
state(infinite)— Represents a Dataform workflow configuration.
@swamp/gcp/dataform/repositories-workflowinvocationsv2026.05.19.2repositories_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') |
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()
Sync workflowInvocations state from GCP
fn cancel()
cancel
fn query()
query
Resources
state(infinite)— Represents a single invocation of a compilation result.
@swamp/gcp/dataform/repositories-workspacesv2026.05.19.2repositories_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') |
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()
Sync workspaces state from GCP
fn commit(author?: any, commitMessage?: any, paths?: any)
commit
| Argument | Type | Description |
|---|---|---|
| author? | any | |
| commitMessage? | any | |
| paths? | any |
fn fetch_file_diff()
fetch file diff
fn fetch_file_git_statuses()
fetch file git statuses
fn fetch_git_ahead_behind()
fetch git ahead behind
fn install_npm_packages()
install npm packages
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()
query directory contents
fn read_file()
read file
fn reset(clean?: any, paths?: any)
reset
| Argument | Type | Description |
|---|---|---|
| clean? | any | |
| paths? | any |
fn search_files()
search files
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.05.19.2teamfolders.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') |
fn create()
Create a teamFolders
fn get(identifier: string)
Get a teamFolders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamFolders |
fn update()
Update teamFolders attributes
fn delete(identifier: string)
Delete the teamFolders
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the teamFolders |
fn sync()
Sync teamFolders state from GCP
fn query_contents()
query contents
fn search()
search
Resources
state(infinite)— Represents a Dataform TeamFolder. This is a resource that sits at the project...
04Previous Versions
2026.05.19.2May 19, 2026
2026.05.19.1May 19, 2026
2026.05.18.2May 18, 2026
2026.05.09.1May 10, 2026
- Updated: repositories_releaseconfigs
2026.04.23.1Apr 23, 2026
2026.04.19.1Apr 19, 2026
- Updated: folders, repositories
2026.04.03.3Apr 3, 2026
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.04.03.1Apr 3, 2026
- Updated: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
2026.04.02.2Apr 2, 2026
2026.03.27.1Mar 27, 2026
- Added: locations, folders, repositories, repositories_compilationresults, repositories_releaseconfigs, repositories_workflowconfigs, repositories_workflowinvocations, repositories_workspaces, teamfolders
05Stats
A
100 / 100
Downloads
0
Archive size
76.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 types1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels