Dataflow: Node.js Client

release level npm version

dataflow 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:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Dataflow 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/dataflow

Using the client library

// Imports the Google Cloud client library

const {TemplatesServiceClient} = require('@google-cloud/dataflow');

// TODO(developer): replace with your prefered project ID.
// const projectId = 'my-project'
// TODO(developer): replace with your bucket path.
// const gcsPath = 'gs://<bucket>/path'

// Creates a client
const client = new TemplatesServiceClient();

//TODO(library generator): write the actual function you will be testing
async function getTemplate() {
  const template = await client.getTemplate({


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

SampleSource CodeTry it
Flex_templates_service.launch_flex_templatesource codeOpen in Cloud Shell
Jobs_v1_beta3.aggregated_list_jobssource codeOpen in Cloud Shell
Jobs_v1_beta3.check_active_jobssource codeOpen in Cloud Shell
Jobs_v1_beta3.create_jobsource codeOpen in Cloud Shell
Jobs_v1_beta3.get_jobsource codeOpen in Cloud Shell
Jobs_v1_beta3.list_jobssource codeOpen in Cloud Shell
Jobs_v1_beta3.snapshot_jobsource codeOpen in Cloud Shell
Jobs_v1_beta3.update_jobsource codeOpen in Cloud Shell
Messages_v1_beta3.list_job_messagessource codeOpen in Cloud Shell
Metrics_v1_beta3.get_job_execution_detailssource codeOpen in Cloud Shell
Metrics_v1_beta3.get_job_metricssource codeOpen in Cloud Shell
Metrics_v1_beta3.get_stage_execution_detailssource codeOpen in Cloud Shell
Snapshots_v1_beta3.delete_snapshotsource codeOpen in Cloud Shell
Snapshots_v1_beta3.get_snapshotsource codeOpen in Cloud Shell
Snapshots_v1_beta3.list_snapshotssource codeOpen in Cloud Shell
Templates_service.create_job_from_templatesource codeOpen in Cloud Shell
Templates_service.get_templatesource codeOpen in Cloud Shell
Templates_service.launch_templatesource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Dataflow 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/dataflow@legacy-8 installs client libraries for versions compatible with Node.js 8.


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


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, 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.


Apache Version 2.0