Cloud Dataplex API: Nodejs Client

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority

npm version

Cloud Dataplex API client for Node.js

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

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient 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 API.
  4. Set up authentication so you can access theAPI from your local workstation.### Installing the client library
npm install @google-cloud/dataplex

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource Code
create glossarysource code
create glossary categorysource code
create glossary termsource code
delete glossarysource code
delete glossary categorysource code
delete glossary termsource code
get glossarysource code
get glossary categorysource code
get glossary termsource code
list glossariessource code
list glossary categoriessource code
list glossary termssource code
update glossarysource code
update glossary categorysource code
update glossary termsource code
cancel metadata jobsource code
create aspect typesource code
create entrysource code
create entry groupsource code
create entry linksource code
create entry typesource code
create metadata jobsource code
delete aspect typesource code
delete entrysource code
delete entry groupsource code
delete entry linksource code
delete entry typesource code
get aspect typesource code
get entrysource code
get entry groupsource code
get entry linksource code
get entry typesource code
get metadata jobsource code
list aspect typessource code
list entriessource code
list entry groupssource code
list entry typessource code
list metadata jobssource code
lookup entrysource code
search entriessource code
update aspect typesource code
update entrysource code
update entry groupsource code
update entry typesource code
create encryption configsource code
delete encryption configsource code
get encryption configsource code
list encryption configssource code
update encryption configsource code
create contentsource code
delete contentsource code
get contentsource code
get iam policysource code
list contentsource code
set iam policysource code
test iam permissionssource code
update contentsource code
create data scansource code
delete data scansource code
generate data quality rulessource code
get data scansource code
get data scan jobsource code
list data scan jobssource code
list data scanssource code
run data scansource code
update data scansource code
create data attributesource code
create data attribute bindingsource code
create data taxonomysource code
delete data attributesource code
delete data attribute bindingsource code
delete data taxonomysource code
get data attributesource code
get data attribute bindingsource code
get data taxonomysource code
list data attribute bindingssource code
list data attributessource code
list data taxonomiessource code
update data attributesource code
update data attribute bindingsource code
update data taxonomysource code
cancel jobsource code
create assetsource code
create environmentsource code
create lakesource code
create tasksource code
create zonesource code
delete assetsource code
delete environmentsource code
delete lakesource code
delete tasksource code
delete zonesource code
get assetsource code
get environmentsource code
get jobsource code
get lakesource code
get tasksource code
get zonesource code
list asset actionssource code
list assetssource code
list environmentssource code
list jobssource code
list lake actionssource code
list lakessource code
list sessionssource code
list taskssource code
list zone actionssource code
list zonessource code
run tasksource code
update assetsource code
update environmentsource code
update lakesource code
update tasksource code
update zonesource code
create entitysource code
create partitionsource code
delete entitysource code
delete partitionsource code
get entitysource code
get partitionsource code
list entitiessource code
list partitionssource code
update entitysource code
cloudsource code

Supported Node.js Versions

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/dataplex@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.mdand a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-12 UTC.