Subnetwork - Documentation

Constructor

new Subnetwork(region, name)

Parameters:

Name	Type	Description
`region`	Region	Region this subnetwork belongs to.
`name`	string	Name of the subnetwork.

See:

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const subnetwork = region.subnetwork('subnetwork1');

Members

name

region

The parent Region instance of this Subnetwork instance.

Methods

create(config)

Create a subnetwork.

Parameters:

Name	Type	Description
`config`	object	See Region#createSubnetwork.

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const subnetwork = region.subnetwork('subnetwork1');

const config = {
  // ...
};

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.
}

subnetwork.create(config, callback);

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

delete(callbackopt)

Delete the subnetwork.

Parameters:

Name Type Attributes Description

callback

function

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:

Subnetworks: delete API Documentation

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const subnetwork = region.subnetwork('subnetwork1');

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

exists(callback)

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

Example

const Compute = require('@google-cloud/compute');
const compute = new Compute();
const region = compute.region('region-name');
const subnetwork = region.subnetwork('subnetwork1');

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

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

get(optionsopt)

Get a subnetwork 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

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 subnetwork = region.subnetwork('subnetwork1');

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

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

getMetadata(callbackopt)

Get the metadata of this subnetwork.

Parameters:

Name Type Attributes Description

callback

function

The callback function.

Properties

Name	Type	Attributes	Description
`err`	error	<nullable>	An error returned while making this request.
`metadata`	object		The subnetwork'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 subnetwork = region.subnetwork('subnetwork1');

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

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