Class protos.google.cloud.tasks.v2beta2.CloudTasks (5.5.2)

Represents a CloudTasks

Inheritance

$protobuf.rpc.Service > protos.google.cloud.tasks.v2beta2.CloudTasks

Package

@google-cloud/tasks

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

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

Constructs a new CloudTasks service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation
requestDelimited boolean

Whether requests are length-delimited
responseDelimited boolean

Whether responses are length-delimited

Methods

acknowledgeTask(request, callback)

public acknowledgeTask(request: google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTaskCallback): void;

Calls AcknowledgeTask.

Parameters
Name Description
request IAcknowledgeTaskRequest

AcknowledgeTaskRequest message or plain object
callback AcknowledgeTaskCallback

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

acknowledgeTask(request)

public acknowledgeTask(request: google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest): Promise<google.protobuf.Empty>;

Calls AcknowledgeTask.

Parameter
Name Description
request IAcknowledgeTaskRequest

AcknowledgeTaskRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

cancelLease(request, callback)

public cancelLease(request: google.cloud.tasks.v2beta2.ICancelLeaseRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.CancelLeaseCallback): void;

Calls CancelLease.

Parameters
Name Description
request ICancelLeaseRequest

CancelLeaseRequest message or plain object
callback CancelLeaseCallback

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

cancelLease(request)

public cancelLease(request: google.cloud.tasks.v2beta2.ICancelLeaseRequest): Promise<google.cloud.tasks.v2beta2.Task>;

Calls CancelLease.

Parameter
Name Description
request ICancelLeaseRequest

CancelLeaseRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Task>

Promise

create(rpcImpl, requestDelimited, responseDelimited)

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

Creates new CloudTasks 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
CloudTasks

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

createQueue(request, callback)

public createQueue(request: google.cloud.tasks.v2beta2.ICreateQueueRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.CreateQueueCallback): void;

Calls CreateQueue.

Parameters
Name Description
request ICreateQueueRequest

CreateQueueRequest message or plain object
callback CreateQueueCallback

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

createQueue(request)

public createQueue(request: google.cloud.tasks.v2beta2.ICreateQueueRequest): Promise<google.cloud.tasks.v2beta2.Queue>;

Calls CreateQueue.

Parameter
Name Description
request ICreateQueueRequest

CreateQueueRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Queue>

Promise

createTask(request, callback)

public createTask(request: google.cloud.tasks.v2beta2.ICreateTaskRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.CreateTaskCallback): void;

Calls CreateTask.

Parameters
Name Description
request ICreateTaskRequest

CreateTaskRequest message or plain object
callback CreateTaskCallback

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

createTask(request)

public createTask(request: google.cloud.tasks.v2beta2.ICreateTaskRequest): Promise<google.cloud.tasks.v2beta2.Task>;

Calls CreateTask.

Parameter
Name Description
request ICreateTaskRequest

CreateTaskRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Task>

Promise

deleteQueue(request, callback)

public deleteQueue(request: google.cloud.tasks.v2beta2.IDeleteQueueRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.DeleteQueueCallback): void;

Calls DeleteQueue.

Parameters
Name Description
request IDeleteQueueRequest

DeleteQueueRequest message or plain object
callback DeleteQueueCallback

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

deleteQueue(request)

public deleteQueue(request: google.cloud.tasks.v2beta2.IDeleteQueueRequest): Promise<google.protobuf.Empty>;

Calls DeleteQueue.

Parameter
Name Description
request IDeleteQueueRequest

DeleteQueueRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteTask(request, callback)

public deleteTask(request: google.cloud.tasks.v2beta2.IDeleteTaskRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.DeleteTaskCallback): void;

Calls DeleteTask.

Parameters
Name Description
request IDeleteTaskRequest

DeleteTaskRequest message or plain object
callback DeleteTaskCallback

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

deleteTask(request)

public deleteTask(request: google.cloud.tasks.v2beta2.IDeleteTaskRequest): Promise<google.protobuf.Empty>;

