Region

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

Members

getAddressesStream

Source:

• region.js, line 822

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.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.
//-
region.getAddressesStream()
  .on('data', function(address) {
    this.end();
  });

getOperationsStream

Source:

• region.js, line 855

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.getOperationsStream()
  .on('error', console.error)
  .on('data', function(operation) {
    // `operation` is an `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.
//-
region.getOperationsStream()
  .on('data', function(operation) {
    this.end();
  });

getRulesStream

Source:

• region.js, line 888

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.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.
//-
region.getRulesStream()
  .on('data', function(rule) {
    this.end();
  });

getSubnetworksStream

Source:

• region.js, line 921

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.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.
//-
region.getSubnetworksStream()
  .on('data', function(subnetwork) {
    this.end();
  });

id :string

Source:

• region.js, line 128

name :string

Source:

• region.js, line 136

Methods

Parameters:

Source:

• region.js, line 166

See:

• Instances and Networks

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

const address = region.address('address-name');

Parameters:

Source:

• region.js, line 210

See:

• Instances and Networks

• Address Resource

• Addresses: insert API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

function callback(err, address, operation, apiResponse) {
  // `address` is an Address object.

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

region.createAddress('new-address', callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
region.createAddress('new-address').then(function(data) {
  const address = data[0];
  const operation = data[1];
  const apiResponse = data[2];
});

Parameters:

Source:

• region.js, line 379

See:

• ForwardingRule Resource

• ForwardingRules: insert API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

const name = 'new-rule-name';

const cfg = {
  target: 'zones/us-central1-a/targetInstances/my-target-instance',
  range: '8080-8089'
};

region.createRule(name, cfg, 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.
//-
region.createRule(name, cfg).then(function(data) {
  const rule = data[0];
  const operation = data[1];
  const apiResponse = data[2];
});

Parameters:

Source:

• region.js, line 288

See:

• Subnetwork Resource

• Subnetwork: insert API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

const config = {
  network: 'network1',
  range: '10.0.1.0/24'
};

function callback(err, subnetwork, operation, apiResponse) {
  // `subnetwork` is a Subnetwork object.

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

region.createSubnetwork('new-subnetwork-name', config, callback);

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

Parameters:

Source:

• region.js, line 48

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.exists(function(err, exists) {});

//-
// If the callback is omitted, we'll return a Promise.
//-
region.exists().then(function(data) {
  const exists = data[0];
});

Source:

• region.js, line 72

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.get(function(err, region, apiResponse) {
  // `region` is a Region object.
});

//-
// If the callback is omitted, we'll return a Promise.
//-
region.get().then(function(data) {
  const region = data[0];
  const apiResponse = data[1];
});

Parameters:

Source:

• region.js, line 439

See:

• Instances and Networks

• Addresses: list API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.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.
    region.getAddresses(nextQuery, callback);
  }
}

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

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

Parameters:

Source:

• region.js, line 95

See:

• Region Resource

• Regions: get API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.getMetadata(function(err, metadata, apiResponse) {});

//-
// If the callback is omitted, we'll return a Promise.
//-
region.getMetadata().then(function(data) {
  const metadata = data[0];
  const apiResponse = data[1];
});

Parameters:

Source:

• region.js, line 528

See:

• Region Operation Overview

• RegionOperations: list API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.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.
    region.getOperations(nextQuery, callback);
  }
}

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

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

Parameters:

Source:

• region.js, line 616

See:

• ForwardingRules: list API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.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.
    region.getRules(nextQuery, callback);
  }
}

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

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

Parameters:

Source:

• region.js, line 705

See:

• Subnetworks Overview

• Subnetworks: list API Documentation

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

region.getSubnetworks(function(err, subnetworks) {
  // `subnetworks` is an array of `Subnetwork` 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.
    region.getSubnetworks(nextQuery, callback);
  }
}

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

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

Parameters:

Source:

• region.js, line 752

See:

• Region Operation Overview

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

const operation = region.operation('operation-name');

Parameters:

Source:

• region.js, line 768

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

const rule = region.rule('rule-name');

Parameters:

Source:

• region.js, line 786

See:

• Subnetworks Overview

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('us-central1');

const subnetwork = region.subnetwork('subnetwork-name');