VpnGateways

google .cloud .compute .v1. VpnGateways

Represents a VpnGateways

Constructor

new VpnGateways(rpcImpl, requestDelimitedopt, responseDelimitedopt)

Constructs a new VpnGateways 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.IAggregatedListVpnGatewaysRequest	AggregatedListVpnGatewaysRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.AggregatedListCallback	Node-style callback called with the error, if any, and VpnGatewayAggregatedList

Returns:

Type	Description
undefined

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

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListVpnGatewaysRequest	AggregatedListVpnGatewaysRequest message or plain object

Returns:

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

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteVpnGatewayRequest	DeleteVpnGatewayRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.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.IDeleteVpnGatewayRequest	DeleteVpnGatewayRequest 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.IGetVpnGatewayRequest	GetVpnGatewayRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.GetCallback	Node-style callback called with the error, if any, and VpnGateway

Returns:

Type	Description
undefined

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

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetVpnGatewayRequest	GetVpnGatewayRequest message or plain object

Returns:

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

getStatus(request, callback) → {undefined}

Calls GetStatus.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetStatusVpnGatewayRequest	GetStatusVpnGatewayRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.GetStatusCallback	Node-style callback called with the error, if any, and VpnGatewaysGetStatusResponse

Returns:

Type	Description
undefined

getStatus(request) → {Promise.<google.cloud.compute.v1.VpnGatewaysGetStatusResponse>}

Calls GetStatus.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetStatusVpnGatewayRequest	GetStatusVpnGatewayRequest message or plain object

Returns:

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

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertVpnGatewayRequest	InsertVpnGatewayRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.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.IInsertVpnGatewayRequest	InsertVpnGatewayRequest 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.IListVpnGatewaysRequest	ListVpnGatewaysRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.ListCallback	Node-style callback called with the error, if any, and VpnGatewayList

Returns:

Type	Description
undefined

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

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListVpnGatewaysRequest	ListVpnGatewaysRequest message or plain object

Returns:

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

setLabels(request, callback) → {undefined}

Calls SetLabels.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetLabelsVpnGatewayRequest	SetLabelsVpnGatewayRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.SetLabelsCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SetLabels.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetLabelsVpnGatewayRequest	SetLabelsVpnGatewayRequest message or plain object

Returns:

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

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest	TestIamPermissionsVpnGatewayRequest message or plain object
`callback`	google.cloud.compute.v1.VpnGateways.TestIamPermissionsCallback	Node-style callback called with the error, if any, and TestPermissionsResponse

Returns:

Type	Description
undefined

testIamPermissions(request) → {Promise.<google.cloud.compute.v1.TestPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ITestIamPermissionsVpnGatewayRequest	TestIamPermissionsVpnGatewayRequest message or plain object

Returns:

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

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

Creates new VpnGateways 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
VpnGateways	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.VpnGatewayAggregatedList	<optional>	VpnGatewayAggregatedList

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

GetStatusCallback(error, responseopt)

Callback as used by getStatus.

Parameters:

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

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

SetLabelsCallback(error, responseopt)

Callback as used by setLabels.

Parameters:

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

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:

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