ContextQMD
Back to Google Cloud Node

[Cloud Composer API: Nodejs Client][homepage]

packages/google-cloud-orchestration-airflow-service/README.md

0.57.016.0 KB
Original Source

Cloud Composer API: Nodejs Client

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority

Cloud Composer 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 Cloud Composer 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/orchestration-airflow

Samples

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

SampleSource Code
check upgradesource code
create environmentsource code
create user workloads config mapsource code
create user workloads secretsource code
database failoversource code
delete environmentsource code
delete user workloads config mapsource code
delete user workloads secretsource code
execute airflow commandsource code
fetch database propertiessource code
get environmentsource code
get user workloads config mapsource code
get user workloads secretsource code
list environmentssource code
list user workloads config mapssource code
list user workloads secretssource code
list workloadssource code
load snapshotsource code
poll airflow commandsource code
save snapshotsource code
stop airflow commandsource code
update environmentsource code
update user workloads config mapsource code
update user workloads secretsource code
list image versionssource code
cloudsource code
check upgradesource code
create environmentsource code
create user workloads config mapsource code
create user workloads secretsource code
database failoversource code
delete environmentsource code
delete user workloads config mapsource code
delete user workloads secretsource code
execute airflow commandsource code
fetch database propertiessource code
get environmentsource code
get user workloads config mapsource code
get user workloads secretsource code
list environmentssource code
list user workloads config mapssource code
list user workloads secretssource code
list workloadssource code
load snapshotsource code
poll airflow commandsource code
restart web serversource code
save snapshotsource code
stop airflow commandsource code
update environmentsource code
update user workloads config mapsource code
update user workloads secretsource code
list image versionssource 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/orchestration-airflow@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