Gcp/vmmigration
@swamp/gcp/vmmigrationv2026.07.21.4
01README
Google Cloud vmmigration infrastructure models
02Release Notes
- Updated: locations, sources_migratingvms
03Models
@swamp/gcp/vmmigration/groupsv2026.07.21.2groups.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. |
| description? | string | User-provided description of the group. |
| displayName? | string | Display name is a user defined name for this group which can be updated. |
| migrationTargetType? | enum | Immutable. The target type of this group. |
| groupId? | string | Required. The group identifier. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a groups
fn get(identifier: string)
Get a groups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the groups |
fn update(identifier?: string)
Update groups attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific groups by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the groups
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the groups |
fn sync(identifier?: string)
Sync groups state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific groups by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List groups resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of groups to return. The service may return fewer than this value. If unspecified, at most 500 groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn add_group_migration(migratingVm?: any)
add group migration
| Argument | Type | Description |
|---|---|---|
| migratingVm? | any |
Resources
state(infinite)— Describes message for 'Group' resource. The Group is a collections of several...
@swamp/gcp/vmmigration/imageimportsv2026.07.21.3imageimports.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. |
| cloudStorageUri? | string | Immutable. The path to the Cloud Storage file from which the image should be imported. |
| diskImageTargetDefaults? | object | Immutable. Target details for importing a disk image, will be used by ImageImportJob. |
| encryption? | object | Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. |
| machineImageTargetDefaults? | object | Immutable. Target details for importing a machine image, will be used by ImageImportJob. |
| imageImportId? | string | Required. The image import identifier. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a imageImports
fn get(identifier: string)
Get a imageImports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the imageImports |
fn delete(identifier: string)
Delete the imageImports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the imageImports |
fn sync(identifier?: string)
Sync imageImports state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific imageImports by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List imageImports resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request (according to AIP-160). |
| orderBy? | string | Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by "name" field. |
| pageSize? | number | Optional. The maximum number of targets to return. The service may return fewer than this value. If unspecified, at most 500 targets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— ImageImport describes the configuration of the image import to run.
@swamp/gcp/vmmigration/imageimports-imageimportjobsv2026.07.21.2imageimports_imageimportjobs.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. |
| 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 get(identifier: string)
Get a imageImportJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the imageImportJobs |
fn sync(identifier?: string)
Sync imageImportJobs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific imageImportJobs by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List imageImportJobs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request (according to AIP-160). |
| orderBy? | string | Optional. The order by fields for the result (according to AIP-132). Currently ordering is only possible by "name" field. |
| pageSize? | number | Optional. The maximum number of targets to return. The service may return fewer than this value. If unspecified, at most 500 targets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel()
cancel
Resources
state(infinite)— ImageImportJob describes the progress and result of an image import.
@swamp/gcp/vmmigration/locationsv2026.07.21.3locations.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. |
| 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) |
Resources
state(infinite)— A resource that represents a Google Cloud location.
@swamp/gcp/vmmigration/sourcesv2026.07.21.3sources.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. |
| aws? | object | AWS type source details. |
| azure? | object | Azure type source details. |
| description? | string | User-provided description of the source. |
| encryption? | object | Optional. Immutable. The encryption details of the source data stored by the service. |
| labels? | record | The labels of the source. |
| vmware? | object | Vmware type source details. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| sourceId? | string | Required. The source identifier. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a sources
fn get(identifier: string)
Get a sources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sources |
fn update(identifier?: string)
Update sources attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sources by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the sources
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sources |
fn sync(identifier?: string)
Sync sources state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sources by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List sources resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of sources to return. The service may return fewer than this value. If unspecified, at most 500 sources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn fetch_inventory()
fetch inventory
fn fetch_storage_inventory()
fetch storage inventory
Resources
state(infinite)— Source message describes a specific vm migration Source resource. It contains...
@swamp/gcp/vmmigration/sources-datacenterconnectorsv2026.07.21.3sources_datacenterconnectors.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. |
| registrationId? | string | Immutable. A unique key for this connector. This key is internal to the OVA connector and is supplied with its creation during the registration process and can not be modified. |
| serviceAccount? | string | The service account to use in the connector when communicating with the cloud. |
| version? | string | The version running in the DatacenterConnector. This is supplied by the OVA connector during the registration process and can not be modified. |
| datacenterConnectorId? | string | Required. The datacenterConnector identifier. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| 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 datacenterConnectors
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a datacenterConnectors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the datacenterConnectors |
fn delete(identifier: string)
Delete the datacenterConnectors
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the datacenterConnectors |
fn sync(identifier?: string)
Sync datacenterConnectors state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific datacenterConnectors by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List datacenterConnectors resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of connectors to return. The service may return fewer than this value. If unspecified, at most 500 sources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn upgrade_appliance(requestId?: any)
upgrade appliance
| Argument | Type | Description |
|---|---|---|
| requestId? | any |
Resources
state(infinite)— DatacenterConnector message describes a connector between the Source and Goog...
@swamp/gcp/vmmigration/sources-diskmigrationjobsv2026.07.21.3sources_diskmigrationjobs.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. |
| awsSourceDiskDetails? | object | Details of the unattached AWS source disk. |
| targetDetails? | object | Required. Details of the target Disk in Compute Engine. |
| diskMigrationJobId? | string | Required. The DiskMigrationJob identifier. The maximum length of this value is 63 characters. Valid characters are lower case Latin letters, digits and hyphen. It must start with a Latin letter and must not end with a hyphen. |
| requestId? | string | Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request timed out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was receive |
| 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 diskMigrationJobs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a diskMigrationJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the diskMigrationJobs |
fn update(identifier?: string, waitForReady?: boolean)
Update diskMigrationJobs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific diskMigrationJobs by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the diskMigrationJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the diskMigrationJobs |
fn sync(identifier?: string)
Sync diskMigrationJobs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific diskMigrationJobs by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List diskMigrationJobs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request (according to AIP-160). |
| orderBy? | string | Optional. Ordering of the result list. |
| pageSize? | number | Optional. The maximum number of disk migration jobs to return. The service may return fewer than this value. If unspecified, at most 500 disk migration jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel()
cancel
fn run()
run
Resources
state(infinite)— Describes the disk which will be migrated from the source environment. The so...
@swamp/gcp/vmmigration/sources-migratingvmsv2026.07.21.4sources_migratingvms.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. |
| computeEngineDisksTargetDefaults? | object | Details of the target Persistent Disks in Compute Engine. |
| computeEngineTargetDefaults? | object | Details of the target VM in Compute Engine. |
| description? | string | The description attached to the migrating VM by the user. |
| displayName? | string | The display name attached to the MigratingVm by the user. |
| labels? | record | The labels of the migrating VM. |
| policy? | object | The replication schedule policy. |
| sourceVmId? | string | The unique ID of the VM in the source. The VM's name in vSphere can be changed, so this is not the VM's name but rather its moRef id. This id is of the form vm-. |
| migratingVmId? | string | Required. The migratingVm identifier. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| 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 migratingVms
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a migratingVms
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the migratingVms |
fn update(identifier?: string, waitForReady?: boolean)
Update migratingVms attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific migratingVms by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the migratingVms
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the migratingVms |
fn sync(identifier?: string)
Sync migratingVms state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific migratingVms by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)
List migratingVms resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of migrating VMs to return. The service may return fewer than this value. If unspecified, at most 500 migrating VMs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| view? | string | Optional. The level of details of each migrating VM. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn extend_migration()
extend migration
fn finalize_migration()
finalize migration
fn pause_migration()
pause migration
fn resume_migration()
resume migration
fn start_migration()
start migration
Resources
state(infinite)— MigratingVm describes the VM that will be migrated from a Source environment ...
@swamp/gcp/vmmigration/sources-migratingvms-clonejobsv2026.07.21.3sources_migratingvms_clonejobs.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. |
| cloneJobId? | string | Required. The clone job identifier. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| 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 cloneJobs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a cloneJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cloneJobs |
fn sync(identifier?: string)
Sync cloneJobs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific cloneJobs by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List cloneJobs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of clone jobs to return. The service may return fewer than this value. If unspecified, at most 500 clone jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel()
cancel
Resources
state(infinite)— CloneJob describes the process of creating a clone of a MigratingVM to the re...
@swamp/gcp/vmmigration/sources-migratingvms-cutoverjobsv2026.07.21.3sources_migratingvms_cutoverjobs.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. |
| cutoverJobId? | string | Required. The cutover job identifier. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| 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 cutoverJobs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a cutoverJobs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cutoverJobs |
fn sync(identifier?: string)
Sync cutoverJobs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific cutoverJobs by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List cutoverJobs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of cutover jobs to return. The service may return fewer than this value. If unspecified, at most 500 cutover jobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn cancel()
cancel
Resources
state(infinite)— CutoverJob message describes a cutover of a migrating VM. The CutoverJob is t...
@swamp/gcp/vmmigration/sources-migratingvms-replicationcyclesv2026.07.21.2sources_migratingvms_replicationcycles.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. |
| 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 get(identifier: string)
Get a replicationCycles
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the replicationCycles |
fn sync(identifier?: string)
Sync replicationCycles state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific replicationCycles by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List replicationCycles resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of replication cycles to return. The service may return fewer than this value. If unspecified, at most 100 migrating VMs will be returned. The maximum value is 100; values above 100 will be coerced to 100. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— ReplicationCycle contains information about the current replication cycle sta...
@swamp/gcp/vmmigration/sources-utilizationreportsv2026.07.21.3sources_utilizationreports.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. |
| displayName? | string | The report display name, as assigned by the user. |
| timeFrame? | enum | Time frame of the report. |
| vms? | array | List of utilization information per VM. When sent as part of the request, the "vm_id" field is used in order to specify which VMs to include in the report. In that case all other fields are ignored. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| utilizationReportId? | string | Required. The ID to use for the report, which will become the final component of the reports's resource name. This value maximum length is 63 characters, and valid characters are /a-z-/. It must start with an english letter and must not end with a hyphen. |
| 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 utilizationReports
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a utilizationReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the utilizationReports |
fn delete(identifier: string)
Delete the utilizationReports
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the utilizationReports |
fn sync(identifier?: string)
Sync utilizationReports state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific utilizationReports by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, view?: string, maxPages?: number)
List utilizationReports resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of reports to return. The service may return fewer than this value. If unspecified, at most 500 reports will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| view? | string | Optional. The level of details of each report. Defaults to BASIC. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— Utilization report details the utilization (CPU, memory, etc.) of selected so...
@swamp/gcp/vmmigration/targetprojectsv2026.07.21.3targetprojects.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. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| description? | string | The target project's description. |
| project? | string | Required. The target project ID (number) or project name. |
| requestId? | string | A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if |
| targetProjectId? | string | Required. The target_project identifier. |
| location? | string | The location for this resource (this resource only supports 'global') |
fn create()
Create a targetProjects
fn get(identifier: string)
Get a targetProjects
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetProjects |
fn update(identifier?: string)
Update targetProjects attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targetProjects by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the targetProjects
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetProjects |
fn sync(identifier?: string)
Sync targetProjects state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targetProjects by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List targetProjects resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter request. |
| orderBy? | string | Optional. the order by fields for the result. |
| pageSize? | number | Optional. The maximum number of targets to return. The service may return fewer than this value. If unspecified, at most 500 targets will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
Resources
state(infinite)— TargetProject message represents a target Compute Engine project for a migrat...
04Previous Versions
2026.07.21.1
- Updated: imageimports, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_utilizationreports, targetprojects
2026.07.20.2
- Updated: locations, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs
2026.07.20.1
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.07.19.2
- Updated: locations
2026.07.19.1
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.07.18.2
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.07.17.2
- Updated: groups, sources, sources_diskmigrationjobs, sources_migratingvms, targetprojects
2026.07.17.1
- Updated: groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.07.13.1
- Updated: targetprojects
2026.06.08.2
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.06.07.1
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.05.27.1
- Updated: sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs
2026.05.26.1
- Updated: locations
2026.05.25.1
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
Modified 13 models
2026.05.24.1
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.05.21.2
- Updated: locations, groups, imageimports, imageimports_imageimportjobs, sources, sources_datacenterconnectors, sources_diskmigrationjobs, sources_migratingvms, sources_migratingvms_clonejobs, sources_migratingvms_cutoverjobs, sources_migratingvms_replicationcycles, sources_utilizationreports, targetprojects
2026.05.21.1
2026.05.19.2
2026.05.19.1
05Stats
A
100 / 100
Downloads
0
Archive size
185.7 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