Constructor
new Firewall(compute, name)
Parameters:
Name | Type | Description |
---|---|---|
compute |
Compute | |
name |
string |
Members
compute
id
metadata
name
Methods
create(config)
Create a firewall.
Parameters:
Name | Type | Description |
---|---|---|
config |
object |
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
|
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
|
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
|
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
|
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
|
- 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];
});