Cloud Dataplex API: Nodejs Client

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

Cloud Dataplex API client for Node.js

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

• Cloud Dataplex API Nodejs Client API Reference
• Cloud Dataplex API Documentation

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

• 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 API.
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/dataplex

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | create glossary | source code | | create glossary category | source code | | create glossary term | source code | | delete glossary | source code | | delete glossary category | source code | | delete glossary term | source code | | get glossary | source code | | get glossary category | source code | | get glossary term | source code | | list glossaries | source code | | list glossary categories | source code | | list glossary terms | source code | | update glossary | source code | | update glossary category | source code | | update glossary term | source code | | cancel metadata job | source code | | create aspect type | source code | | create entry | source code | | create entry group | source code | | create entry link | source code | | create entry type | source code | | create metadata job | source code | | delete aspect type | source code | | delete entry | source code | | delete entry group | source code | | delete entry link | source code | | delete entry type | source code | | get aspect type | source code | | get entry | source code | | get entry group | source code | | get entry link | source code | | get entry type | source code | | get metadata job | source code | | list aspect types | source code | | list entries | source code | | list entry groups | source code | | list entry types | source code | | list metadata jobs | source code | | lookup entry | source code | | search entries | source code | | update aspect type | source code | | update entry | source code | | update entry group | source code | | update entry type | source code | | create encryption config | source code | | delete encryption config | source code | | get encryption config | source code | | list encryption configs | source code | | update encryption config | source code | | create content | source code | | delete content | source code | | get content | source code | | get iam policy | source code | | list content | source code | | set iam policy | source code | | test iam permissions | source code | | update content | source code | | create data scan | source code | | delete data scan | source code | | generate data quality rules | source code | | get data scan | source code | | get data scan job | source code | | list data scan jobs | source code | | list data scans | source code | | run data scan | source code | | update data scan | source code | | create data attribute | source code | | create data attribute binding | source code | | create data taxonomy | source code | | delete data attribute | source code | | delete data attribute binding | source code | | delete data taxonomy | source code | | get data attribute | source code | | get data attribute binding | source code | | get data taxonomy | source code | | list data attribute bindings | source code | | list data attributes | source code | | list data taxonomies | source code | | update data attribute | source code | | update data attribute binding | source code | | update data taxonomy | source code | | cancel job | source code | | create asset | source code | | create environment | source code | | create lake | source code | | create task | source code | | create zone | source code | | delete asset | source code | | delete environment | source code | | delete lake | source code | | delete task | source code | | delete zone | source code | | get asset | source code | | get environment | source code | | get job | source code | | get lake | source code | | get task | source code | | get zone | source code | | list asset actions | source code | | list assets | source code | | list environments | source code | | list jobs | source code | | list lake actions | source code | | list lakes | source code | | list sessions | source code | | list tasks | source code | | list zone actions | source code | | list zones | source code | | run task | source code | | update asset | source code | | update environment | source code | | update lake | source code | | update task | source code | | update zone | source code | | create entity | source code | | create partition | source code | | delete entity | source code | | delete partition | source code | | get entity | source code | | get partition | source code | | list entities | source code | | list partitions | source code | | update entity | source code | | cloud | source code |

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE