Back to Google Cloud Node

[Cloud Workstations API: Nodejs Client][homepage]

packages/google-cloud-workstations/README.md

0.57.012.9 KB
Original Source

Cloud Workstations 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 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:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Workstations 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/workstations

Samples

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

SampleSource Code
cloudsource code
create workstationsource code
create workstation clustersource code
create workstation configsource code
delete workstationsource code
delete workstation clustersource code
delete workstation configsource code
generate access tokensource code
get workstationsource code
get workstation clustersource code
get workstation configsource code
list usable workstation configssource code
list usable workstationssource code
list workstation clusterssource code
list workstation configssource code
list workstationssource code
start workstationsource code
stop workstationsource code
update workstationsource code
update workstation clustersource code
update workstation configsource code
cloudsource code
create workstationsource code
create workstation clustersource code
create workstation configsource code
delete workstationsource code
delete workstation clustersource code
delete workstation configsource code
generate access tokensource code
get workstationsource code
get workstation clustersource code
get workstation configsource code
list usable workstation configssource code
list usable workstationssource code
list workstation clusterssource code
list workstation configssource code
list workstationssource code
start workstationsource code
stop workstationsource code
update workstationsource code
update workstation clustersource code
update workstation configsource 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/workstations@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