Calls DeleteTask.

Parameter
Name Description
request IDeleteTaskRequest

DeleteTaskRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise

getIamPolicy(request, callback)

public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.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

getQueue(request, callback)

public getQueue(request: google.cloud.tasks.v2beta2.IGetQueueRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.GetQueueCallback): void;

Calls GetQueue.

Parameters
Name Description
request IGetQueueRequest

GetQueueRequest message or plain object
callback GetQueueCallback

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

getQueue(request)

public getQueue(request: google.cloud.tasks.v2beta2.IGetQueueRequest): Promise<google.cloud.tasks.v2beta2.Queue>;

Calls GetQueue.

Parameter
Name Description
request IGetQueueRequest

GetQueueRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Queue>

Promise

getTask(request, callback)

public getTask(request: google.cloud.tasks.v2beta2.IGetTaskRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.GetTaskCallback): void;

Calls GetTask.

Parameters
Name Description
request IGetTaskRequest

GetTaskRequest message or plain object
callback GetTaskCallback

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

getTask(request)

public getTask(request: google.cloud.tasks.v2beta2.IGetTaskRequest): Promise<google.cloud.tasks.v2beta2.Task>;

Calls GetTask.

Parameter
Name Description
request IGetTaskRequest

GetTaskRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Task>

Promise

leaseTasks(request, callback)

public leaseTasks(request: google.cloud.tasks.v2beta2.ILeaseTasksRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.LeaseTasksCallback): void;

Calls LeaseTasks.

Parameters
Name Description
request ILeaseTasksRequest

LeaseTasksRequest message or plain object
callback LeaseTasksCallback

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

leaseTasks(request)

public leaseTasks(request: google.cloud.tasks.v2beta2.ILeaseTasksRequest): Promise<google.cloud.tasks.v2beta2.LeaseTasksResponse>;

Calls LeaseTasks.

Parameter
Name Description
request ILeaseTasksRequest

LeaseTasksRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.LeaseTasksResponse>

Promise

listQueues(request, callback)

public listQueues(request: google.cloud.tasks.v2beta2.IListQueuesRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.ListQueuesCallback): void;

Calls ListQueues.

Parameters
Name Description
request IListQueuesRequest

ListQueuesRequest message or plain object
callback ListQueuesCallback

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

listQueues(request)

public listQueues(request: google.cloud.tasks.v2beta2.IListQueuesRequest): Promise<google.cloud.tasks.v2beta2.ListQueuesResponse>;

Calls ListQueues.

Parameter
Name Description
request IListQueuesRequest

ListQueuesRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.ListQueuesResponse>

Promise

listTasks(request, callback)

public listTasks(request: google.cloud.tasks.v2beta2.IListTasksRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.ListTasksCallback): void;

Calls ListTasks.

Parameters
Name Description
request IListTasksRequest

ListTasksRequest message or plain object
callback ListTasksCallback

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

listTasks(request)

public listTasks(request: google.cloud.tasks.v2beta2.IListTasksRequest): Promise<google.cloud.tasks.v2beta2.ListTasksResponse>;

Calls ListTasks.

Parameter
Name Description
request IListTasksRequest

ListTasksRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.ListTasksResponse>

Promise

pauseQueue(request, callback)

public pauseQueue(request: google.cloud.tasks.v2beta2.IPauseQueueRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.PauseQueueCallback): void;

Calls PauseQueue.

Parameters
Name Description
request IPauseQueueRequest

PauseQueueRequest message or plain object
callback PauseQueueCallback

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

pauseQueue(request)

public pauseQueue(request: google.cloud.tasks.v2beta2.IPauseQueueRequest): Promise<google.cloud.tasks.v2beta2.Queue>;

Calls PauseQueue.

Parameter
Name Description
request IPauseQueueRequest

PauseQueueRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Queue>

Promise

purgeQueue(request, callback)

public purgeQueue(request: google.cloud.tasks.v2beta2.IPurgeQueueRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.PurgeQueueCallback): void;

