Constructor

Compute

new Compute(options)

Parameter

options

Optional

ClientConfig

Configuration options.

See also

What is Google Compute Engine?

Examples

Create a client that uses Application Default Credentials (ADC)

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

Create a client with explicit credentials

const Compute = require('@google-cloud/compute');
const compute = new Compute({
  projectId: 'your-project-id',
  keyFilename: '/path/to/keyfile.json'
});

Properties

Firewall

static

constructor

Firewall class.

See also
Firewall

HealthCheck

static

constructor

HealthCheck class.

See also
HealthCheck

Network

static

constructor

Network class.

See also
Network

Operation

static

constructor

Operation class.

See also
Operation

Project

static

constructor

Project class.

See also
Project

Region

static

constructor

Region class.

See also
Region

Rule

static

constructor

Rule class.

See also
Rule

Service

static

constructor

Service class.

See also
Service

Snapshot

static

constructor

Snapshot class.

See also
Snapshot

Zone

static

constructor

Zone class.

See also
Zone

getAddressesStream

Get a list of Address objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getAddresses for a complete list of options.

Returns

stream 

Example

gce.getAddressesStream()
  .on('error', console.error)
  .on('data', function(address) {
    // `address` is an `Address` object.
  })
  .on('end', function() {
    // All addresses retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getAddressesStream()
  .on('data', function(address) {
    this.end();
  });

getAutoscalersStream

Get a list of Autoscaler objects as a readable object stream.

Parameter

query

Optional

object

Configuration object. See Compute#getAutoscalers for a complete list of options.

Returns

stream 

Example

gce.getAutoscalersStream()
  .on('error', console.error)
  .on('data', function(autoscaler) {
    // `autoscaler` is an `Autoscaler` object.
  })
  .on('end', function() {
    // All addresses retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getAutoscalersStream()
  .on('data', function(address) {
    this.end();
  });

Methods

createFirewall

createFirewall(name, config, callback)

Create a firewall.

Parameter

name

string

Name of the firewall.

config

object

See a Firewall resource.

callback

function()

The callback function.

See also

Firewalls Overview

Firewalls: insert API Documentation

Throws

Error 

if a name is not provided.

Error 

if a config object is not provided.

Example

var config = {
  protocols: {
    tcp: [3000],
    udp: [] // An empty array means all ports are allowed.
  },

  ranges: ['0.0.0.0/0']
};

function callback(err, firewall, operation, apiResponse) {
  // `firewall` is a Firewall object.

  // `operation` is an Operation object that can be used to check the status
  // of the request.
}

gce.createFirewall('new-firewall-name', config, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.createFirewall('new-firewall-name', config).then(function(data) {
  var firewall = data[0];
  var operation = data[1];
  var apiResponse = data[2];
});

createHealthCheck

createHealthCheck(name, options, callback)

Create an HTTP or HTTPS health check.

Parameter

name

string

Name of the HTTP or HTTPS health check to create.

options

Optional

object

See a HttpHealthCheck resource and HttpsHealthCheck resource.

callback

Optional

function()

The callback function.

See also

Health Checks Overview

HttpHealthCheck: insert API Documentation

HttpsHealthCheck: insert API Documentation

Example

function callback(err, healthCheck, operation, apiResponse) {
  // `healthCheck` is a HealthCheck object.

  // `operation` is an Operation object that can be used to check the status
  // of network creation.
}

gce.createHealthCheck('new-health-check-name', callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.createHealthCheck('new-health-check-name').then(function(data) {
  var healthCheck = data[0];
  var operation = data[1];
  var apiResponse = data[2];
});

createNetwork

createNetwork(name, config, callback)

Create a network.

Parameter

name

string

Name of the network.

config

object

See a Network resource.

callback

Optional

function()

The callback function.

See also

Networks Overview

Networks: insert API Documentation

Example

var config = {
  range: '10.240.0.0/16'
};

function callback(err, network, operation, apiResponse) {
  // `network` is a Network object.

  // `operation` is an Operation object that can be used to check the status
  // of network creation.
}

gce.createNetwork('new-network', config, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.createNetwork('new-network', config).then(function(data) {
  var network = data[0];
  var operation = data[1];
  var apiResponse = data[2];
});

createRule

createRule(name, config, callback)

Create a global forwarding rule.

Parameter

name

string

Name of the rule.

config

object

See a GlobalForwardingRule resource.

callback

function()

The callback function.

See also

GlobalForwardingRule Resource

GlobalForwardingRules: insert API Documentation

Example

var name = 'new-rule-name';

var config = {
  target: 'global/targetHttpProxies/my-proxy',
  range: '8080-8089'
};

gce.createRule(name, config, function (err, rule, operation, apiResponse) {
  // `rule` is a Rule object.

  // `operation` is an Operation object that can be used to check the status
  // of the request.
});

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.createRule(name, config).then(function(data) {
  var rule = data[0];
  var operation = data[1];
  var apiResponse = data[2];
});

createService

createService(name, config, callback)

Create a backend service.

Parameter

name

string

Name of the backend service.

config

object

See a BackendService resource.

callback

Optional

function()

The callback function.

See also

Backend Services Overview

BackendServices: insert API Documentation

Example

var config = {
  backends: [
    {
      group: 'URL of an Instance Group resource'
    }
  ],
  healthChecks: [
    'URL of an HTTP/HTTPS health check resource'
  ]
};

function callback(err, service, operation, apiResponse) {
  // `service` is a Service object.

  // `operation` is an Operation object that can be used to check the status
  // of network creation.
}

gce.createService('new-service', config, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.createService('new-service', config).then(function(data) {
  var service = data[0];
  var operation = data[1];
  var apiResponse = data[2];
});

execAfterOperation_

execAfterOperation_() returns (function(), error, or object)

Register a single callback that will wait for an operation to finish before being executed.

Returns

function() 

callback - The callback function.

nullable error 

callback.err - An error returned from the operation.

object 

callback.apiResponse - The operation's final API response.

firewall

firewall(name) returns Firewall

Get a reference to a Google Compute Engine firewall.

See Network#firewall to get a Firewall object for a specific network.

Parameter

name

string

Name of the firewall.

See also

Firewalls Overview

Returns

Firewall 

Example

var firewall = gce.firewall('firewall-name');

getAddresses

getAddresses(options, callback)

Get a list of addresses. For a detailed description of method's options see API reference.

Parameter

options

Optional

object

Address search options.

callback

function()

The callback function.

See also

Instances and Networks

Addresses: aggregatedList API Documentation

Example

gce.getAddresses(function(err, addresses) {
  // addresses is an array of `Address` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, addresses, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getAddresses(nextQuery, callback);
  }
}

gce.getAddresses({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getAddresses().then(function(data) {
  var addresses = data[0];
});

getAutoscalers

getAutoscalers(options, callback)

Get a list of autoscalers. For a detailed description of this method's options, see the API reference.

Parameter

options

Optional

object

Address search options.

callback

function()

The callback function.

See also

Managing Autoscalers

Understanding Autoscaler Decisions

Autoscalers: aggregatedList API Documentation

Example

gce.getAutoscalers(function(err, autoscalers) {
  // autoscalers is an array of `Autoscaler` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, autoscalers, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getAutoscalers(nextQuery, callback);
  }
}

gce.getAutoscalers({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getAutoscalers().then(function(data) {
  var autoscalers = data[0];
});

getDisks

getDisks(options, callback)

Get a list of disks.

Parameter

options

Optional

object

Disk search options.

callback

function()

The callback function.

See also

Disks Overview

Disks: aggregatedList API Documentation

Example

gce.getDisks(function(err, disks) {
  // `disks` is an array of `Disk` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, disks, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getDisks(nextQuery, callback);
  }
}

gce.getDisks({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getDisks().then(function(data) {
  var disks = data[0];
});

getDisksStream

getDisksStream(options) returns stream

Get a list of Disk objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getDisks for a complete list of options.

Returns

stream 

Example

gce.getDisksStream()
  .on('error', console.error)
  .on('data', function(disk) {
    // `disk` is a `Disk` object.
  })
  .on('end', function() {
    // All disks retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getDisksStream()
  .on('data', function(disk) {
    this.end();
  });

getFirewalls

getFirewalls(options, callback)

Get a list of firewalls.

Parameter

options

Optional

object

Firewall search options.

callback

function()

The callback function.

See also

Firewalls Overview

Firewalls: list API Documentation

Example

gce.getFirewalls(function(err, firewalls) {
  // `firewalls` is an array of `Firewall` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, firewalls, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getFirewalls(nextQuery, callback);
  }
}

gce.getFirewalls({
  autoPaginate: false
}, callback);

gce.getFirewalls().then(function(data) {
  var firewalls = data[0];
});

getFirewallsStream

getFirewallsStream(query) returns stream

Get a list of Firewall objects as a readable object stream.

Parameter

query

Optional

object

Configuration object. See Compute#getFirewalls for a complete list of options.

Returns

stream 

Example

gce.getFirewallsStream()
  .on('error', console.error)
  .on('data', function(firewall) {
    // `firewall` is a `Firewall` object.
  })
  .on('end', function() {
    // All firewalls retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getFirewallsStream()
  .on('data', function(firewall) {
    this.end();
  });

getHealthChecks

getHealthChecks(options, callback)

Get a list of health checks.

Parameter

options

Optional

object

Health check search options.

callback

function()

The callback function.

See also

Health Checks Overview

HttpHealthCheck: list API Documentation

HttpsHealthCheck: list API Documentation

Example

gce.getHealthChecks(function(err, healthChecks) {
  // `healthChecks` is an array of `HealthCheck` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, healthChecks, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getHealthChecks(nextQuery, callback);
  }
}

gce.getHealthChecks({
  autoPaginate: false
}, callback);

gce.getHealthChecks().then(function(data) {
  var healthChecks = data[0];
});

getHealthChecksStream

getHealthChecksStream(options) returns stream

Get a list of HealthCheck objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getHealthChecks for a complete list of options.

Returns

stream 

Example

gce.getHealthChecksStream()
  .on('error', console.error)
  .on('data', function(healthCheck) {
    // `healthCheck` is a `HealthCheck` object.
  })
  .on('end', function() {
    // All health checks retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getHealthChecksStream()
  .on('data', function(healthCheck) {
    this.end();
  });

getInstanceGroups

getInstanceGroups(options, callback)

Get a list of instance groups.

Parameter

options

Optional

object

Instance group search options.

callback

function()

The callback function.

See also

InstanceGroups Overview

InstanceGroups: aggregatedList API Documentation

Example

gce.getInstanceGroups(function(err, instanceGroups) {
  // `instanceGroups` is an array of `InstanceGroup` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, instanceGroups, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getInstanceGroups(nextQuery, callback);
  }
}

gce.getInstanceGroups({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getInstanceGroups().then(function(data) {
  var instanceGroups = data[0];
});

getInstanceGroupsStream

getInstanceGroupsStream(options) returns stream

Get a list of InstanceGroup objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getInstanceGroups for a complete list of options.

Returns

stream 

Example

gce.getInstanceGroupsStream()
  .on('error', console.error)
  .on('data', function(instanceGroup) {
    // `instanceGroup` is an `InstanceGroup` object.
  })
  .on('end', function() {
    // All instance groups retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getInstanceGroupsStream()
  .on('data', function(instanceGroup) {
    this.end();
  });

getMachineTypes

getMachineTypes(options, callback)

Get a list of machine types in this project.

Parameter

options

Optional

object

Machine type search options.

callback

function()

The callback function.

See also

MachineTypes: list API Documentation

Machine Types Overview

MachineType Resource

Example

gce.getMachineTypes(function(err, machineTypes) {
  // `machineTypes` is an array of `MachineType` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, machineTypes, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getMachineTypes(nextQuery, callback);
  }
}

gce.getMachineTypes({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getMachineTypes().then(function(data) {
  var machineTypes = data[0];
});

getMachineTypesStream

getMachineTypesStream(options) returns stream

Get a list of MachineType objects in this project as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getMachineTypes for a complete list of options.

Returns

stream 

Example

gce.getMachineTypesStream()
  .on('error', console.error)
  .on('data', function(machineType) {
    // `machineType` is a `MachineType` object.
  })
  .on('end', function() {
    // All machine types retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getMachineTypesStream()
  .on('data', function(machineType) {
    this.end();
  });

getNetworks

getNetworks(options, callback)

Get a list of networks.

Parameter

options

Optional

object

Network search options.

callback

function()

The callback function.

See also

Networks Overview

Networks: list API Documentation

Example

gce.getNetworks(function(err, networks) {
  // `networks` is an array of `Network` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, networks, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getNetworks(nextQuery, callback);
  }
}

gce.getNetworks({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getNetworks().then(function(data) {
  var networks = data[0];
});

getNetworksStream

getNetworksStream(options) returns stream

Get a list of Network objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getNetworks for a complete list of options.

Returns

stream 

Example

gce.getNetworksStream()
  .on('error', console.error)
  .on('data', function(network) {
    // `network` is a `Network` object.
  })
  .on('end', function() {
    // All networks retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getNetworksStream()
  .on('data', function(network) {
    this.end();
  });

getOperations

getOperations(options, callback)

Get a list of global operations.

Parameter

options

Optional

object

Operation search options.

callback

function()

The callback function.

See also

Global Operation Overview

GlobalOperations: list API Documentation

Example

gce.getOperations(function(err, operations) {
  // `operations` is an array of `Operation` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, operations, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getOperations(nextQuery, callback);
  }
}

gce.getOperations({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getOperations().then(function(data) {
  var operations = data[0];
});

getOperationsStream

getOperationsStream(options) returns stream

Get a list of global Operation objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getOperations for a complete list of options.

Returns

stream 

Example

gce.getOperationsStream()
  .on('error', console.error)
  .on('data', function(operation) {
    // `operation` is a `Operation` object.
  })
  .on('end', function() {
    // All operations retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getOperationsStream()
  .on('data', function(operation) {
    this.end();
  });

getRegions

getRegions(options, callback)

Return the regions available to your project.

Parameter

options

Optional

object

Instance search options.

callback

function()

The callback function.

See also

Regions & Zones Overview

Regions: list API Documentation

Example

gce.getRegions(function(err, regions) {
  // `regions` is an array of `Region` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, regions, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getRegions(nextQuery, callback);
  }
}

gce.getRegions({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getRegions().then(function(data) {
  var regions = data[0];
});

getRegionsStream

getRegionsStream(options) returns stream

Return the Region objects available to your project as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getRegions for a complete list of options.

Returns

stream 

Example

gce.getRegionsStream()
  .on('error', console.error)
  .on('data', function(region) {
    // `region` is a `Region` object.
  })
  .on('end', function() {
    // All regions retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getRegionsStream()
  .on('data', function(region) {
    this.end();
  });

getRules

getRules(options, callback)

Get a list of forwarding rules.

Parameter

options

Optional

object

Rules search options.

callback

function()

The callback function.

See also

GlobalForwardingRules: list API Documentation

Example

gce.getRules(function(err, rules) {
  // `rules` is an array of `Rule` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, rules, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getRules(nextQuery, callback);
  }
}

gce.getRules({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getRules().then(function(data) {
  var rules = data[0];
});

getRulesStream

getRulesStream(options) returns stream

Get a list of Rule objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getRules for a complete list of options.

Returns

stream 

Example

gce.getRulesStream()
  .on('error', console.error)
  .on('data', function(rule) {
    // `rule` is a `Rule` object.
  })
  .on('end', function() {
    // All rules retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getRulesStream()
  .on('data', function(rule) {
    this.end();
  });

getServices

getServices(options, callback)

Get a list of backend services.

Parameter

options

Optional

object

BackendService search options.

callback

function()

The callback function.

See also

Backend Services Overview

BackendServices: list API Documentation

Example

gce.getServices(function(err, services) {
  // `services` is an array of `Service` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, services, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getServices(nextQuery, callback);
  }
}

gce.getServices({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getServices().then(function(data) {
  var services = data[0];
});

getServicesStream

getServicesStream(options) returns stream

Get a list of Service objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getServices for a complete list of options.

Returns

stream 

Example

gce.getServicesStream()
  .on('error', console.error)
  .on('data', function(service) {
    // `service` is a `Service` object.
  })
  .on('end', function() {
    // All services retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getServicesStream()
  .on('data', function(service) {
    this.end();
  });

getSnapshots

getSnapshots(options, callback)

Get a list of snapshots.

Parameter

options

Optional

object

Snapshot search options.

callback

function()

The callback function.

See also

Snapshots Overview

Snapshots: list API Documentation

Example

gce.getSnapshots(function(err, snapshots) {
  // `snapshots` is an array of `Snapshot` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, snapshots, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getSnapshots(nextQuery, callback);
  }
}

gce.getSnapshots({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getSnapshots().then(function(data) {
  var snapshots = data[0];
});

getSnapshotsStream

getSnapshotsStream(options) returns stream

Get a list of Snapshot objects as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getSnapshots for a complete list of options.

Returns

stream 

Example

gce.getSnapshotsStream()
  .on('error', console.error)
  .on('data', function(snapshot) {
    // `snapshot` is a `Snapshot` object.
  })
  .on('end', function() {
    // All snapshots retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getSnapshotsStream()
  .on('data', function(snapshot) {
    this.end();
  });

getSubnetworks

getSubnetworks(options, callback)

Get a list of subnetworks in this project.

Parameter

options

Optional

object

Subnetwork search options.

callback

function()

The callback function.

See also

Subnetworks Overview

Subnetworks: list API Documentation

Example

gce.getSubnetworks(function(err, subnetworks) {
  // `subnetworks` is an array of `Subnetworks` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, subnetworks, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getSubnetworks(nextQuery, callback);
  }
}

gce.getSubnetworks({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getSubnetworks().then(function(data) {
  var subnetworks = data[0];
});

getSubnetworksStream

getSubnetworksStream(options) returns stream

Get a list of Subnetwork objects in this project as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getSubnetworks for a complete list of options.

Returns

stream 

Example

gce.getSubnetworksStream()
  .on('error', console.error)
  .on('data', function(subnetwork) {
    // `subnetwork` is a `Subnetwork` object.
  })
  .on('end', function() {
    // All subnetworks retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getSubnetworksStream()
  .on('data', function(subnetwork) {
    this.end();
  });

getVMs

getVMs(options, callback)

Get a list of virtual machine instances.

Parameter

options

Optional

object

Instance search options.

callback

function()

The callback function.

See also

Instances and Networks

Instances: aggregatedList API Documentation

Example

gce.getVMs(function(err, vms) {
  // `vms` is an array of `VM` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, vms, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getVMs(nextQuery, callback);
  }
}

gce.getVMs({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getVMs().then(function(data) {
  var vms = data[0];
});

getVMsStream

getVMsStream(options) returns stream

Get a list of VM instances as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getVMs for a complete list of options.

Returns

stream 

Example

gce.getVMsStream()
  .on('error', console.error)
  .on('data', function(vm) {
    // `vm` is a `VM` object.
  })
  .on('end', function() {
    // All vms retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getVMsStream()
  .on('data', function(vm) {
    this.end();
  });

getZones

getZones(options, callback)

Return the zones available to your project.

Parameter

options

Optional

object

Instance search options.

callback

function()

The callback function.

See also

Regions & Zones Overview

Zones: list API Documentation

Example

gce.getZones(function(err, zones) {
  // `zones` is an array of `Zone` objects.
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
function callback(err, zones, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    gce.getZones(nextQuery, callback);
  }
}

gce.getZones({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
gce.getZones().then(function(data) {
  var zones = data[0];
});

getZonesStream

getZonesStream(options) returns stream

Return the Zone objects available to your project as a readable object stream.

Parameter

options

Optional

object

Configuration object. See Compute#getZones for a complete list of options.

Returns

stream 

Example

gce.getZonesStream()
  .on('error', console.error)
  .on('data', function(zone) {
    // `zone` is a `Zone` object.
  })
  .on('end', function() {
    // All zones retrieved.
  });

//-
// If you anticipate many results, you can end a stream early to prevent
// unnecessary processing and API requests.
//-
gce.getZonesStream()
  .on('data', function(zone) {
    this.end();
  });

healthCheck

healthCheck(name, options) returns HealthCheck

Get a reference to a Google Compute Engine health check.

Parameter

name

string

Name of the health check.

options

Optional

object

Configuration object.

See also

Health Checks Overview

Returns

HealthCheck 

Example

var healthCheck = gce.healthCheck('http-health-check-name');

//-
// Access an HTTPS health check.
//-
var httpsHealthCheck = gce.healthCheck('https-health-check-name', {
  https: true
});

network

network(name) returns Network

Get a reference to a Google Compute Engine network.

Parameter

name

string

Name of the network.

See also

Networks Overview

Returns

Network 

Example

var network = gce.network('network-name');

operation

operation(name) returns Operation

Get a reference to a global Google Compute Engine operation.

Parameter

name

string

Name of the existing operation.

See also

Global Operation Overview

Returns

Operation 

Example

var operation = gce.operation('operation-name');

project

project() returns Project

Get a reference to your Google Compute Engine project.

See also

Projects Overview

Returns

Project 

Example

var project = gce.project();

region

region(name) returns Region

Get a reference to a Google Compute Engine region.

Parameter

name

string

Name of the region.

See also

Regions & Zones Overview

Returns

Region 

Example

var region = gce.region('region-name');

rule

rule(name) returns Rule

Get a reference to a Google Compute Engine forwading rule.

Parameter

name

string

Name of the rule.

Returns

Rule 

Example

var rule = gce.rule('rule-name');

service

service(name) returns Service

Get a reference to a Google Compute Engine backend service.

Parameter

name

string

Name of the existing service.

See also

Backend Services Overview

Returns

Service 

Example

var service = gce.service('service-name');

snapshot

snapshot(name) returns Snapshot

Get a reference to a Google Compute Engine snapshot.

Parameter

name

string

Name of the existing snapshot.

See also

Snapshots Overview

Returns

Snapshot 

Example

var snapshot = gce.snapshot('snapshot-name');

zone

zone(name) returns Zone

Get a reference to a Google Compute Engine zone.

Parameter

name

string

Name of the zone.

See also

Regions & Zones Overview

Returns

Zone 

Example

var zone = gce.zone('zone-name');