Data Lineage API: Node.js Client

Data Lineage API client for Node.js

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

• Data Lineage API Node.js Client API Reference

• github.com/googleapis/google-cloud-node/packages/google-cloud-datacatalog-lineage

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 Data Lineage API 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/lineage 

Using the client library

 /**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Required. The name of the project and its location that owns this
 *  collection of processes.
 */
// const parent = 'abc123'
/**
 *  The maximum number of processes to return. The service may return
 *  fewer than this value. If unspecified, at most 50 processes are
 *  returned. The maximum value is 100; values greater than 100 are cut to
 *  100.
 */
// const pageSize = 1234
/**
 *  The page token received from a previous `ListProcesses` call. Specify
 *  it to get the next page.
 *  When paginating, all other parameters specified in this call must
 *  match the parameters of the call that provided the page token.
 */
// const pageToken = 'abc123'

// Imports the Lineage library
const {LineageClient} = require(' @google-cloud/lineage 
').v1;

// Instantiates a client
const lineageClient = new LineageClient 
();

async function callListProcesses() {
  // Construct request
  const request = {
    parent,
  };

  // Run request
  const iterable = await lineageClient. listProcessesAsync 
(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListProcesses(); 

Samples

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

Sample	Source Code	Try it
Lineage.batch_search_link_processes	source code
Lineage.create_lineage_event	source code
Lineage.create_process	source code
Lineage.create_run	source code
Lineage.delete_lineage_event	source code
Lineage.delete_process	source code
Lineage.delete_run	source code
Lineage.get_lineage_event	source code
Lineage.get_process	source code
Lineage.get_run	source code
Lineage.list_lineage_events	source code
Lineage.list_processes	source code
Lineage.list_runs	source code
Lineage.process_open_lineage_run_event	source code
Lineage.search_links	source code
Lineage.update_process	source code
Lineage.update_run	source code
Quickstart	source code

The Data Lineage API 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/lineage@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning .

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

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