TargetPools

google .cloud .compute .v1. TargetPools

Represents a TargetPools

Constructor

new TargetPools(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

addHealthCheck(request, callback) → {undefined}

Calls AddHealthCheck.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest	AddHealthCheckTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.AddHealthCheckCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls AddHealthCheck.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest	AddHealthCheckTargetPoolRequest message or plain object

Returns:

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

addInstance(request, callback) → {undefined}

Calls AddInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddInstanceTargetPoolRequest	AddInstanceTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.AddInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls AddInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAddInstanceTargetPoolRequest	AddInstanceTargetPoolRequest message or plain object

Returns:

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

aggregatedList(request, callback) → {undefined}

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListTargetPoolsRequest	AggregatedListTargetPoolsRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.AggregatedListCallback	Node-style callback called with the error, if any, and TargetPoolAggregatedList

Returns:

Type	Description
undefined

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

Calls AggregatedList.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IAggregatedListTargetPoolsRequest	AggregatedListTargetPoolsRequest message or plain object

Returns:

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

delete(request, callback) → {undefined}

Calls Delete.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IDeleteTargetPoolRequest	DeleteTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.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.IDeleteTargetPoolRequest	DeleteTargetPoolRequest 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.IGetTargetPoolRequest	GetTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.GetCallback	Node-style callback called with the error, if any, and TargetPool

Returns:

Type	Description
undefined

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

Calls Get.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetTargetPoolRequest	GetTargetPoolRequest message or plain object

Returns:

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

getHealth(request, callback) → {undefined}

Calls GetHealth.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetHealthTargetPoolRequest	GetHealthTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.GetHealthCallback	Node-style callback called with the error, if any, and TargetPoolInstanceHealth

Returns:

Type	Description
undefined

getHealth(request) → {Promise.<google.cloud.compute.v1.TargetPoolInstanceHealth>}

Calls GetHealth.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IGetHealthTargetPoolRequest	GetHealthTargetPoolRequest message or plain object

Returns:

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

insert(request, callback) → {undefined}

Calls Insert.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IInsertTargetPoolRequest	InsertTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.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.IInsertTargetPoolRequest	InsertTargetPoolRequest 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.IListTargetPoolsRequest	ListTargetPoolsRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.ListCallback	Node-style callback called with the error, if any, and TargetPoolList

Returns:

Type	Description
undefined

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

Calls List.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IListTargetPoolsRequest	ListTargetPoolsRequest message or plain object

Returns:

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

removeHealthCheck(request, callback) → {undefined}

Calls RemoveHealthCheck.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest	RemoveHealthCheckTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.RemoveHealthCheckCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls RemoveHealthCheck.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest	RemoveHealthCheckTargetPoolRequest message or plain object

Returns:

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

removeInstance(request, callback) → {undefined}

Calls RemoveInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest	RemoveInstanceTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.RemoveInstanceCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls RemoveInstance.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest	RemoveInstanceTargetPoolRequest message or plain object

Returns:

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

setBackup(request, callback) → {undefined}

Calls SetBackup.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetBackupTargetPoolRequest	SetBackupTargetPoolRequest message or plain object
`callback`	google.cloud.compute.v1.TargetPools.SetBackupCallback	Node-style callback called with the error, if any, and Operation

Returns:

Type	Description
undefined

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

Calls SetBackup.

Parameters:

Name	Type	Description
`request`	google.cloud.compute.v1.ISetBackupTargetPoolRequest	SetBackupTargetPoolRequest message or plain object

Returns:

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

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

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

Type Definitions

AddHealthCheckCallback(error, responseopt)

Callback as used by addHealthCheck.

Parameters:

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

AddInstanceCallback(error, responseopt)

Callback as used by addInstance.

Parameters:

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

AggregatedListCallback(error, responseopt)

Callback as used by aggregatedList.

Parameters:

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

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

GetHealthCallback(error, responseopt)

Callback as used by getHealth.

Parameters:

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

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

RemoveHealthCheckCallback(error, responseopt)

Callback as used by removeHealthCheck.

Parameters:

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

RemoveInstanceCallback(error, responseopt)

Callback as used by removeInstance.

Parameters:

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

SetBackupCallback(error, responseopt)

Callback as used by setBackup.

Parameters:

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