Skip to content

Latest commit

 

History

History

google-cloud-migrationcenter

Google Cloud Platform logo

release level npm version

Migration Center API 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 Migration Center API 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/migrationcenter

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. Parent value for `ListSourcesRequest`.
 */
// const parent = 'abc123'
/**
 *  Requested page size. The server may return fewer items than requested.
 *  If unspecified, the server will pick an appropriate default value.
 */
// const pageSize = 1234
/**
 *  A token identifying a page of results that the server should return.
 */
// const pageToken = 'abc123'
/**
 *  Filtering results.
 */
// const filter = 'abc123'
/**
 *  Field to sort by. See https://google.aip.dev/132#ordering for more details.
 */
// const orderBy = 'abc123'

// Imports the Migrationcenter library
const {MigrationCenterClient} = require('@google-cloud/migrationcenter').v1;

// Instantiates a client
const migrationcenterClient = new MigrationCenterClient();

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

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

callListSources();

Samples

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

Sample Source Code Try it
Migration_center.add_assets_to_group source code Open in Cloud Shell
Migration_center.aggregate_assets_values source code Open in Cloud Shell
Migration_center.batch_delete_assets source code Open in Cloud Shell
Migration_center.batch_update_assets source code Open in Cloud Shell
Migration_center.create_group source code Open in Cloud Shell
Migration_center.create_import_data_file source code Open in Cloud Shell
Migration_center.create_import_job source code Open in Cloud Shell
Migration_center.create_preference_set source code Open in Cloud Shell
Migration_center.create_report source code Open in Cloud Shell
Migration_center.create_report_config source code Open in Cloud Shell
Migration_center.create_source source code Open in Cloud Shell
Migration_center.delete_asset source code Open in Cloud Shell
Migration_center.delete_group source code Open in Cloud Shell
Migration_center.delete_import_data_file source code Open in Cloud Shell
Migration_center.delete_import_job source code Open in Cloud Shell
Migration_center.delete_preference_set source code Open in Cloud Shell
Migration_center.delete_report source code Open in Cloud Shell
Migration_center.delete_report_config source code Open in Cloud Shell
Migration_center.delete_source source code Open in Cloud Shell
Migration_center.get_asset source code Open in Cloud Shell
Migration_center.get_error_frame source code Open in Cloud Shell
Migration_center.get_group source code Open in Cloud Shell
Migration_center.get_import_data_file source code Open in Cloud Shell
Migration_center.get_import_job source code Open in Cloud Shell
Migration_center.get_preference_set source code Open in Cloud Shell
Migration_center.get_report source code Open in Cloud Shell
Migration_center.get_report_config source code Open in Cloud Shell
Migration_center.get_settings source code Open in Cloud Shell
Migration_center.get_source source code Open in Cloud Shell
Migration_center.list_assets source code Open in Cloud Shell
Migration_center.list_error_frames source code Open in Cloud Shell
Migration_center.list_groups source code Open in Cloud Shell
Migration_center.list_import_data_files source code Open in Cloud Shell
Migration_center.list_import_jobs source code Open in Cloud Shell
Migration_center.list_preference_sets source code Open in Cloud Shell
Migration_center.list_report_configs source code Open in Cloud Shell
Migration_center.list_reports source code Open in Cloud Shell
Migration_center.list_sources source code Open in Cloud Shell
Migration_center.remove_assets_from_group source code Open in Cloud Shell
Migration_center.report_asset_frames source code Open in Cloud Shell
Migration_center.run_import_job source code Open in Cloud Shell
Migration_center.update_asset source code Open in Cloud Shell
Migration_center.update_group source code Open in Cloud Shell
Migration_center.update_import_job source code Open in Cloud Shell
Migration_center.update_preference_set source code Open in Cloud Shell
Migration_center.update_settings source code Open in Cloud Shell
Migration_center.update_source source code Open in Cloud Shell
Migration_center.validate_import_job source code Open in Cloud Shell
Quickstart source code Open in Cloud Shell

The Migration Center API 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/migrationcenter@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

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

Contributing

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.

License

Apache Version 2.0

See LICENSE