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:


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 = {

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



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

SampleSource CodeTry it
Quickstartsource codeOpen in Cloud Shell

The Migrate for Compute Engine Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/vmmigration@legacy-8 installs client libraries for versions compatible with Node.js 8.


This library follows Semantic Versioning.

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.


Apache Version 2.0