[Compute: Nodejs Client][homepage]

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.

Compute client for Node.js

Node.js idiomatic client for [Compute Engine][product-docs]. Compute Engine is a computing and hosting service that lets you create and run virtual machines on Google infrastructure. Compute Engine offers scale, performance, and value that lets you easily launch large compute clusters on Google infrastructure. There are no upfront investments, and you can run thousands of virtual CPUs on a system that offers quick, consistent performance. This library is GA from version 3.1.0. It is backwards-incompatible with prior versions 0.x.y, 1.x.y, 2.x.y, and 3.0.y. There are handwritten samples for this library in nodejs-docs-samples. Additionally, there are autogenerated samples in this library under samples/generated, but we recommend using handwritten guidance where possible.

A comprehensive list of changes in each version may be found in [the CHANGELOG][homepage_changelog].

• Compute Nodejs Client API Reference

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
  • Installing the client library

• Versioning

• Contributing

• License

Quickstart

Before you begin

1. [Select or create a Cloud Platform project][projects].
2. [Enable billing for your project][billing].
3. [Enable the Compute API][enable_api].
4. [Set up authentication][auth] so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/compute

Samples

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

| Sample | Source Code | | --------------------------- | --------------------------------- | | aggregated list | source code | | get | source code | | list | source code | | aggregated list | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | move | source code | | set labels | source code | | test iam permissions | source code | | aggregated list | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | update | source code | | add signed url key | source code | | delete | source code | | delete signed url key | source code | | get | source code | | get iam policy | source code | | insert | source code | | list | source code | | patch | source code | | set edge security policy | source code | | set iam policy | source code | | test iam permissions | source code | | update | source code | | add signed url key | source code | | aggregated list | source code | | delete | source code | | delete signed url key | source code | | get | source code | | get effective security policies | source code | | get health | source code | | get iam policy | source code | | insert | source code | | list | source code | | list usable | source code | | patch | source code | | set edge security policy | source code | | set iam policy | source code | | set security policy | source code | | test iam permissions | source code | | update | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | aggregated list | source code | | get | source code | | list | source code | | add resource policies | source code | | aggregated list | source code | | bulk insert | source code | | bulk set labels | source code | | create snapshot | source code | | delete | source code | | get | source code | | get iam policy | source code | | insert | source code | | list | source code | | remove resource policies | source code | | resize | source code | | set iam policy | source code | | set labels | source code | | start async replication | source code | | stop async replication | source code | | stop group async replication | source code | | test iam permissions | source code | | update | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | set labels | source code | | test iam permissions | source code | | add association | source code | | add rule | source code | | clone rules | source code | | delete | source code | | get | source code | | get association | source code | | get iam policy | source code | | get rule | source code | | insert | source code | | list | source code | | list associations | source code | | move | source code | | patch | source code | | patch rule | source code | | remove association | source code | | remove rule | source code | | set iam policy | source code | | test iam permissions | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | test iam permissions | source code | | update | source code | | aggregated list | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | set labels | source code | | set target | source code | | aggregated list | source code | | cancel | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | update | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | move | source code | | set labels | source code | | test iam permissions | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | set labels | source code | | set target | source code | | attach network endpoints | source code | | delete | source code | | detach network endpoints | source code | | get | source code | | insert | source code | | list | source code | | list network endpoints | source code | | aggregated list | source code | | delete | source code | | get | source code | | list | source code | | wait | source code | | delete | source code | | get | source code | | list | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | aggregated list | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | update | source code | | get | source code | | delete | source code | | deprecate | source code | | get | source code | | get from family | source code | | get iam policy | source code | | insert | source code | | list | source code | | patch | source code | | set iam policy | source code | | set labels | source code | | test iam permissions | source code | | cancel | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | abandon instances | source code | | aggregated list | source code | | apply updates to instances | source code | | create instances | source code | | delete | source code | | delete instances | source code | | delete per instance configs | source code | | get | source code | | insert | source code | | list | source code | | list errors | source code | | list managed instances | source code | | list per instance configs | source code | | patch | source code | | patch per instance configs | source code | | recreate instances | source code | | resize | source code | | resume instances | source code | | set instance template | source code | | set target pools | source code | | start instances | source code | | stop instances | source code | | suspend instances | source code | | update per instance configs | source code | | add instances | source code | | aggregated list | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | list instances | source code | | remove instances | source code | | set named ports | source code | | test iam permissions | source code | | get | source code | | patch | source code | | aggregated list | source code | | delete | source code | | get | source code | | get iam policy | source code | | insert | source code | | list | source code | | set iam policy | source code | | test iam permissions | source code | | add access config | source code | | add network interface | source code | | add resource policies | source code | | aggregated list | source code | | attach disk | source code | | bulk insert | source code | | delete | source code | | delete access config | source code | | delete network interface | source code | | detach disk | source code | | get | source code | | get effective firewalls | source code | | get guest attributes | source code | | get iam policy | source code | | get screenshot | source code | | get serial port output | source code | | get shielded instance identity | source code | | insert | source code | | list | source code | | list referrers | source code | | perform maintenance | source code | | remove resource policies | source code | | report host as faulty | source code | | reset | source code | | resume | source code | | send diagnostic interrupt | source code | | set deletion protection | source code | | set disk auto delete | source code | | set iam policy | source code | | set labels | source code | | set machine resources | source code | | set machine type | source code | | set metadata | source code | | set min cpu platform | source code | | set name | source code | | set scheduling | source code | | set security policy | source code | | set service account | source code | | set shielded instance integrity policy | source code | | set tags | source code | | simulate maintenance event | source code | | start | source code | | start with encryption key | source code | | stop | source code | | suspend | source code | | test iam permissions | source code | | update | source code | | update access config | source code | | update display device | source code | | update network interface | source code | | update shielded instance config | source code | | aggregated list | source code | | delete | source code | | get | source code | | get iam policy | source code | | insert | source code | | list | source code | | set iam policy | source code | | set labels | source code | | test iam permissions | source code | | delete | source code | | get | source code | | get iam policy | source code | | get operational status | source code | | insert | source code | | list | source code | | patch | source code | | set iam policy | source code | | test iam permissions | source code | | aggregated list | source code | | delete | source code | | get | source code | | insert | source code | | list | source code | | patch | source code | | set labels | source code | | create members | source code | | delete | source code | | get | source code | | get iam policy | source code | | get operational status | source code | | insert | source code | | list | source code | | patch | source code | | set iam policy | source code | | test iam permissions | source code | | get | source code | | list | source code | | get | source code | | list | source code | | delete | source code | | get | source code | | get diagnostics | source code | | get macsec config | source code | | insert | source code | | list | source code | | patch | source code | | set labels | source code | | get | source code | | test iam permissions | source code | | delete | source code | | get | source code | | get iam policy | source code | | insert | source code | | list | source code | | set iam policy | source code | | test iam permissions | source code | | update | source code | | delete | source code | | get | source code | | get iam policy | source code | | insert | source code | | list | source code | | set iam policy | source code | | set labels | source code | | test iam permissions | source code | | aggregated list | source code | | get | source code | | list | source code | | aggregated list | source code | | delete | source code | | get | source code | | get iam policy | source code | | insert | source code | | list | source code | | patch | source code | | set iam policy | source code | | test iam permissions | source code | | aggregated list | source code | | delete | source code | | get | source code | | insert | source code | | patch | source code | | aggregated list | source code | | attach network endpoints | source code | | delete | source code | | detach network endpoints | source code | | get | source code | | insert | [source cod