@google-cloud/dataplex

Cloud Dataplex: Node.js Client

dataplex client for Node.js

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

• Cloud Dataplex Node.js Client API Reference
• Cloud Dataplex Documentation
• github.com/googleapis/google-cloud-node/packages/google-cloud-dataplex

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
  • Installing the client library
  • Using the client library
• Samples
• Versioning
• Contributing
• License

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 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.

Sample	Source Code	Try it
Catalog_service.cancel_metadata_job	source code
Catalog_service.create_aspect_type	source code
Catalog_service.create_entry	source code
Catalog_service.create_entry_group	source code
Catalog_service.create_entry_type	source code
Catalog_service.create_metadata_job	source code
Catalog_service.delete_aspect_type	source code
Catalog_service.delete_entry	source code
Catalog_service.delete_entry_group	source code
Catalog_service.delete_entry_type	source code
Catalog_service.get_aspect_type	source code
Catalog_service.get_entry	source code
Catalog_service.get_entry_group	source code
Catalog_service.get_entry_type	source code
Catalog_service.get_metadata_job	source code
Catalog_service.list_aspect_types	source code
Catalog_service.list_entries	source code
Catalog_service.list_entry_groups	source code
Catalog_service.list_entry_types	source code
Catalog_service.list_metadata_jobs	source code
Catalog_service.lookup_entry	source code
Catalog_service.search_entries	source code
Catalog_service.update_aspect_type	source code
Catalog_service.update_entry	source code
Catalog_service.update_entry_group	source code
Catalog_service.update_entry_type	source code
Content_service.create_content	source code
Content_service.delete_content	source code
Content_service.get_content	source code
Content_service.get_iam_policy	source code
Content_service.list_content	source code
Content_service.set_iam_policy	source code
Content_service.test_iam_permissions	source code
Content_service.update_content	source code
Data_scan_service.create_data_scan	source code
Data_scan_service.delete_data_scan	source code
Data_scan_service.generate_data_quality_rules	source code
Data_scan_service.get_data_scan	source code
Data_scan_service.get_data_scan_job	source code
Data_scan_service.list_data_scan_jobs	source code
Data_scan_service.list_data_scans	source code
Data_scan_service.run_data_scan	source code
Data_scan_service.update_data_scan	source code
Data_taxonomy_service.create_data_attribute	source code
Data_taxonomy_service.create_data_attribute_binding	source code
Data_taxonomy_service.create_data_taxonomy	source code
Data_taxonomy_service.delete_data_attribute	source code
Data_taxonomy_service.delete_data_attribute_binding	source code
Data_taxonomy_service.delete_data_taxonomy	source code
Data_taxonomy_service.get_data_attribute	source code
Data_taxonomy_service.get_data_attribute_binding	source code
Data_taxonomy_service.get_data_taxonomy	source code
Data_taxonomy_service.list_data_attribute_bindings	source code
Data_taxonomy_service.list_data_attributes	source code
Data_taxonomy_service.list_data_taxonomies	source code
Data_taxonomy_service.update_data_attribute	source code
Data_taxonomy_service.update_data_attribute_binding	source code
Data_taxonomy_service.update_data_taxonomy	source code
Dataplex_service.cancel_job	source code
Dataplex_service.create_asset	source code
Dataplex_service.create_environment	source code
Dataplex_service.create_lake	source code
Dataplex_service.create_task	source code
Dataplex_service.create_zone	source code
Dataplex_service.delete_asset	source code
Dataplex_service.delete_environment	source code
Dataplex_service.delete_lake	source code
Dataplex_service.delete_task	source code
Dataplex_service.delete_zone	source code
Dataplex_service.get_asset	source code
Dataplex_service.get_environment	source code
Dataplex_service.get_job	source code
Dataplex_service.get_lake	source code
Dataplex_service.get_task	source code
Dataplex_service.get_zone	source code
Dataplex_service.list_asset_actions	source code
Dataplex_service.list_assets	source code
Dataplex_service.list_environments	source code
Dataplex_service.list_jobs	source code
Dataplex_service.list_lake_actions	source code
Dataplex_service.list_lakes	source code
Dataplex_service.list_sessions	source code
Dataplex_service.list_tasks	source code
Dataplex_service.list_zone_actions	source code
Dataplex_service.list_zones	source code
Dataplex_service.run_task	source code
Dataplex_service.update_asset	source code
Dataplex_service.update_environment	source code
Dataplex_service.update_lake	source code
Dataplex_service.update_task	source code
Dataplex_service.update_zone	source code
Metadata_service.create_entity	source code
Metadata_service.create_partition	source code
Metadata_service.delete_entity	source code
Metadata_service.delete_partition	source code
Metadata_service.get_entity	source code
Metadata_service.get_partition	source code
Metadata_service.list_entities	source code
Metadata_service.list_partitions	source code
Metadata_service.update_entity	source code
Quickstart	source code

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