Dataflow: Node.js Client

dataflow client for Node.js

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

• Dataflow Node.js Client API Reference
• Dataflow Documentation
• github.com/googleapis/google-cloud-node/packages/google-dataflow

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
  • 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 Dataflow 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/dataflow

Using the client library

// Imports the Google Cloud client libraryconst {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 clientconst client = newTemplatesServiceClient();//TODO(library generator): write the actual function you will be testingasync function getTemplate() {  const template = await client.getTemplate({    projectId,    gcsPath,  });  console.info(template);}getTemplate();

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

Sample	Source Code	Try it
Flex_templates_service.launch_flex_template	source code
Jobs_v1_beta3.aggregated_list_jobs	source code
Jobs_v1_beta3.check_active_jobs	source code
Jobs_v1_beta3.create_job	source code
Jobs_v1_beta3.get_job	source code
Jobs_v1_beta3.list_jobs	source code
Jobs_v1_beta3.snapshot_job	source code
Jobs_v1_beta3.update_job	source code
Messages_v1_beta3.list_job_messages	source code
Metrics_v1_beta3.get_job_execution_details	source code
Metrics_v1_beta3.get_job_metrics	source code
Metrics_v1_beta3.get_stage_execution_details	source code
Snapshots_v1_beta3.delete_snapshot	source code
Snapshots_v1_beta3.get_snapshot	source code
Snapshots_v1_beta3.list_snapshots	source code
Templates_service.create_job_from_template	source code
Templates_service.get_template	source code
Templates_service.launch_template	source code
Quickstart	source code

TheDataflow 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/dataflow@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