Gcp/datamigration

@swamp/gcp/datamigrationv2026.09.11.1· 1d agoMODELS

01README

Google Cloud datamigration infrastructure models

02Release Notes

Updated: connectionprofiles, migrationjobs

03Models7

connectionprofiles.tsv2026.09.11.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	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	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
alloydb?	object	no	Required. The AlloyDB cluster ID that this connection profile is associated with.
cloudsql?	object	no	Output only. The Cloud SQL database instance's additional (outgoing) public IP. Used when the Cloud SQL database availability type is REGIONAL (i.e. multiple zones / highly available).
displayName?	string	no	The connection profile display name.
labels?	record	no	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" }`.
mysql?	object	no	If the source is a Cloud SQL database, use this field to provide the Cloud SQL instance ID of the source.
name?	string	no	The name of this connection profile resource in the form of projects/{project}/locations/{location}/connectionProfiles/{connectionProfile}.
oracle?	object	no	Required. Database service for the Oracle connection.
postgresql?	object	no	Optional. If the destination is an AlloyDB database, use this field to provide the AlloyDB cluster ID.
provider?	enum	no	The database provider.
role?	enum	no	Optional. The connection profile role.
sqlserver?	object	no	Required. The Cloud Storage bucket that stores backups for all replicated databases.
state?	enum	no	The current connection profile state (e.g. DRAFT, READY, or FAILED).
connectionProfileId?	string	no	Required. The connection profile identifier.
requestId?	string	no	Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
skipValidation?	string	no	Optional. Create the connection profile without validating it. The default is false. Only supported for Oracle connection profiles.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a connectionProfiles

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a connectionProfiles

Argument	Type	Required	Description
identifier	string	yes	The name of the connectionProfiles

fn update(identifier?: string, waitForReady?: boolean)

Update connectionProfiles attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific connectionProfiles by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the connectionProfiles

Argument	Type	Required	Description
identifier	string	yes	The name of the connectionProfiles

fn sync(identifier?: string)

Sync connectionProfiles state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific connectionProfiles by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List connectionProfiles resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters connection profiles listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list connection profiles created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify mySql.username = %lt;my_username%gt; to list all connection profiles configured to connect with a specific username.
orderBy?	string	no	Optional. A comma-separated list of fields to order results according to.
pageSize?	number	no	The maximum number of connection profiles to return. The service may return fewer than this value. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

conversionworkspaces.tsv2026.09.07.2

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	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	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
destination?	object	no	Required. Engine type.
destinationProvider?	enum	no	Optional. The provider for the destination database.
displayName?	string	no	Optional. The display name for the workspace.
globalSettings?	record	no	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
name?	string	no	Full name of the workspace resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{conversion_workspace}.
source?	object	no	Required. Engine type.
sourceProvider?	enum	no	Optional. The provider for the source database.
conversionWorkspaceId?	string	no	Required. The ID of the conversion workspace to create.
requestId?	string	no	Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a conversionWorkspaces

fn get(identifier: string)

Get a conversionWorkspaces

Argument	Type	Required	Description
identifier	string	yes	The name of the conversionWorkspaces

fn update(identifier?: string)

Update conversionWorkspaces attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific conversionWorkspaces by name (e.g. one discovered by list)

fn delete(identifier: string)

Delete the conversionWorkspaces

Argument	Type	Required	Description
identifier	string	yes	The name of the conversionWorkspaces

fn sync(identifier?: string)

Sync conversionWorkspaces state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific conversionWorkspaces by name (e.g. one discovered by list)

fn list(filter?: string, pageSize?: number, maxPages?: number)

List conversionWorkspaces resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters conversion workspaces listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list conversion workspaces created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify source.version = "12.c.1" to select all conversion workspaces with source database version equal to 12.c.1.
pageSize?	number	no	Optional. The maximum number of conversion workspaces to return. The service may return fewer than this value. If unspecified, at most 50 sets are returned.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn apply(autoCommit?: any, connectionProfile?: any, dryRun?: any, filter?: any)

