@google-cloud/compute 1.1.0 » Class: Subnetwork

Properties

name

region

Methods

create(config)
delete([callback])

exists(callback)
get([options])

getMetadata([callback])

new Subnetwork(region, name)

Example

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

Parameters

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

See also: Subnetworks Overview; Subnetwork Resource

Properties

name string

region Region

The parent Region instance of this Subnetwork instance.

Methods

create(config)

Create a subnetwork.

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

Parameter

Name	Type	Optional	Description
config	object		See Region#createSubnetwork.

delete([callback])

Delete the subnetwork.

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

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: Subnetworks: delete API Documentation

exists(callback)

Check if the subnetwork exists.

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

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

get([options])

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.

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

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 metadata of this subnetwork.

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

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

apiResponse

object

The full API response.

See also: Subnetwork Resource; Subnetwork: get API Documentation