Calls PurgeQueue.

Parameters
Name Description
request IPurgeQueueRequest

PurgeQueueRequest message or plain object
callback PurgeQueueCallback

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

purgeQueue(request)

public purgeQueue(request: google.cloud.tasks.v2beta2.IPurgeQueueRequest): Promise<google.cloud.tasks.v2beta2.Queue>;

Calls PurgeQueue.

Parameter
Name Description
request IPurgeQueueRequest

PurgeQueueRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Queue>

Promise

renewLease(request, callback)

public renewLease(request: google.cloud.tasks.v2beta2.IRenewLeaseRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.RenewLeaseCallback): void;

Calls RenewLease.

Parameters
Name Description
request IRenewLeaseRequest

RenewLeaseRequest message or plain object
callback RenewLeaseCallback

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

renewLease(request)

public renewLease(request: google.cloud.tasks.v2beta2.IRenewLeaseRequest): Promise<google.cloud.tasks.v2beta2.Task>;

Calls RenewLease.

Parameter
Name Description
request IRenewLeaseRequest

RenewLeaseRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Task>

Promise

resumeQueue(request, callback)

public resumeQueue(request: google.cloud.tasks.v2beta2.IResumeQueueRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.ResumeQueueCallback): void;

Calls ResumeQueue.

Parameters
Name Description
request IResumeQueueRequest

ResumeQueueRequest message or plain object
callback ResumeQueueCallback

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

resumeQueue(request)

public resumeQueue(request: google.cloud.tasks.v2beta2.IResumeQueueRequest): Promise<google.cloud.tasks.v2beta2.Queue>;

Calls ResumeQueue.

Parameter
Name Description
request IResumeQueueRequest

ResumeQueueRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Queue>

Promise

runTask(request, callback)

public runTask(request: google.cloud.tasks.v2beta2.IRunTaskRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.RunTaskCallback): void;

Calls RunTask.

Parameters
Name Description
request IRunTaskRequest

RunTaskRequest message or plain object
callback RunTaskCallback

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

runTask(request)

public runTask(request: google.cloud.tasks.v2beta2.IRunTaskRequest): Promise<google.cloud.tasks.v2beta2.Task>;

Calls RunTask.

Parameter
Name Description
request IRunTaskRequest

RunTaskRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Task>

Promise

setIamPolicy(request, callback)

public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.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.tasks.v2beta2.CloudTasks.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

updateQueue(request, callback)

public updateQueue(request: google.cloud.tasks.v2beta2.IUpdateQueueRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.UpdateQueueCallback): void;

Calls UpdateQueue.

Parameters
Name Description
request IUpdateQueueRequest

UpdateQueueRequest message or plain object
callback UpdateQueueCallback

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

updateQueue(request)

public updateQueue(request: google.cloud.tasks.v2beta2.IUpdateQueueRequest): Promise<google.cloud.tasks.v2beta2.Queue>;

Calls UpdateQueue.

Parameter
Name Description
request IUpdateQueueRequest

UpdateQueueRequest message or plain object
Returns
Type Description
Promise<google.cloud.tasks.v2beta2.Queue>

Promise

uploadQueueYaml(request, callback)

public uploadQueueYaml(request: google.cloud.tasks.v2beta2.IUploadQueueYamlRequest, callback: google.cloud.tasks.v2beta2.CloudTasks.UploadQueueYamlCallback): void;

Calls UploadQueueYaml.

Parameters
Name Description
request IUploadQueueYamlRequest

UploadQueueYamlRequest message or plain object
callback UploadQueueYamlCallback

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

uploadQueueYaml(request)

public uploadQueueYaml(request: google.cloud.tasks.v2beta2.IUploadQueueYamlRequest): Promise<google.protobuf.Empty>;

Calls UploadQueueYaml.

Parameter
Name Description
request IUploadQueueYamlRequest

UploadQueueYamlRequest message or plain object
Returns
Type Description
Promise<google.protobuf.Empty>

Promise