apply

Argument	Type	Required
autoCommit?	any	no
connectionProfile?	any	no
dryRun?	any	no
filter?	any	no

fn commit(commitName?: any)

commit

Argument	Type	Required	Description
commitName?	any	no

fn convert(autoCommit?: any, convertFullPath?: any, filter?: any)

convert

Argument	Type	Required
autoCommit?	any	no
convertFullPath?	any	no
filter?	any	no

fn describe_conversion_workspace_revisions(commitId?: any)

describe conversion workspace revisions

Argument	Type	Required	Description
commitId?	any	no

fn describe_database_entities(commitId?: any, filter?: any, pageSize?: any, pageToken?: any, tree?: any, uncommitted?: any, view?: any)

describe database entities

Argument	Type	Required
commitId?	any	no
filter?	any	no
pageSize?	any	no
pageToken?	any	no
tree?	any	no
uncommitted?	any	no
view?	any	no

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn rollback()

rollback

fn search_background_jobs(completedUntilTime?: any, maxSize?: any, returnMostRecentPerJobType?: any)

search background jobs

Argument	Type	Required
completedUntilTime?	any	no
maxSize?	any	no
returnMostRecentPerJobType?	any	no

fn seed(autoCommit?: any, destinationConnectionProfile?: any, sourceConnectionProfile?: any)

seed

Argument	Type	Required
autoCommit?	any	no
destinationConnectionProfile?	any	no
sourceConnectionProfile?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

conversionworkspaces_mappingrules.tsv2026.08.12.2

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	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	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
conditionalColumnSetValue?	object	no	Optional. Custom engine specific features.
convertRowidColumn?	object	no	Required. Only work on tables without primary key defined
displayName?	string	no	Optional. A human readable name
entityMove?	object	no	Required. The new schema
filter?	object	no	Optional. The rule should be applied to specific entities defined by their fully qualified names.
filterTableColumns?	object	no	Optional. List of columns to be excluded for a particular table.
multiColumnDataTypeChange?	object	no	Optional. Custom engine specific features.
multiEntityRename?	object	no	Optional. The pattern used to generate the new entity's name. This pattern must include the characters '{name}', which will be replaced with the name of the original entity. For example, the pattern 't_{name}' for an entity name jobs would be converted to 't_jobs'. If unspecified, the default value for this field is '{name}'
name?	string	no	Full name of the mapping rule resource, in the form of: projects/{project}/locations/{location}/conversionWorkspaces/{set}/mappingRule/{rule}.
ruleOrder?	string	no	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.
ruleScope?	enum	no	Required. The rule scope
singleColumnChange?	object	no	Optional. Is the column of array type.
singleEntityRename?	object	no	Required. The new name of the destination entity
singlePackageChange?	object	no	Optional. Sql code for package body
sourceSqlChange?	object	no	Required. Sql code for source (stored procedure, function, trigger or view)
state?	enum	no	Optional. The mapping rule state
mappingRuleId?	string	no	Required. The ID of the rule to create.
requestId?	string	no	Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a mappingRules

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a mappingRules

Argument	Type	Required	Description
identifier	string	yes	The name of the mappingRules

fn delete(identifier: string)

Delete the mappingRules

Argument	Type	Required	Description
identifier	string	yes	The name of the mappingRules

fn sync(identifier?: string)

Sync mappingRules state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific mappingRules by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List mappingRules resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. The maximum number of rules to return. The service may return fewer than this value.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn import(autoCommit?: any, rulesFiles?: any, rulesFormat?: any)

import

Argument	Type	Required
autoCommit?	any	no
rulesFiles?	any	no
rulesFormat?	any	no

locations.tsv2026.09.07.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	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	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
name	string	yes	The resource that owns the locations collection, if applicable.

