Routers - Documentation

Routers

google .cloud .compute .v1. Routers

Represents a Routers

Constructor

new Routers(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new Routers 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

aggregatedList(request, callback) → {undefined}

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListRoutersRequest	AggregatedListRoutersRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.AggregatedListCallback	Node-style callback called with the error, if any, and RouterAggregatedList

Returns:

Type	Description
undefined

aggregatedList(request) → {Promise.<google.cloud.compute.v1.RouterAggregatedList>}

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListRoutersRequest	AggregatedListRoutersRequest message or plain object

Returns:

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

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteRouterRequest	DeleteRouterRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.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.IDeleteRouterRequest	DeleteRouterRequest 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.IGetRouterRequest	GetRouterRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.GetCallback	Node-style callback called with the error, if any, and Router

Returns:

Type	Description
undefined

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

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetRouterRequest	GetRouterRequest message or plain object

Returns:

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

getNatMappingInfo(request, callback) → {undefined}

Calls GetNatMappingInfo.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest	GetNatMappingInfoRoutersRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.GetNatMappingInfoCallback	Node-style callback called with the error, if any, and VmEndpointNatMappingsList

Returns:

Type	Description
undefined

getNatMappingInfo(request) → {Promise.<google.cloud.compute.v1.VmEndpointNatMappingsList>}

Calls GetNatMappingInfo.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetNatMappingInfoRoutersRequest	GetNatMappingInfoRoutersRequest message or plain object

Returns:

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

getRouterStatus(request, callback) → {undefined}

Calls GetRouterStatus.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetRouterStatusRouterRequest	GetRouterStatusRouterRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.GetRouterStatusCallback	Node-style callback called with the error, if any, and RouterStatusResponse

Returns:

Type	Description
undefined

getRouterStatus(request) → {Promise.<google.cloud.compute.v1.RouterStatusResponse>}

Calls GetRouterStatus.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetRouterStatusRouterRequest	GetRouterStatusRouterRequest message or plain object

Returns:

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

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertRouterRequest	InsertRouterRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.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.IInsertRouterRequest	InsertRouterRequest 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.IListRoutersRequest	ListRoutersRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.ListCallback	Node-style callback called with the error, if any, and RouterList

Returns:

Type	Description
undefined

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

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListRoutersRequest	ListRoutersRequest message or plain object

Returns:

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

patch(request, callback) → {undefined}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchRouterRequest	PatchRouterRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.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.IPatchRouterRequest	PatchRouterRequest message or plain object

Returns:

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

preview(request, callback) → {undefined}

Calls Preview.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPreviewRouterRequest	PreviewRouterRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.PreviewCallback	Node-style callback called with the error, if any, and RoutersPreviewResponse

Returns:

Type	Description
undefined

preview(request) → {Promise.<google.cloud.compute.v1.RoutersPreviewResponse>}

Calls Preview.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPreviewRouterRequest	PreviewRouterRequest message or plain object

Returns:

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

update(request, callback) → {undefined}

Calls Update.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IUpdateRouterRequest	UpdateRouterRequest message or plain object
`callback`	google.cloud.compute.v1.Routers.UpdateCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls Update.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IUpdateRouterRequest	UpdateRouterRequest message or plain object

Returns:

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

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

Creates new Routers 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
Routers	RPC service. Useful where requests and/or responses are streamed.

Type Definitions

AggregatedListCallback(error, responseopt)

Callback as used by aggregatedList.

Parameters:

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

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.Router	<optional>	Router

GetNatMappingInfoCallback(error, responseopt)

Callback as used by getNatMappingInfo.

Parameters:

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

GetRouterStatusCallback(error, responseopt)

Callback as used by getRouterStatus.

Parameters:

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

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.RouterList	<optional>	RouterList

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

PreviewCallback(error, responseopt)

Callback as used by preview.

Parameters:

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

UpdateCallback(error, responseopt)

Callback as used by update.

Parameters:

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