@google-cloud/compute 1.1.0 » Class: Firewall

Properties

compute
id

metadata
name

Methods

create(config)
delete([callback])

exists(callback)
get([options])

getMetadata([callback])
setMetadata(metadata[, callback])

new Firewall(compute, name)

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

Parameters

Name	Type	Optional	Description
compute
name

See also: Firewalls Overview; Firewall Resource

Properties

compute Compute

The parent Compute instance of this Firewall instance.

id string

metadata object

name string

Methods

create(config)

Create a firewall.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

const config = {
  // ...
};

firewall.create(config, function(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.
});

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

Parameter

Name	Type	Optional	Description
config	object		See Compute#createFirewall.

delete([callback])

Delete the firewall.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

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

Parameters

Name Type Optional Description

callback

function()

Yes

The callback function.

Values in callback have the following properties:

Name

Type

Optional

Description

err

error

An error returned while making this request.

Value can be null.

operation

Operation

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

apiResponse

object

The full API response.

See also: Firewalls: delete API Documentation

exists(callback)

Check if the firewall exists.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

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

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

Parameters

Name Type Optional Description

callback

function()

The callback function.

Values in callback have the following properties:

Name

Type

Optional

Description

err

error

An error returned while making this request.

Value can be null.

exists

boolean

Whether the firewall exists or not.

get([options])

Get a firewall 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.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

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

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

Parameters

Name Type Optional Description

options

Yes

Configuration object.

Values in options have the following properties:

Name	Type	Optional	Description
autoCreate	boolean		Automatically create the object if it does not exist. Default: `false`

getMetadata([callback])

Get the firewall's metadata.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

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

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

Parameters

Name Type Optional Description

callback

function()

Yes

The callback function.

Values in callback have the following properties:

Name

Type

Optional

Description

err

error

An error returned while making this request.

Value can be null.

metadata

object

The firewall's metadata.

apiResponse

object

The full API response.

See also: Firewalls: get API Documentation; Firewall Resource

setMetadata(metadata[, callback])

Set the firewall's metadata.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

const metadata = {
  description: 'New description'
};

firewall.setMetadata(metadata, 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.
//-
firewall.setMetadata(metadata).then(function(data) {
  const operation = data[0];
  const apiResponse = data[1];
});

Parameters

Name Type Optional Description

metadata

object

See a Firewall resource.

callback

function()

Yes

The callback function.

Values in callback have the following properties:

Name

Type

Optional

Description

err

error

An error returned while making this request.

Value can be null.

operation

Operation

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

apiResponse

object

The full API response.

See also: Firewall Resource