Migrate for Compute Engine: Node.js Client

release level npm version

vmmigration client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Migrate for Compute Engine API.
  4. Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/vmmigration

Using the client library

/**
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The parent, which owns this collection of targets.
 */
// const parent = 'abc123'
/**
 *  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.
 */
// const pageSize = 1234
/**
 *  Required. A page token, received from a previous `ListTargets` call.
 *  Provide this to retrieve the subsequent page.
 *  When paginating, all other parameters provided to `ListTargets` must
 *  match the call that provided the page token.
 */
// const pageToken = 'abc123'
/**
 *  Optional. The filter request.
 */
// const filter = 'abc123'
/**
 *  Optional. the order by fields for the result.
 */
// const orderBy = 'abc123'

// Imports the Vmmigration library
const {VmMigrationClient} = require('@google-cloud/vmmigration').v1;

// Instantiates a client
const vmmigrationClient = new VmMigrationClient();

async function callListTargetProjects() {
  // Construct request
  const request = {
    parent,
    pageToken,
  };

  // Run request
  const iterable = await vmmigrationClient.listTargetProjectsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListTargetProjects();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource CodeTry it
Vm_migration.add_group_migrationsource codeOpen in Cloud Shell
Vm_migration.cancel_clone_jobsource codeOpen in Cloud Shell
Vm_migration.cancel_cutover_jobsource codeOpen in Cloud Shell
Vm_migration.create_clone_jobsource codeOpen in Cloud Shell
Vm_migration.create_cutover_jobsource codeOpen in Cloud Shell
Vm_migration.create_datacenter_connectorsource codeOpen in Cloud Shell
Vm_migration.create_groupsource codeOpen in Cloud Shell
Vm_migration.create_migrating_vmsource codeOpen in Cloud Shell
Vm_migration.create_sourcesource codeOpen in Cloud Shell
Vm_migration.create_target_projectsource codeOpen in Cloud Shell
Vm_migration.create_utilization_reportsource codeOpen in Cloud Shell
Vm_migration.delete_datacenter_connectorsource codeOpen in Cloud Shell
Vm_migration.delete_groupsource codeOpen in Cloud Shell
Vm_migration.delete_migrating_vmsource codeOpen in Cloud Shell
Vm_migration.delete_sourcesource codeOpen in Cloud Shell
Vm_migration.delete_target_projectsource codeOpen in Cloud Shell
Vm_migration.delete_utilization_reportsource codeOpen in Cloud Shell
Vm_migration.fetch_inventorysource codeOpen in Cloud Shell
Vm_migration.finalize_migrationsource codeOpen in Cloud Shell
Vm_migration.get_clone_jobsource codeOpen in Cloud Shell
Vm_migration.get_cutover_jobsource codeOpen in Cloud Shell
Vm_migration.get_datacenter_connectorsource codeOpen in Cloud Shell
Vm_migration.get_groupsource codeOpen in Cloud Shell
Vm_migration.get_migrating_vmsource codeOpen in Cloud Shell
Vm_migration.get_replication_cyclesource codeOpen in Cloud Shell
Vm_migration.get_sourcesource codeOpen in Cloud Shell
Vm_migration.get_target_projectsource codeOpen in Cloud Shell
Vm_migration.get_utilization_reportsource codeOpen in Cloud Shell
Vm_migration.list_clone_jobssource codeOpen in Cloud Shell
Vm_migration.list_cutover_jobssource codeOpen in Cloud Shell