fn get(identifier: string)

Get a locations

Argument	Type	Required	Description
identifier	string	yes	The name of the locations

fn sync(identifier?: string)

Sync locations state from GCP

Argument	Type	Required	Description
identifier?	string	no	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	Required	Description
extraLocationTypes?	string	no	Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
filter?	string	no	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	no	The maximum number of results to return. If not set, the service selects a default.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn fetch_static_ips(fetchReservedPublicIps?: any, pageSize?: any, pageToken?: any)

fetch static ips

Argument	Type	Required
fetchReservedPublicIps?	any	no
pageSize?	any	no
pageToken?	any	no

migrationjobs.tsv2026.09.11.1

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	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	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
cmekKeyName?	string	no	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	no	The commit ID of the conversion workspace.
destination?	string	no	Required. The resource name (URI) of the destination connection profile.
destinationDatabase?	object	no	The database engine.
displayName?	string	no	The migration job display name.
dumpFlags?	object	no	The name of the flag
dumpPath?	string	no	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.
dumpType?	enum	no	Optional. The type of the data dump. Supported for MySQL to CloudSQL for MySQL migrations only.
filter?	string	no	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.
labels?	record	no	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" }`.
mysqlHomogeneousConfig?	object	no	Optional. Whether the destination for the migration job is a primary instance.
name?	string	no	The name (URI) of this migration job resource, in the form of: projects/{project}/locations/{location}/migrationJobs/{migrationJob}.
objectsConfig?	object	no	Optional. The database name. This will be required only if the object uses a database name as part of its unique identifier.
oracleToPostgresConfig?	object	no	Required. Oracle directory for archived logs.
originalMigrationName?	string	no	Optional. A failback replication pointer to the resource name (URI) of the original migration job.
performanceConfig?	object	no	Initial dump parallelism level.
postgresHomogeneousConfig?	object	no	Required. Whether the migration is native logical.
postgresToSqlserverConfig?	object	no	Optional. Whether to skip full dump or not.
reverseSshConnectivity?	object	no	The name of the virtual machine (Compute Engine) used as the bastion server for the SSH tunnel.
source?	string	no	Required. The resource name (URI) of the source connection profile.
sourceDatabase?	object	no	The database engine.
sqlserverHomogeneousMigrationJobConfig?	object	no	Required. Pattern that describes the default backup naming strategy. The specified pattern should ensure lexicographical order of backups. The pattern must define one of the following capture group sets: Capture group set #1 yy/yyyy - year, 2 or 4 digits mm - month number, 1-12 dd - day of month, 1-31 hh - hour of day, 00-23 mi - minutes, 00-59 ss - seconds, 00-59 Example: For backup file TestDB_20230802_155400.trn, use pattern: (?.)_backup_(?\\d{4})(?\\d{2})(?\\d{2})_(?\\d{2})(?\\d{2})(?\\d{2}).trn Capture group set #2 timestamp - unix timestamp Example: For backup file TestDB.1691448254.trn, use pattern: (?.)\\.(?\\d).trn or (?.)\\.(?\\d*).trn
sqlserverToPostgresConfig?	object	no	Optional. Maximum number of connections Database Migration Service will open to the destination for data migration.
state?	enum	no	The current migration job state.
staticIpConnectivity?	object	no	static ip connectivity data (default, no additional details needed).
type?	enum	no	Required. The migration job type.
vpcPeeringConnectivity?	object	no	The name of the VPC network to peer with the Cloud SQL private network.
migrationJobId?	string	no	Required. The ID of the instance to create.
requestId?	string	no	Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create(waitForReady?: boolean)

Create a migrationJobs

Argument	Type	Required	Description
waitForReady?	boolean	no	Wait for the resource to reach a ready state after creation (default: true)

fn get(identifier: string)

Get a migrationJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the migrationJobs

fn update(identifier?: string, waitForReady?: boolean)

