Back to Google Cloud Node

[Dataform API: Nodejs Client][homepage]

packages/google-cloud-dataform/README.md

0.57.024.7 KB
Original Source

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.

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

  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

bash
npm install @google-cloud/dataform

Samples

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

SampleSource Code
cancel workflow invocationsource code
commit repository changessource code
commit workspace changessource code
compute repository access token statussource code
create compilation resultsource code
create release configsource code
create repositorysource code
create workflow configsource code
create workflow invocationsource code
create workspacesource code
delete release configsource code
delete repositorysource code
delete workflow configsource code
delete workflow invocationsource code
delete workspacesource code
fetch file diffsource code
fetch file git statusessource code
fetch git ahead behindsource code
fetch remote branchessource code
fetch repository historysource code
get compilation resultsource code
get configsource code
get release configsource code
get repositorysource code
get workflow configsource code
get workflow invocationsource code
get workspacesource code
install npm packagessource code
list compilation resultssource code
list release configssource code
list repositoriessource code
list workflow configssource code
list workflow invocationssource code
list workspacessource code
make directorysource code
move directorysource code
move filesource code
pull git commitssource code
push git commitssource code
query compilation result actionssource code
query directory contentssource code
query repository directory contentssource code
query workflow invocation actionssource code
read filesource code
read repository filesource code
remove directorysource code
remove filesource code
reset workspace changessource code
search filessource code
update configsource code
update release configsource code
update repositorysource code
update workflow configsource code
write filesource code
cloudsource code
cancel workflow invocationsource code
commit repository changessource code
commit workspace changessource code
compute repository access token statussource code
create compilation resultsource code
create release configsource code
create repositorysource code
create workflow configsource code
create workflow invocationsource code
create workspacesource code
delete release configsource code
delete repositorysource code
delete workflow configsource code
delete workflow invocationsource code
delete workspacesource code
fetch file diffsource code
fetch file git statusessource code
fetch git ahead behindsource code
fetch remote branchessource code
fetch repository historysource code
get compilation resultsource code
get configsource code
get release configsource code
get repositorysource code
get workflow configsource code
get workflow invocationsource code
get workspacesource code
install npm packagessource code
list compilation resultssource code
list release configssource code
list repositoriessource code
list workflow configssource code
list workflow invocationssource code
list workspacessource code
make directorysource code
move directorysource code
move filesource code
pull git commitssource code
push git commitssource code
query compilation result actionssource code
query directory contentssource code
query repository directory contentssource code
query workflow invocation actionssource code
read filesource code
read repository filesource code
remove directorysource code
remove filesource code
reset workspace changessource code
search filessource code
update configsource code
update release configsource code
update repositorysource code
update workflow configsource code
write filesource code
cloudsource 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