Firewall

Firewall

A Firewall object allows you to interact with a Google Compute Engine firewall.

Constructor

new Firewall(compute, name)

Parameters:
Name Type Description
compute Compute
name string
See:
Example
const Compute = require('@google-cloud/compute');
const compute = new Compute();
const firewall = compute.firewall('tcp-3000');

Members

compute :Compute

The parent Compute instance of this Firewall instance.

id :string

metadata :object

name :string

Methods

create(config)

Create a firewall.

Parameters:
Name Type Description
config object

See Compute#createFirewall.

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];
});

delete(callbackopt)

Delete the firewall.

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 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];
});

exists(callback)

Check if the firewall 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 firewall exists or not.

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];
});

get(optionsopt)

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.

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 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];
});

getMetadata(callbackopt)

Get the firewall's metadata.

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 firewall's metadata.

apiResponse object

The full API response.

See:
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];
});

setMetadata(metadata, callbackopt)

Set the firewall's metadata.

Parameters:
Name Type Attributes Description
metadata object

See a Firewall resource.

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 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];
});