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 Workstations 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:
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud Workstations API API.
- Set up authentication so you can access the API from your local workstation.
npm install @google-cloud/workstationsSamples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code |
|---|---|
| cloud | source code |
| create workstation | source code |
| create workstation cluster | source code |
| create workstation config | source code |
| delete workstation | source code |
| delete workstation cluster | source code |
| delete workstation config | source code |
| generate access token | source code |
| get workstation | source code |
| get workstation cluster | source code |
| get workstation config | source code |
| list usable workstation configs | source code |
| list usable workstations | source code |
| list workstation clusters | source code |
| list workstation configs | source code |
| list workstations | source code |
| start workstation | source code |
| stop workstation | source code |
| update workstation | source code |
| update workstation cluster | source code |
| update workstation config | source code |
| cloud | source code |
| create workstation | source code |
| create workstation cluster | source code |
| create workstation config | source code |
| delete workstation | source code |
| delete workstation cluster | source code |
| delete workstation config | source code |
| generate access token | source code |
| get workstation | source code |
| get workstation cluster | source code |
| get workstation config | source code |
| list usable workstation configs | source code |
| list usable workstations | source code |
| list workstation clusters | source code |
| list workstation configs | source code |
| list workstations | source code |
| start workstation | source code |
| stop workstation | source code |
| update workstation | source code |
| update workstation cluster | source code |
| update workstation config | source code |
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/workstations@legacy-8 installs client libraries
for versions compatible with Node.js 8.
This library follows Semantic Versioning.
More Information: Google Cloud Platform Launch Stages
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.
Apache Version 2.0
See LICENSE