ForwardingRules

google .cloud .compute .v1. ForwardingRules

Represents a ForwardingRules

Constructor

new ForwardingRules(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

Returns:

Type	Description
undefined

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

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListForwardingRulesRequest	AggregatedListForwardingRulesRequest message or plain object

Returns:

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

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteForwardingRuleRequest	DeleteForwardingRuleRequest message or plain object
`callback`	google.cloud.compute.v1.ForwardingRules.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.IDeleteForwardingRuleRequest	DeleteForwardingRuleRequest 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.IGetForwardingRuleRequest	GetForwardingRuleRequest message or plain object
`callback`	google.cloud.compute.v1.ForwardingRules.GetCallback	Node-style callback called with the error, if any, and ForwardingRule

Returns:

Type	Description
undefined

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

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetForwardingRuleRequest	GetForwardingRuleRequest message or plain object

Returns:

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

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertForwardingRuleRequest	InsertForwardingRuleRequest message or plain object
`callback`	google.cloud.compute.v1.ForwardingRules.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.IInsertForwardingRuleRequest	InsertForwardingRuleRequest 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.IListForwardingRulesRequest	ListForwardingRulesRequest message or plain object
`callback`	google.cloud.compute.v1.ForwardingRules.ListCallback	Node-style callback called with the error, if any, and ForwardingRuleList

Returns:

Type	Description
undefined

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

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListForwardingRulesRequest	ListForwardingRulesRequest message or plain object

Returns:

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

patch(request, callback) → {undefined}

Calls Patch.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IPatchForwardingRuleRequest	PatchForwardingRuleRequest message or plain object
`callback`	google.cloud.compute.v1.ForwardingRules.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.IPatchForwardingRuleRequest	PatchForwardingRuleRequest message or plain object

Returns:

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

setLabels(request, callback) → {undefined}

Calls SetLabels.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetLabelsForwardingRuleRequest	SetLabelsForwardingRuleRequest message or plain object
`callback`	google.cloud.compute.v1.ForwardingRules.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.ISetLabelsForwardingRuleRequest	SetLabelsForwardingRuleRequest message or plain object

Returns:

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

setTarget(request, callback) → {undefined}

Calls SetTarget.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetTargetForwardingRuleRequest	SetTargetForwardingRuleRequest message or plain object
`callback`	google.cloud.compute.v1.ForwardingRules.SetTargetCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SetTarget.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetTargetForwardingRuleRequest	SetTargetForwardingRuleRequest message or plain object

Returns:

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

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

Creates new ForwardingRules 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
ForwardingRules	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.ForwardingRuleAggregatedList	<optional>	ForwardingRuleAggregatedList

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

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

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

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

SetTargetCallback(error, responseopt)

Callback as used by setTarget.

Parameters:

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