Stay organized with collections Save and categorize content based on your preferences.

Cloud Dataplex: Node.js Client

release level npm version

dataplex 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 Cloud Dataplex 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/dataplex

Using the client library

// Imports the Google Cloud client library

// eslint-disable-next-line node/no-missing-require
const {DataplexServiceClient} = require('@google-cloud/dataplex');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'
// const location = 'my-location'

// Creates a client1046198160504
// eslint-disable-next-line no-unused-vars
const client = new DataplexServiceClient();

async function listLakes() {
  const [lakes] = await client.listLakes({
    parent: `projects/${projectId}/locations/${location}`,
  });
  console.info(lakes);
}
listLakes();

Samples

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

SampleSource CodeTry it
Content_service.create_contentsource codeOpen in Cloud Shell
Content_service.delete_contentsource codeOpen in Cloud Shell
Content_service.get_contentsource codeOpen in Cloud Shell
Content_service.get_iam_policysource codeOpen in Cloud Shell
Content_service.list_contentsource codeOpen in Cloud Shell
Content_service.set_iam_policysource codeOpen in Cloud Shell
Content_service.test_iam_permissionssource codeOpen in Cloud Shell
Content_service.update_contentsource codeOpen in Cloud Shell
Dataplex_service.cancel_jobsource codeOpen in Cloud Shell
Dataplex_service.create_assetsource codeOpen in Cloud Shell
Dataplex_service.create_environmentsource codeOpen in Cloud Shell
Dataplex_service.create_lakesource codeOpen in Cloud Shell
Dataplex_service.create_tasksource codeOpen in Cloud Shell
Dataplex_service.create_zonesource codeOpen in Cloud Shell
Dataplex_service.delete_assetsource codeOpen in Cloud Shell
Dataplex_service.delete_environmentsource codeOpen in Cloud Shell
Dataplex_service.delete_lakesource codeOpen in Cloud Shell
Dataplex_service.delete_tasksource codeOpen in Cloud Shell
Dataplex_service.delete_zonesource codeOpen in Cloud Shell
Dataplex_service.get_assetsource codeOpen in Cloud Shell
Dataplex_service.get_environmentsource codeOpen in Cloud Shell
Dataplex_service.get_jobsource codeOpen in Cloud Shell
Dataplex_service.get_lakesource codeOpen in Cloud Shell
Dataplex_service.get_tasksource codeOpen in Cloud Shell
Dataplex_service.get_zonesource codeOpen in Cloud Shell
Dataplex_service.list_asset_actionssource codeOpen in Cloud Shell
Dataplex_service.list_assetssource codeOpen in Cloud Shell
Dataplex_service.list_environmentssource codeOpen in Cloud Shell
Dataplex_service.list_jobssource codeOpen in Cloud Shell
Dataplex_service.list_lake_actionssource codeOpen in Cloud Shell
Dataplex_service.list_lakessource codeOpen in Cloud Shell
Dataplex_service.list_sessionssource codeOpen in Cloud Shell
Dataplex_service.list_taskssource codeOpen in Cloud Shell
Dataplex_service.list_zone_actionssource codeOpen in Cloud Shell
Dataplex_service.list_zonessource codeOpen in Cloud Shell
Dataplex_service.update_assetsource codeOpen in Cloud Shell
Dataplex_service.update_environmentsource codeOpen in Cloud Shell
Dataplex_service.update_lakesource codeOpen in Cloud Shell
Dataplex_service.update_tasksource codeOpen in Cloud Shell
Dataplex_service.update_zonesource codeOpen in Cloud Shell
Metadata_service.create_entitysource codeOpen in Cloud Shell
Metadata_service.create_partitionsource codeOpen in Cloud Shell
Metadata_service.delete_entitysource codeOpen in Cloud Shell
Metadata_service.delete_partitionsource codeOpen in Cloud Shell
Metadata_service.get_entitysource codeOpen in Cloud Shell
Metadata_service.get_partitionsource codeOpen in Cloud Shell
Metadata_service.list_entitiessource codeOpen in Cloud Shell
Metadata_service.list_partitionssource codeOpen in Cloud Shell
Metadata_service.update_entitysource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Cloud Dataplex 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/dataplex@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