Address

Address

An Address object allows you to interact with a Google Compute Engine address.

Constructor

new Address(region, name)

Parameters:
Name Type Description
region Region
name string
See:
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const address = region.address('address1');

Members

name

region

The parent Region instance of this Address instance.

Methods

create(optionsopt)

Create an address.

Parameters:
Name Type Attributes Description
options object <optional>

See {Region#createAddress}.
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const address = region.address('address1');

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

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

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

delete(callbackopt)

Delete the address.

Parameters:
Name Type Attributes Description
callback function <optional>

The callback function.

Properties
Name Type Attributes Description
err error <nullable>

An error returned while making this request.
operation Operation

An operation object that can be used to check the status of the request.
apiResponse object

The full API response.
See:
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const address = region.address('address1');

address.delete(function(err, operation, apiResponse) {
  // `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.
//-
address.delete().then(function(data) {
  const operation = data[0];
  const apiResponse = data[1];
});

exists(callback)

Check if the address exists.

Parameters:
Name Type Description
callback function

The callback function.

Properties
Name Type Attributes Description
err error <nullable>

An error returned while making this request.
exists boolean

Whether the address exists or not.
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const address = region.address('address1');

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

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

get(optionsopt)

Get an address if it exists.

You may optionally use this to "get or create" an object by providing an object with autoCreate set to true. Any extra configuration that is normally required for the create method must be contained within this object as well.

Parameters:
Name Type Attributes Description
options options <optional>

Configuration object.

Properties
Name Type Description
autoCreate boolean

Automatically create the object if it does not exist. Default: false
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const address = region.address('address1');

address.get(function(err, address, apiResponse) {
  // `address` is an Address object.
});

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

getMetadata(callbackopt)

Get the metadata of this address.

Parameters:
Name Type Attributes Description
callback function <optional>

The callback function.

Properties
Name Type Attributes Description
err error <nullable>

An error returned while making this request.
metadata object

The address's metadata.
apiResponse object

The full API response.
See:
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const address = region.address('address1');

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

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