Class protos.google.cloud.compute.v1.TargetPools (4.5.0)

Represents a TargetPools

Inheritance

$protobuf.rpc.Service > protos.google.cloud.compute.v1.TargetPools

Package

@google-cloud/compute

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new TargetPools service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

addHealthCheck(request, callback)

public addHealthCheck(request: google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.AddHealthCheckCallback): void;

Calls AddHealthCheck.

Parameters
Name Description
request IAddHealthCheckTargetPoolRequest

AddHealthCheckTargetPoolRequest message or plain object
callback AddHealthCheckCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

addHealthCheck(request)

public addHealthCheck(request: google.cloud.compute.v1.IAddHealthCheckTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AddHealthCheck.

Parameter
Name Description
request IAddHealthCheckTargetPoolRequest

AddHealthCheckTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

addInstance(request, callback)

public addInstance(request: google.cloud.compute.v1.IAddInstanceTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.AddInstanceCallback): void;

Calls AddInstance.

Parameters
Name Description
request IAddInstanceTargetPoolRequest

AddInstanceTargetPoolRequest message or plain object
callback AddInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

addInstance(request)

public addInstance(request: google.cloud.compute.v1.IAddInstanceTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls AddInstance.

Parameter
Name Description
request IAddInstanceTargetPoolRequest

AddInstanceTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

aggregatedList(request, callback)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListTargetPoolsRequest, callback: google.cloud.compute.v1.TargetPools.AggregatedListCallback): void;

Calls AggregatedList.

Parameters
Name Description
request IAggregatedListTargetPoolsRequest

AggregatedListTargetPoolsRequest message or plain object
callback AggregatedListCallback

Node-style callback called with the error, if any, and TargetPoolAggregatedList
Returns
Type Description
void

aggregatedList(request)

public aggregatedList(request: google.cloud.compute.v1.IAggregatedListTargetPoolsRequest): Promise<google.cloud.compute.v1.TargetPoolAggregatedList>;

Calls AggregatedList.

Parameter
Name Description
request IAggregatedListTargetPoolsRequest

AggregatedListTargetPoolsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.TargetPoolAggregatedList>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): TargetPools;

Creates new TargetPools service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited
Returns
Type Description
TargetPools

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

delete(request, callback)

public delete(request: google.cloud.compute.v1.IDeleteTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.DeleteCallback): void;

Calls Delete.

Parameters
Name Description
request IDeleteTargetPoolRequest

DeleteTargetPoolRequest message or plain object
callback DeleteCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

delete(request)

public delete(request: google.cloud.compute.v1.IDeleteTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Delete.

Parameter
Name Description
request IDeleteTargetPoolRequest

DeleteTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

get(request, callback)

public get(request: google.cloud.compute.v1.IGetTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.GetCallback): void;

Calls Get.

Parameters
Name Description
request IGetTargetPoolRequest

GetTargetPoolRequest message or plain object
callback GetCallback

Node-style callback called with the error, if any, and TargetPool
Returns
Type Description
void

get(request)

public get(request: google.cloud.compute.v1.IGetTargetPoolRequest): Promise<google.cloud.compute.v1.TargetPool>;

Calls Get.

Parameter
Name Description
request IGetTargetPoolRequest

GetTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.TargetPool>

Promise

getHealth(request, callback)

public getHealth(request: google.cloud.compute.v1.IGetHealthTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.GetHealthCallback): void;

Calls GetHealth.

Parameters
Name Description
request IGetHealthTargetPoolRequest

GetHealthTargetPoolRequest message or plain object
callback GetHealthCallback

Node-style callback called with the error, if any, and TargetPoolInstanceHealth
Returns
Type Description
void

getHealth(request)

public getHealth(request: google.cloud.compute.v1.IGetHealthTargetPoolRequest): Promise<google.cloud.compute.v1.TargetPoolInstanceHealth>;

Calls GetHealth.

Parameter
Name Description
request IGetHealthTargetPoolRequest

GetHealthTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.TargetPoolInstanceHealth>

Promise

insert(request, callback)

public insert(request: google.cloud.compute.v1.IInsertTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.InsertCallback): void;

Calls Insert.

Parameters
Name Description
request IInsertTargetPoolRequest

InsertTargetPoolRequest message or plain object
callback InsertCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

insert(request)

public insert(request: google.cloud.compute.v1.IInsertTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls Insert.

Parameter
Name Description
request IInsertTargetPoolRequest

InsertTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

list(request, callback)

public list(request: google.cloud.compute.v1.IListTargetPoolsRequest, callback: google.cloud.compute.v1.TargetPools.ListCallback): void;

Calls List.

Parameters
Name Description
request IListTargetPoolsRequest

ListTargetPoolsRequest message or plain object
callback ListCallback

Node-style callback called with the error, if any, and TargetPoolList
Returns
Type Description
void

list(request)

public list(request: google.cloud.compute.v1.IListTargetPoolsRequest): Promise<google.cloud.compute.v1.TargetPoolList>;

Calls List.

Parameter
Name Description
request IListTargetPoolsRequest

ListTargetPoolsRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.TargetPoolList>

Promise

removeHealthCheck(request, callback)

public removeHealthCheck(request: google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.RemoveHealthCheckCallback): void;

Calls RemoveHealthCheck.

Parameters
Name Description
request IRemoveHealthCheckTargetPoolRequest

RemoveHealthCheckTargetPoolRequest message or plain object
callback RemoveHealthCheckCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

removeHealthCheck(request)

public removeHealthCheck(request: google.cloud.compute.v1.IRemoveHealthCheckTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls RemoveHealthCheck.

Parameter
Name Description
request IRemoveHealthCheckTargetPoolRequest

RemoveHealthCheckTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

removeInstance(request, callback)

public removeInstance(request: google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.RemoveInstanceCallback): void;

Calls RemoveInstance.

Parameters
Name Description
request IRemoveInstanceTargetPoolRequest

RemoveInstanceTargetPoolRequest message or plain object
callback RemoveInstanceCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

removeInstance(request)

public removeInstance(request: google.cloud.compute.v1.IRemoveInstanceTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls RemoveInstance.

Parameter
Name Description
request IRemoveInstanceTargetPoolRequest

RemoveInstanceTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setBackup(request, callback)

public setBackup(request: google.cloud.compute.v1.ISetBackupTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.SetBackupCallback): void;

Calls SetBackup.

Parameters
Name Description
request ISetBackupTargetPoolRequest

SetBackupTargetPoolRequest message or plain object
callback SetBackupCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setBackup(request)

public setBackup(request: google.cloud.compute.v1.ISetBackupTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetBackup.

Parameter
Name Description
request ISetBackupTargetPoolRequest

SetBackupTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise

setSecurityPolicy(request, callback)

public setSecurityPolicy(request: google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest, callback: google.cloud.compute.v1.TargetPools.SetSecurityPolicyCallback): void;

Calls SetSecurityPolicy.

Parameters
Name Description
request ISetSecurityPolicyTargetPoolRequest

SetSecurityPolicyTargetPoolRequest message or plain object
callback SetSecurityPolicyCallback

Node-style callback called with the error, if any, and Operation
Returns
Type Description
void

setSecurityPolicy(request)

public setSecurityPolicy(request: google.cloud.compute.v1.ISetSecurityPolicyTargetPoolRequest): Promise<google.cloud.compute.v1.Operation>;

Calls SetSecurityPolicy.

Parameter
Name Description
request ISetSecurityPolicyTargetPoolRequest

SetSecurityPolicyTargetPoolRequest message or plain object
Returns
Type Description
Promise<google.cloud.compute.v1.Operation>

Promise