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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud Composer API API.
- Set up authentication so you can access the API from your local workstation. ### Installing the client library
npm install @google-cloud/orchestration-airflow
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| check upgrade | source code |
| create environment | source code |
| create user workloads config map | source code |
| create user workloads secret | source code |
| database failover | source code |
| delete environment | source code |
| delete user workloads config map | source code |
| delete user workloads secret | source code |
| execute airflow command | source code |
| fetch database properties | source code |
| get environment | source code |
| get user workloads config map | source code |
| get user workloads secret | source code |
| list environments | source code |
| list user workloads config maps | source code |
| list user workloads secrets | source code |
| list workloads | source code |
| load snapshot | source code |
| poll airflow command | source code |
| save snapshot | source code |
| stop airflow command | source code |
| update environment | source code |
| update user workloads config map | source code |
| update user workloads secret | source code |
| list image versions | source code |
| check upgrade | source code |
| create environment | source code |
| create user workloads config map | source code |
| create user workloads secret | source code |
| database failover | source code |
| delete environment | source code |
| delete user workloads config map | source code |
| delete user workloads secret | source code |
| execute airflow command | source code |
| fetch database properties | source code |
| get environment | source code |
| get user workloads config map | source code |
| get user workloads secret | source code |
| list environments | source code |
| list user workloads config maps | source code |
| list user workloads secrets | source code |
| list workloads | source code |
| load snapshot | source code |
| poll airflow command | source code |
| restart web server | source code |
| save snapshot | source code |
| stop airflow command | source code |
| update environment | source code |
| update user workloads config map | source code |
| update user workloads secret | source code |
| list image versions | 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/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