Google Cloud Platform logo

Google Compute Engine: Node.js Client

release level npm version

Google Compute Engine Client Library 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 Google Compute Engine API.
  4. Set up authentication with a service account 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/ directory. Each sample's README.md has instructions for running its sample.

Sample Source Code Try it
Create Instance source code Open in Cloud Shell
Create Instance From Template source code Open in Cloud Shell
Create Instance From Template With Overrides source code Open in Cloud Shell
Delete Instance source code Open in Cloud Shell
Disable Usage Export source code Open in Cloud Shell
Get Usage Export Bucket source code Open in Cloud Shell
List All Instances source code Open in Cloud Shell
List Images source code Open in Cloud Shell
List Images By Page source code Open in Cloud Shell
List Instances source code Open in Cloud Shell
Mailjet source code Open in Cloud Shell
Reset Instance source code Open in Cloud Shell
Sendgrid source code Open in Cloud Shell
Set Usage Export Bucket source code Open in Cloud Shell
Start Instance source code Open in Cloud Shell
Start Instance With Enc Key source code Open in Cloud Shell
Stop Instance source code Open in Cloud Shell
Wait For Operation source code Open in Cloud Shell

The Google Compute Engine Node.js Client API Reference documentation also contains samples.

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.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

Legacy Node.js versions are supported as a best effort:

  • Legacy versions will not be tested in continuous integration.
  • Some security patches may not be able to be backported.
  • Dependencies will not be kept up-to-date, and features will not be backported.

Legacy tags available

  • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

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.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE

NodeJS Compute

Node.js client for Google Compute Engine: Scalable, High-Performance Virtual Machines

NodeJS Compute Info

⭐ Stars 97
🔗 Homepage cloud.google.com
🔗 Source Code github.com
🕒 Last Update 7 months ago
🕒 Created 5 years ago
🐞 Open Issues 27
➗ Star-Issue Ratio 4
😎 Author googleapis