Update migrationJobs attributes

Argument	Type	Required	Description
identifier?	string	no	Target a specific migrationJobs by name (e.g. one discovered by list)
waitForReady?	boolean	no	Wait for the resource to reach a ready state after update (default: true)

fn delete(identifier: string)

Delete the migrationJobs

Argument	Type	Required	Description
identifier	string	yes	The name of the migrationJobs

fn sync(identifier?: string)

Sync migrationJobs state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific migrationJobs by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List migrationJobs resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters migration jobs listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list migration jobs created this year by specifying createTime %gt; 2020-01-01T00:00:00.000000000Z. You can also filter nested fields. For example, you could specify reverseSshConnectivity.vmIp = "1.2.3.4" to select all migration jobs connecting through the specific SSH tunnel bastion.
orderBy?	string	no	Optional. Sort the results based on the migration job name. Valid values are: "name", "name asc", and "name desc".
pageSize?	number	no	Optional. The maximum number of migration jobs to return. The service may return fewer than this value. If unspecified, at most 50 migration jobs will be returned. The maximum value is 1000; values above 1000 are coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn demote_destination()

demote destination

fn fetch_source_objects()

fetch source objects

fn generate_ssh_script(vm?: any, vmCreationConfig?: any, vmPort?: any, vmSelectionConfig?: any)

generate ssh script

Argument	Type	Required
vm?	any	no
vmCreationConfig?	any	no
vmPort?	any	no
vmSelectionConfig?	any	no

fn generate_tcp_proxy_script(vmMachineType?: any, vmName?: any, vmSubnet?: any, vmZone?: any)

generate tcp proxy script

Argument	Type	Required
vmMachineType?	any	no
vmName?	any	no
vmSubnet?	any	no
vmZone?	any	no

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn promote(objectsFilter?: any)

promote

Argument	Type	Required	Description
objectsFilter?	any	no

fn restart(objectsFilter?: any, restartFailedObjects?: any, skipValidation?: any)

restart

Argument	Type	Required
objectsFilter?	any	no
restartFailedObjects?	any	no
skipValidation?	any	no

fn resume(skipValidation?: any)

resume

Argument	Type	Required	Description
skipValidation?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn start(objectsFilter?: any, restartFailedObjects?: any, skipValidation?: any)

start

Argument	Type	Required
objectsFilter?	any	no
restartFailedObjects?	any	no
skipValidation?	any	no

fn stop()

stop

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

fn verify(migrationJob?: any, updateMask?: any)

verify

Argument	Type	Required	Description
migrationJob?	any	no
updateMask?	any	no

migrationjobs_objects.tsv2026.09.07.2

Global Arguments

Argument	Type	Required	Description
name	string	yes	Instance name for this resource (used as the unique identifier in the factory pattern)
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	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	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
parent?	string	no	The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn get(identifier: string)

Get a objects

Argument	Type	Required	Description
identifier	string	yes	The name of the objects

fn sync(identifier?: string)

Sync objects state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific objects by name (e.g. one discovered by list)

fn list(pageSize?: number, maxPages?: number)

List objects resources

Argument	Type	Required	Description
pageSize?	number	no	Optional. Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn lookup(sourceObjectIdentifier?: any)

lookup

Argument	Type	Required	Description
sourceObjectIdentifier?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

privateconnections.tsv2026.09.07.2

Global Arguments

