Networks - Documentation

Networks

google .cloud .compute .v1. Networks

Represents a Networks

Constructor

new Networks(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Networks service.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Extends

$protobuf.rpc.Service

Methods

addPeering(request, callback) → {undefined}

Calls AddPeering.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddPeeringNetworkRequest	AddPeeringNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.AddPeeringCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

addPeering(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls AddPeering.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddPeeringNetworkRequest	AddPeeringNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteNetworkRequest	DeleteNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.DeleteCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

delete(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteNetworkRequest	DeleteNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

get(request, callback) → {undefined}

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetNetworkRequest	GetNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.GetCallback	Node-style callback called with the error, if any, and Network

Returns:

Type	Description
undefined

get(request) → {Promise.<google.cloud.compute.v1.Network>}

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetNetworkRequest	GetNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Network>	Promise

getEffectiveFirewalls(request, callback) → {undefined}

Calls GetEffectiveFirewalls.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest	GetEffectiveFirewallsNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.GetEffectiveFirewallsCallback	Node-style callback called with the error, if any, and NetworksGetEffectiveFirewallsResponse

Returns:

Type	Description
undefined

getEffectiveFirewalls(request) → {Promise.<google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponse>}

Calls GetEffectiveFirewalls.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetEffectiveFirewallsNetworkRequest	GetEffectiveFirewallsNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponse>	Promise

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertNetworkRequest	InsertNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.InsertCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

insert(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertNetworkRequest	InsertNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

list(request, callback) → {undefined}

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListNetworksRequest	ListNetworksRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.ListCallback	Node-style callback called with the error, if any, and NetworkList

Returns:

Type	Description
undefined

list(request) → {Promise.<google.cloud.compute.v1.NetworkList>}

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListNetworksRequest	ListNetworksRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.NetworkList>	Promise

listPeeringRoutes(request, callback) → {undefined}

Calls ListPeeringRoutes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListPeeringRoutesNetworksRequest	ListPeeringRoutesNetworksRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.ListPeeringRoutesCallback	Node-style callback called with the error, if any, and ExchangedPeeringRoutesList

Returns:

Type	Description
undefined

listPeeringRoutes(request) → {Promise.<google.cloud.compute.v1.ExchangedPeeringRoutesList>}

Calls ListPeeringRoutes.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListPeeringRoutesNetworksRequest	ListPeeringRoutesNetworksRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.ExchangedPeeringRoutesList>	Promise

patch(request, callback) → {undefined}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchNetworkRequest	PatchNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.PatchCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

patch(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchNetworkRequest	PatchNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

removePeering(request, callback) → {undefined}

Calls RemovePeering.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemovePeeringNetworkRequest	RemovePeeringNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.RemovePeeringCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

removePeering(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls RemovePeering.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemovePeeringNetworkRequest	RemovePeeringNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

switchToCustomMode(request, callback) → {undefined}

Calls SwitchToCustomMode.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest	SwitchToCustomModeNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.SwitchToCustomModeCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

switchToCustomMode(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls SwitchToCustomMode.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISwitchToCustomModeNetworkRequest	SwitchToCustomModeNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

updatePeering(request, callback) → {undefined}

Calls UpdatePeering.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IUpdatePeeringNetworkRequest	UpdatePeeringNetworkRequest message or plain object
`callback`	google.cloud.compute.v1.Networks.UpdatePeeringCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

updatePeering(request) → {Promise.<google.cloud.compute.v1.Operation>}

Calls UpdatePeering.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IUpdatePeeringNetworkRequest	UpdatePeeringNetworkRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.compute.v1.Operation>	Promise

(static) create(rpcImpl, requestDelimitedopt, responseDelimitedopt) → {Networks}

Creates new Networks service using the specified rpc implementation.

Parameters:

Name	Type	Attributes	Default	Description
`rpcImpl`	$protobuf.RPCImpl			RPC implementation
`requestDelimited`	boolean	<optional>	false	Whether requests are length-delimited
`responseDelimited`	boolean	<optional>	false	Whether responses are length-delimited

Returns:

Type	Description
Networks	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AddPeeringCallback(error, responseopt)

Callback as used by addPeering.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

DeleteCallback(error, responseopt)

Callback as used by delete_.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

GetCallback(error, responseopt)

Callback as used by get.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Network	<optional>	Network

GetEffectiveFirewallsCallback(error, responseopt)

Callback as used by getEffectiveFirewalls.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.NetworksGetEffectiveFirewallsResponse	<optional>	NetworksGetEffectiveFirewallsResponse

InsertCallback(error, responseopt)

Callback as used by insert.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

ListCallback(error, responseopt)

Callback as used by list.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.NetworkList	<optional>	NetworkList

ListPeeringRoutesCallback(error, responseopt)

Callback as used by listPeeringRoutes.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.ExchangedPeeringRoutesList	<optional>	ExchangedPeeringRoutesList

PatchCallback(error, responseopt)

Callback as used by patch.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

RemovePeeringCallback(error, responseopt)

Callback as used by removePeering.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

SwitchToCustomModeCallback(error, responseopt)

Callback as used by switchToCustomMode.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation

UpdatePeeringCallback(error, responseopt)

Callback as used by updatePeering.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.compute.v1.Operation	<optional>	Operation