@google-cloud/compute

v4.8.0

Published

10 days ago

Google Compute Engine Client Library for Node.js

Downloads

693,039

0High
0Medium
0Low

google-wombot

google apis client google api client google apis google api google google cloud platform google cloud cloud google compute compute accelerator types addresses autoscalers backend buckets backend services disks disk types external vpn gateways firewall policies firewalls forwarding rules global addresses global forwarding rules global network endpoint groups global operations global organization operations global public delegated prefixes health checks images instance group managers instance groups instances instance templates interconnect attachments interconnect locations interconnects license codes licenses machine types network endpoint groups networks node groups node templates node types packet mirrorings projects public advertised prefixes public delegated prefixes region autoscalers region backend services region commitments region disks region disk types region health checks region health check services region instance group managers region instance groups region instances region network endpoint groups region notification endpoints region operations regions region ssl certificates region target http proxies region target https proxies region url maps reservations resource policies routers routes security policies snapshots ssl certificates ssl policies subnetworks target grpc proxies target http proxies target https proxies target instances target pools target ssl proxies target tcp proxies target vpn gateways url maps vpn gateways vpn tunnels zone operations zones

Google Compute Engine: Node.js Client

Google Compute Engine Client Library for Node.js

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

[Google Compute Engine Node.js Client API Reference][client-docs]
[Google Compute Engine Documentation][product-docs]
github.com/googleapis/google-cloud-node/packages/google-cloud-compute

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

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

Installing the client library

npm install @google-cloud/compute

Using the client library

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';

const compute = require('@google-cloud/compute');

// List all instances in the specified project.
async function listAllInstances() {
  const instancesClient = new compute.InstancesClient();

  //Use the `maxResults` parameter to limit the number of results that the API returns per response page.
  const aggListRequest = instancesClient.aggregatedListAsync({
    project: projectId,
    maxResults: 5,
  });

  console.log('Instances found:');

  // Despite using the `maxResults` parameter, you don't need to handle the pagination
  // yourself. The returned object handles pagination automatically,
  // requesting next pages as you iterate over the results.
  for await (const [zone, instancesObject] of aggListRequest) {
    const instances = instancesObject.instances;

    if (instances && instances.length > 0) {
      console.log(` ${zone}`);
      for (const instance of instances) {
        console.log(` - ${instance.name} (${instance.machineType})`);
      }
    }
  }
}

listAllInstances();

Samples

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

Published

Vulnerabilities

Links

Maintainers

Keywords