1.3.0 • Published 1 month ago

@google-cloud/migrationcenter v1.3.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
1 month ago

Migration Center API: Node.js Client

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.

SampleSource CodeTry it
Migration_center.add_assets_to_groupsource codeOpen in Cloud Shell
Migration_center.aggregate_assets_valuessource codeOpen in Cloud Shell
Migration_center.batch_delete_assetssource codeOpen in Cloud Shell
Migration_center.batch_update_assetssource codeOpen in Cloud Shell
Migration_center.create_groupsource codeOpen in Cloud Shell
Migration_center.create_import_data_filesource codeOpen in Cloud Shell
Migration_center.create_import_jobsource codeOpen in Cloud Shell
Migration_center.create_preference_setsource codeOpen in Cloud Shell
Migration_center.create_reportsource codeOpen in Cloud Shell
Migration_center.create_report_configsource codeOpen in Cloud Shell
Migration_center.create_sourcesource codeOpen in Cloud Shell
Migration_center.delete_assetsource codeOpen in Cloud Shell
Migration_center.delete_groupsource codeOpen in Cloud Shell
Migration_center.delete_import_data_filesource codeOpen in Cloud Shell
Migration_center.delete_import_jobsource codeOpen in Cloud Shell
Migration_center.delete_preference_setsource codeOpen in Cloud Shell
Migration_center.delete_reportsource codeOpen in Cloud Shell
Migration_center.delete_report_configsource codeOpen in Cloud Shell
Migration_center.delete_sourcesource codeOpen in Cloud Shell
Migration_center.get_assetsource codeOpen in Cloud Shell
Migration_center.get_error_framesource codeOpen in Cloud Shell
Migration_center.get_groupsource codeOpen in Cloud Shell
Migration_center.get_import_data_filesource codeOpen in Cloud Shell
Migration_center.get_import_jobsource codeOpen in Cloud Shell
Migration_center.get_preference_setsource codeOpen in Cloud Shell
Migration_center.get_reportsource codeOpen in Cloud Shell
Migration_center.get_report_configsource codeOpen in Cloud Shell
Migration_center.get_settingssource codeOpen in Cloud Shell
Migration_center.get_sourcesource codeOpen in Cloud Shell
Migration_center.list_assetssource codeOpen in Cloud Shell
Migration_center.list_error_framessource codeOpen in Cloud Shell
Migration_center.list_groupssource codeOpen in Cloud Shell
Migration_center.list_import_data_filessource codeOpen in Cloud Shell
Migration_center.list_import_jobssource codeOpen in Cloud Shell
Migration_center.list_preference_setssource codeOpen in Cloud Shell
Migration_center.list_report_configssource codeOpen in Cloud Shell
Migration_center.list_reportssource codeOpen in Cloud Shell
Migration_center.list_sourcessource codeOpen in Cloud Shell
Migration_center.remove_assets_from_groupsource codeOpen in Cloud Shell
Migration_center.report_asset_framessource codeOpen in Cloud Shell
Migration_center.run_import_jobsource codeOpen in Cloud Shell
Migration_center.update_assetsource codeOpen in Cloud Shell
Migration_center.update_groupsource codeOpen in Cloud Shell
Migration_center.update_import_jobsource codeOpen in Cloud Shell
Migration_center.update_preference_setsource codeOpen in Cloud Shell
Migration_center.update_settingssource codeOpen in Cloud Shell
Migration_center.update_sourcesource codeOpen in Cloud Shell
Migration_center.validate_import_jobsource codeOpen in Cloud Shell
Quickstartsource codeOpen 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 in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

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