Class protos.google.cloud.run.v2.WorkerPools (3.2.0)

Version latest

• 3.2.0 (latest)
• 2.1.0
• 1.5.0
• 1.0.2
• 0.5.0
• 0.4.2
• 0.2.3

Represents a WorkerPools

Inheritance

$protobuf.rpc.Service > protos.google.cloud.run.v2.WorkerPools

Package

@google-cloud/run

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new WorkerPools service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

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

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

createWorkerPool(request, callback)

public createWorkerPool(request: google.cloud.run.v2.ICreateWorkerPoolRequest, callback: google.cloud.run.v2.WorkerPools.CreateWorkerPoolCallback): void;

Calls CreateWorkerPool.

Parameters
Name	Description
request	ICreateWorkerPoolRequest CreateWorkerPoolRequest message or plain object
callback	CreateWorkerPoolCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createWorkerPool(request)

public createWorkerPool(request: google.cloud.run.v2.ICreateWorkerPoolRequest): Promise<google.longrunning.Operation>;

Calls CreateWorkerPool.

Parameter
Name	Description
request	ICreateWorkerPoolRequest CreateWorkerPoolRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteWorkerPool(request, callback)

public deleteWorkerPool(request: google.cloud.run.v2.IDeleteWorkerPoolRequest, callback: google.cloud.run.v2.WorkerPools.DeleteWorkerPoolCallback): void;

Calls DeleteWorkerPool.

Parameters
Name	Description
request	IDeleteWorkerPoolRequest DeleteWorkerPoolRequest message or plain object
callback	DeleteWorkerPoolCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteWorkerPool(request)

public deleteWorkerPool(request: google.cloud.run.v2.IDeleteWorkerPoolRequest): Promise<google.longrunning.Operation>;

Calls DeleteWorkerPool.

Parameter
Name	Description
request	IDeleteWorkerPoolRequest DeleteWorkerPoolRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.run.v2.WorkerPools.GetIamPolicyCallback): void;

Calls GetIamPolicy.

Parameters
Name	Description
request	IGetIamPolicyRequest GetIamPolicyRequest message or plain object
callback	GetIamPolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

getIamPolicy(request)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls GetIamPolicy.

Parameter
Name	Description
request	IGetIamPolicyRequest GetIamPolicyRequest message or plain object

Returns
Type	Description
Promise<google.iam.v1.Policy>	Promise

getWorkerPool(request, callback)

public getWorkerPool(request: google.cloud.run.v2.IGetWorkerPoolRequest, callback: google.cloud.run.v2.WorkerPools.GetWorkerPoolCallback): void;

Calls GetWorkerPool.

Parameters
Name	Description
request	IGetWorkerPoolRequest GetWorkerPoolRequest message or plain object
callback	GetWorkerPoolCallback Node-style callback called with the error, if any, and WorkerPool

Returns
Type	Description
void

getWorkerPool(request)

public getWorkerPool(request: google.cloud.run.v2.IGetWorkerPoolRequest): Promise<google.cloud.run.v2.WorkerPool>;

Calls GetWorkerPool.

Parameter
Name	Description
request	IGetWorkerPoolRequest GetWorkerPoolRequest message or plain object

Returns
Type	Description
Promise<google.cloud.run.v2.WorkerPool>	Promise

listWorkerPools(request, callback)

public listWorkerPools(request: google.cloud.run.v2.IListWorkerPoolsRequest, callback: google.cloud.run.v2.WorkerPools.ListWorkerPoolsCallback): void;

Calls ListWorkerPools.

Parameters
Name	Description
request	IListWorkerPoolsRequest ListWorkerPoolsRequest message or plain object
callback	ListWorkerPoolsCallback Node-style callback called with the error, if any, and ListWorkerPoolsResponse

Returns
Type	Description
void

listWorkerPools(request)

public listWorkerPools(request: google.cloud.run.v2.IListWorkerPoolsRequest): Promise<google.cloud.run.v2.ListWorkerPoolsResponse>;

Calls ListWorkerPools.

Parameter
Name	Description
request	IListWorkerPoolsRequest ListWorkerPoolsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.run.v2.ListWorkerPoolsResponse>	Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.run.v2.WorkerPools.SetIamPolicyCallback): void;

Calls SetIamPolicy.

Parameters
Name	Description
request	ISetIamPolicyRequest SetIamPolicyRequest message or plain object
callback	SetIamPolicyCallback Node-style callback called with the error, if any, and Policy

Returns
Type	Description
void

setIamPolicy(request)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;

Calls SetIamPolicy.

Parameter
Name	Description
request	ISetIamPolicyRequest SetIamPolicyRequest message or plain object

Returns
Type	Description
Promise<google.iam.v1.Policy>	Promise

testIamPermissions(request, callback)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.cloud.run.v2.WorkerPools.TestIamPermissionsCallback): void;

Calls TestIamPermissions.

Parameters
Name	Description
request	ITestIamPermissionsRequest TestIamPermissionsRequest message or plain object
callback	TestIamPermissionsCallback Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns
Type	Description
void

testIamPermissions(request)

public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;

Calls TestIamPermissions.

Parameter
Name	Description
request	ITestIamPermissionsRequest TestIamPermissionsRequest message or plain object

Returns
Type	Description
Promise<google.iam.v1.TestIamPermissionsResponse>	Promise

updateWorkerPool(request, callback)

public updateWorkerPool(request: google.cloud.run.v2.IUpdateWorkerPoolRequest, callback: google.cloud.run.v2.WorkerPools.UpdateWorkerPoolCallback): void;

Calls UpdateWorkerPool.

Parameters
Name	Description
request	IUpdateWorkerPoolRequest UpdateWorkerPoolRequest message or plain object
callback	UpdateWorkerPoolCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateWorkerPool(request)

public updateWorkerPool(request: google.cloud.run.v2.IUpdateWorkerPoolRequest): Promise<google.longrunning.Operation>;

Calls UpdateWorkerPool.

Parameter
Name	Description
request	IUpdateWorkerPoolRequest UpdateWorkerPoolRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise