Dataform API: Nodejs Client

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.

Dataform API client for Node.js

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

• Dataform API Nodejs Client API Reference
• Dataform API Documentation

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

• Versioning

• Contributing

• License

Quickstart

Before you begin

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Dataform API API.
4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/dataform

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | cancel workflow invocation | source code | | commit repository changes | source code | | commit workspace changes | source code | | compute repository access token status | source code | | create compilation result | source code | | create release config | source code | | create repository | source code | | create workflow config | source code | | create workflow invocation | source code | | create workspace | source code | | delete release config | source code | | delete repository | source code | | delete workflow config | source code | | delete workflow invocation | source code | | delete workspace | source code | | fetch file diff | source code | | fetch file git statuses | source code | | fetch git ahead behind | source code | | fetch remote branches | source code | | fetch repository history | source code | | get compilation result | source code | | get config | source code | | get release config | source code | | get repository | source code | | get workflow config | source code | | get workflow invocation | source code | | get workspace | source code | | install npm packages | source code | | list compilation results | source code | | list release configs | source code | | list repositories | source code | | list workflow configs | source code | | list workflow invocations | source code | | list workspaces | source code | | make directory | source code | | move directory | source code | | move file | source code | | pull git commits | source code | | push git commits | source code | | query compilation result actions | source code | | query directory contents | source code | | query repository directory contents | source code | | query workflow invocation actions | source code | | read file | source code | | read repository file | source code | | remove directory | source code | | remove file | source code | | reset workspace changes | source code | | search files | source code | | update config | source code | | update release config | source code | | update repository | source code | | update workflow config | source code | | write file | source code | | cloud | source code | | cancel workflow invocation | source code | | commit repository changes | source code | | commit workspace changes | source code | | compute repository access token status | source code | | create compilation result | source code | | create release config | source code | | create repository | source code | | create workflow config | source code | | create workflow invocation | source code | | create workspace | source code | | delete release config | source code | | delete repository | source code | | delete workflow config | source code | | delete workflow invocation | source code | | delete workspace | source code | | fetch file diff | source code | | fetch file git statuses | source code | | fetch git ahead behind | source code | | fetch remote branches | source code | | fetch repository history | source code | | get compilation result | source code | | get config | source code | | get release config | source code | | get repository | source code | | get workflow config | source code | | get workflow invocation | source code | | get workspace | source code | | install npm packages | source code | | list compilation results | source code | | list release configs | source code | | list repositories | source code | | list workflow configs | source code | | list workflow invocations | source code | | list workspaces | source code | | make directory | source code | | move directory | source code | | move file | source code | | pull git commits | source code | | push git commits | source code | | query compilation result actions | source code | | query directory contents | source code | | query repository directory contents | source code | | query workflow invocation actions | source code | | read file | source code | | read repository file | source code | | remove directory | source code | | remove file | source code | | reset workspace changes | source code | | search files | source code | | update config | source code | | update release config | source code | | update repository | source code | | update workflow config | source code | | write file | source code | | cloud | source 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/dataform@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