Data Lineage API: Node.js Client

release levelnpm version

Data Lineage 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 Data Lineage API API.
  4. Set up authentication with a service account so you can access theAPI 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 libraryconst {LineageClient} = require('@google-cloud/lineage').v1;// Instantiates a clientconst lineageClient = newLineageClient();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 thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource CodeTry it
Lineage.batch_search_link_processessource codeOpen in Cloud Shell
Lineage.create_lineage_eventsource codeOpen in Cloud Shell
Lineage.create_processsource codeOpen in Cloud Shell
Lineage.create_runsource codeOpen in Cloud Shell
Lineage.delete_lineage_eventsource codeOpen in Cloud Shell
Lineage.delete_processsource codeOpen in Cloud Shell
Lineage.delete_runsource codeOpen in Cloud Shell
Lineage.get_lineage_eventsource codeOpen in Cloud Shell
Lineage.get_processsource codeOpen in Cloud Shell
Lineage.get_runsource codeOpen in Cloud Shell
Lineage.list_lineage_eventssource codeOpen in Cloud Shell
Lineage.list_processessource codeOpen in Cloud Shell
Lineage.list_runssource codeOpen in Cloud Shell
Lineage.process_open_lineage_run_eventsource codeOpen in Cloud Shell
Lineage.search_linkssource codeOpen in Cloud Shell
Lineage.update_processsource codeOpen in Cloud Shell
Lineage.update_runsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

TheData Lineage API Node.js Client API Reference documentationalso contains samples.

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/lineage@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

This library is considered to be inpreview. This means it is still awork-in-progress and under active development. Any release is subject tobackwards-incompatible changes at any time.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

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-10-30 UTC.