Back to Google Cloud Node

[Google Cloud Data Catalog API: Nodejs Client][homepage]

packages/google-cloud-datacatalog/README.md

0.57.022.9 KB
Original Source

Google Cloud Data Catalog 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

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

Installing the client library

bash
npm install @google-cloud/datacatalog

Samples

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

SampleSource Code
create entrysource code
create entry groupsource code
create tagsource code
create tag templatesource code
create tag template fieldsource code
delete entrysource code
delete entry groupsource code
delete tagsource code
delete tag templatesource code
delete tag template fieldsource code
get entrysource code
get entry groupsource code
get iam policysource code
get tag templatesource code
import entriessource code
list entriessource code
list entry groupssource code
list tagssource code
lookup entrysource code
modify entry contactssource code
modify entry overviewsource code
reconcile tagssource code
rename tag template fieldsource code
rename tag template field enum valuesource code
retrieve configsource code
retrieve effective configsource code
search catalogsource code
set configsource code
set iam policysource code
star entrysource code
test iam permissionssource code
unstar entrysource code
update entrysource code
update entry groupsource code
update tagsource code
update tag templatesource code
update tag template fieldsource code
create policy tagsource code
create taxonomysource code
delete policy tagsource code
delete taxonomysource code
get iam policysource code
get policy tagsource code
get taxonomysource code
list policy tagssource code
list taxonomiessource code
set iam policysource code
test iam permissionssource code
update policy tagsource code
update taxonomysource code
export taxonomiessource code
import taxonomiessource code
replace taxonomysource code
cloudsource code
create entrysource code
create entry groupsource code
create tagsource code
create tag templatesource code
create tag template fieldsource code
delete entrysource code
delete entry groupsource code
delete tagsource code
delete tag templatesource code
delete tag template fieldsource code
get entrysource code
get entry groupsource code
get iam policysource code
get tag templatesource code
list entriessource code
list entry groupssource code
list tagssource code
lookup entrysource code
rename tag template fieldsource code
rename tag template field enum valuesource code
search catalogsource code
set iam policysource code
test iam permissionssource code
update entrysource code
update entry groupsource code
update tagsource code
update tag templatesource code
update tag template fieldsource code
create policy tagsource code
create taxonomysource code
delete policy tagsource code
delete taxonomysource code
get iam policysource code
get policy tagsource code
get taxonomysource code
list policy tagssource code
list taxonomiessource code
set iam policysource code
test iam permissionssource code
update policy tagsource code
update taxonomysource code
export taxonomiessource code
import taxonomiessource code
cloudsource 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/datacatalog@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