@google-cloud/dataform

Dataform API: Node.js Client

dataform client for Node.js

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

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

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

• 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 Dataform 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/dataform

Samples

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

Sample	Source Code	Try it
Dataform.cancel_workflow_invocation	source code
Dataform.commit_workspace_changes	source code
Dataform.create_compilation_result	source code
Dataform.create_repository	source code
Dataform.create_workflow_invocation	source code
Dataform.create_workspace	source code
Dataform.delete_repository	source code
Dataform.delete_workflow_invocation	source code
Dataform.delete_workspace	source code
Dataform.fetch_file_diff	source code
Dataform.fetch_file_git_statuses	source code
Dataform.fetch_git_ahead_behind	source code
Dataform.fetch_remote_branches	source code
Dataform.get_compilation_result	source code
Dataform.get_repository	source code
Dataform.get_workflow_invocation	source code
Dataform.get_workspace	source code
Dataform.install_npm_packages	source code
Dataform.list_compilation_results	source code
Dataform.list_repositories	source code
Dataform.list_workflow_invocations	source code
Dataform.list_workspaces	source code
Dataform.make_directory	source code
Dataform.move_directory	source code
Dataform.move_file	source code
Dataform.pull_git_commits	source code
Dataform.push_git_commits	source code
Dataform.query_compilation_result_actions	source code
Dataform.query_directory_contents	source code
Dataform.query_workflow_invocation_actions	source code
Dataform.read_file	source code
Dataform.remove_directory	source code
Dataform.remove_file	source code
Dataform.reset_workspace_changes	source code
Dataform.update_repository	source code
Dataform.write_file	source code
Dataform.cancel_workflow_invocation	source code
Dataform.commit_repository_changes	source code
Dataform.commit_workspace_changes	source code
Dataform.compute_repository_access_token_status	source code
Dataform.create_compilation_result	source code
Dataform.create_release_config	source code
Dataform.create_repository	source code
Dataform.create_workflow_config	source code
Dataform.create_workflow_invocation	source code
Dataform.create_workspace	source code
Dataform.delete_release_config	source code
Dataform.delete_repository	source code
Dataform.delete_workflow_config	source code
Dataform.delete_workflow_invocation	source code
Dataform.delete_workspace	source code
Dataform.fetch_file_diff	source code
Dataform.fetch_file_git_statuses	source code
Dataform.fetch_git_ahead_behind	source code
Dataform.fetch_remote_branches	source code
Dataform.fetch_repository_history	source code
Dataform.get_compilation_result	source code
Dataform.get_release_config	source code
Dataform.get_repository	source code
Dataform.get_workflow_config	source code
Dataform.get_workflow_invocation	source code
Dataform.get_workspace	source code
Dataform.install_npm_packages	source code
Dataform.list_compilation_results	source code
Dataform.list_release_configs	source code
Dataform.list_repositories	source code
Dataform.list_workflow_configs	source code
Dataform.list_workflow_invocations	source code
Dataform.list_workspaces	source code
Dataform.make_directory	source code
Dataform.move_directory	source code
Dataform.move_file	source code
Dataform.pull_git_commits	source code
Dataform.push_git_commits	source code
Dataform.query_compilation_result_actions	source code
Dataform.query_directory_contents	source code
Dataform.query_repository_directory_contents	source code
Dataform.query_workflow_invocation_actions	source code
Dataform.read_file	source code
Dataform.read_repository_file	source code
Dataform.remove_directory	source code
Dataform.remove_file	source code
Dataform.reset_workspace_changes	source code
Dataform.update_release_config	source code
Dataform.update_repository	source code
Dataform.update_workflow_config	source code
Dataform.write_file	source code
Quickstart	source code

The Dataform 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/dataform@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