Repository files navigation

THIS REPOSITORY IS DEPRECATED. ALL OF ITS CONTENT AND HISTORY HAS BEEN MOVED TOGOOGLE-CLOUD-NODE

Node.js idiomatic client forCompute Engine.Compute Engine is acomputing and hosting service that lets you create and run virtualmachines on Google infrastructure. Compute Engine offers scale,performance, and value that lets you easily launch large computeclusters on Google's infrastructure. There are no upfrontinvestments, and you can run thousands of virtual CPUs on a systemthat offers quick, consistent performance.

This library is GA from version 3.1.0. It isbackwards-incompatible with prior versions 0.x.y, 1.x.y, 2.x.y,and 3.0.y.

A comprehensive list of changes in each version may be found inthe CHANGELOG.

• Google Compute Engine Node.js Client API Reference
• Google Compute Engine Documentation
• github.com/googleapis/nodejs-compute

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient Libraries Explained.

Table of contents:

• Quickstart

  • Before you begin
  • Installing the client library

• Samples

• Versioning

• Contributing

• License

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 theAPI from your local workstation.

npm install @google-cloud/compute

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

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

TheGoogle Compute Engine Node.js Client API Reference documentationalso contains samples.

Our client libraries follow theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/compute@legacy-8 installs client librariesfor versions compatible with Node.js 8.

This library followsSemantic Versioning.

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare addressed with the highest priority.

More Information:Google Cloud Platform Launch Stages

Contributions welcome! See theContributing Guide.

Please note that thisREADME.md, thesamples/README.md,and a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template. To edit one of these files, make an editto its templates indirectory.

Apache Version 2.0

SeeLICENSE