Argument	Type	Required	Description
accessToken?	string	no	GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault.
credentialsJson?	string	no	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	no	GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables.
scopes?	string	no	Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes.
quotaProject?	string	no	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	no	Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL.
displayName?	string	no	The private connection display name.
labels?	record	no	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" }`.
name?	string	no	The name of the resource.
pscInterfaceConfig?	object	no	Required. Fully qualified name of the Network Attachment that DMS will connect to. Format: `projects/{{project}}/regions/{{region}}/networkAttachments/{{name}}`
reservedPublicIpConfig?	object	no	Output only. The reserved public IPs.
vpcPeeringConfig?	object	no	Required. A free subnet for peering. (CIDR of /29)
privateConnectionId?	string	no	Required. The private connection identifier.
requestId?	string	no	Optional. A unique ID used to identify the request. If the server receives two requests with the same ID, then the second request is ignored. It is recommended to always set this value to a UUID. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
skipValidation?	string	no	Optional. If set to true, will skip validations.
location?	string	no	The location for this resource (e.g., 'us', 'us-central1', 'europe-west1')

fn create()

Create a privateConnections

fn get(identifier: string)

Get a privateConnections

Argument	Type	Required	Description
identifier	string	yes	The name of the privateConnections

fn delete(identifier: string)

Delete the privateConnections

Argument	Type	Required	Description
identifier	string	yes	The name of the privateConnections

fn sync(identifier?: string)

Sync privateConnections state from GCP

Argument	Type	Required	Description
identifier?	string	no	Target a specific privateConnections by name (e.g. one discovered by list)

fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)

List privateConnections resources

Argument	Type	Required	Description
filter?	string	no	Optional. A filter expression that filters private connections listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, list private connections created this year by specifying createTime %gt; 2021-01-01T00:00:00.000000000Z.
orderBy?	string	no	Optional. Order by fields for the result.
pageSize?	number	no	Optional. Maximum number of private connections to return. If unspecified, at most 50 private connections that are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
maxPages?	number	no	Maximum number of pages to fetch (default: 10)

fn get_iam_policy(options_requestedPolicyVersion?: any)

get iam policy

Argument	Type	Required	Description
options_requestedPolicyVersion?	any	no

fn set_iam_policy(policy?: any, updateMask?: any)

set iam policy

Argument	Type	Required	Description
policy?	any	no
updateMask?	any	no

fn test_iam_permissions(permissions?: any)

test iam permissions

Argument	Type	Required	Description
permissions?	any	no

04Previous Versions19

2026.09.07.2Sep 8, 2026

Updated: connectionprofiles, conversionworkspaces, migrationjobs, migrationjobs_objects, privateconnections

2026.08.15.1Aug 15, 2026

Updated: locations, privateconnections

2026.08.14.1Aug 14, 2026

Updated: locations, privateconnections

2026.08.12.2Aug 12, 2026

Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections

2026.08.03.1Aug 3, 2026

Updated: conversionworkspaces_mappingrules

2026.08.02.1Aug 2, 2026

Updated: conversionworkspaces_mappingrules

2026.07.29.1Jul 30, 2026

Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections

2026.07.25.1Jul 25, 2026

Updated: conversionworkspaces_mappingrules

2026.07.21.4Jul 21, 2026

Updated: locations, migrationjobs

2026.07.21.1Jul 21, 2026

Updated: connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, privateconnections

2026.07.20.2Jul 20, 2026

Updated: locations, migrationjobs

2026.07.20.1Jul 20, 2026

Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections

2026.07.19.2Jul 19, 2026

Updated: locations

2026.07.19.1Jul 19, 2026

Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections

2026.07.18.2Jul 18, 2026

Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections

2026.07.17.2Jul 17, 2026

Updated: connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, privateconnections

2026.07.17.1Jul 17, 2026

Updated: connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections

2026.06.24.1Jun 24, 2026

Updated: migrationjobs

2026.06.08.2Jun 8, 2026

Updated: locations, connectionprofiles, conversionworkspaces, conversionworkspaces_mappingrules, migrationjobs, migrationjobs_objects, privateconnections

05Stats

100 / 100

Downloads

Archive size

164.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

Repository

https://github.com/swamp-club/swamp-extensions

06Platforms

linux · x86_64 linux · aarch64 macOS · x86_64 macOS · aarch64

07Labels

#gcp #google-cloud #datamigration #cloud #infrastructure