CloudTasks - Documentation

CloudTasks

google .cloud .tasks .v2beta2. CloudTasks

Represents a CloudTasks

Constructor

new CloudTasks(rpcImpl, requestDelimitedopt, responseDelimitedopt)

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

acknowledgeTask(request, callback) → {undefined}

Calls AcknowledgeTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest	AcknowledgeTaskRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTaskCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

acknowledgeTask(request) → {Promise.<google.protobuf.Empty>}

Calls AcknowledgeTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IAcknowledgeTaskRequest	AcknowledgeTaskRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

cancelLease(request, callback) → {undefined}

Calls CancelLease.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ICancelLeaseRequest	CancelLeaseRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.CancelLeaseCallback	Node-style callback called with the error, if any, and Task

Returns:

Type	Description
undefined

cancelLease(request) → {Promise.<google.cloud.tasks.v2beta2.Task>}

Calls CancelLease.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ICancelLeaseRequest	CancelLeaseRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Task>	Promise

createQueue(request, callback) → {undefined}

Calls CreateQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ICreateQueueRequest	CreateQueueRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.CreateQueueCallback	Node-style callback called with the error, if any, and Queue

Returns:

Type	Description
undefined

createQueue(request) → {Promise.<google.cloud.tasks.v2beta2.Queue>}

Calls CreateQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ICreateQueueRequest	CreateQueueRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Queue>	Promise

createTask(request, callback) → {undefined}

Calls CreateTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ICreateTaskRequest	CreateTaskRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.CreateTaskCallback	Node-style callback called with the error, if any, and Task

Returns:

Type	Description
undefined

createTask(request) → {Promise.<google.cloud.tasks.v2beta2.Task>}

Calls CreateTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ICreateTaskRequest	CreateTaskRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Task>	Promise

deleteQueue(request, callback) → {undefined}

Calls DeleteQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IDeleteQueueRequest	DeleteQueueRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.DeleteQueueCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteQueue(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IDeleteQueueRequest	DeleteQueueRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

deleteTask(request, callback) → {undefined}

Calls DeleteTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IDeleteTaskRequest	DeleteTaskRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.DeleteTaskCallback	Node-style callback called with the error, if any, and Empty

Returns:

Type	Description
undefined

deleteTask(request) → {Promise.<google.protobuf.Empty>}

Calls DeleteTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IDeleteTaskRequest	DeleteTaskRequest message or plain object

Returns:

Type	Description
Promise.<google.protobuf.Empty>	Promise

getIamPolicy(request, callback) → {undefined}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.GetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

getIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls GetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.IGetIamPolicyRequest	GetIamPolicyRequest message or plain object

Returns:

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

getQueue(request, callback) → {undefined}

Calls GetQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IGetQueueRequest	GetQueueRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.GetQueueCallback	Node-style callback called with the error, if any, and Queue

Returns:

Type	Description
undefined

getQueue(request) → {Promise.<google.cloud.tasks.v2beta2.Queue>}

Calls GetQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IGetQueueRequest	GetQueueRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Queue>	Promise

getTask(request, callback) → {undefined}

Calls GetTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IGetTaskRequest	GetTaskRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.GetTaskCallback	Node-style callback called with the error, if any, and Task

Returns:

Type	Description
undefined

getTask(request) → {Promise.<google.cloud.tasks.v2beta2.Task>}

Calls GetTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IGetTaskRequest	GetTaskRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Task>	Promise

leaseTasks(request, callback) → {undefined}

Calls LeaseTasks.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ILeaseTasksRequest	LeaseTasksRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.LeaseTasksCallback	Node-style callback called with the error, if any, and LeaseTasksResponse

Returns:

Type	Description
undefined

leaseTasks(request) → {Promise.<google.cloud.tasks.v2beta2.LeaseTasksResponse>}

Calls LeaseTasks.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.ILeaseTasksRequest	LeaseTasksRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.LeaseTasksResponse>	Promise

listQueues(request, callback) → {undefined}

Calls ListQueues.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IListQueuesRequest	ListQueuesRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.ListQueuesCallback	Node-style callback called with the error, if any, and ListQueuesResponse

Returns:

Type	Description
undefined

listQueues(request) → {Promise.<google.cloud.tasks.v2beta2.ListQueuesResponse>}

Calls ListQueues.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IListQueuesRequest	ListQueuesRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.ListQueuesResponse>	Promise

listTasks(request, callback) → {undefined}

Calls ListTasks.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IListTasksRequest	ListTasksRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.ListTasksCallback	Node-style callback called with the error, if any, and ListTasksResponse

Returns:

Type	Description
undefined

listTasks(request) → {Promise.<google.cloud.tasks.v2beta2.ListTasksResponse>}

Calls ListTasks.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IListTasksRequest	ListTasksRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.ListTasksResponse>	Promise

pauseQueue(request, callback) → {undefined}

Calls PauseQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IPauseQueueRequest	PauseQueueRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.PauseQueueCallback	Node-style callback called with the error, if any, and Queue

Returns:

Type	Description
undefined

pauseQueue(request) → {Promise.<google.cloud.tasks.v2beta2.Queue>}

Calls PauseQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IPauseQueueRequest	PauseQueueRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Queue>	Promise

purgeQueue(request, callback) → {undefined}

Calls PurgeQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IPurgeQueueRequest	PurgeQueueRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.PurgeQueueCallback	Node-style callback called with the error, if any, and Queue

Returns:

Type	Description
undefined

purgeQueue(request) → {Promise.<google.cloud.tasks.v2beta2.Queue>}

Calls PurgeQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IPurgeQueueRequest	PurgeQueueRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Queue>	Promise

renewLease(request, callback) → {undefined}

Calls RenewLease.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IRenewLeaseRequest	RenewLeaseRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.RenewLeaseCallback	Node-style callback called with the error, if any, and Task

Returns:

Type	Description
undefined

renewLease(request) → {Promise.<google.cloud.tasks.v2beta2.Task>}

Calls RenewLease.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IRenewLeaseRequest	RenewLeaseRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Task>	Promise

resumeQueue(request, callback) → {undefined}

Calls ResumeQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IResumeQueueRequest	ResumeQueueRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.ResumeQueueCallback	Node-style callback called with the error, if any, and Queue

Returns:

Type	Description
undefined

resumeQueue(request) → {Promise.<google.cloud.tasks.v2beta2.Queue>}

Calls ResumeQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IResumeQueueRequest	ResumeQueueRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Queue>	Promise

runTask(request, callback) → {undefined}

Calls RunTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IRunTaskRequest	RunTaskRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.RunTaskCallback	Node-style callback called with the error, if any, and Task

Returns:

Type	Description
undefined

runTask(request) → {Promise.<google.cloud.tasks.v2beta2.Task>}

Calls RunTask.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IRunTaskRequest	RunTaskRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Task>	Promise

setIamPolicy(request, callback) → {undefined}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.SetIamPolicyCallback	Node-style callback called with the error, if any, and Policy

Returns:

Type	Description
undefined

setIamPolicy(request) → {Promise.<google.iam.v1.Policy>}

Calls SetIamPolicy.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ISetIamPolicyRequest	SetIamPolicyRequest message or plain object

Returns:

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

testIamPermissions(request, callback) → {undefined}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.TestIamPermissionsCallback	Node-style callback called with the error, if any, and TestIamPermissionsResponse

Returns:

Type	Description
undefined

testIamPermissions(request) → {Promise.<google.iam.v1.TestIamPermissionsResponse>}

Calls TestIamPermissions.

Parameters:

Name	Type	Description
`request`	google.iam.v1.ITestIamPermissionsRequest	TestIamPermissionsRequest message or plain object

Returns:

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

updateQueue(request, callback) → {undefined}

Calls UpdateQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IUpdateQueueRequest	UpdateQueueRequest message or plain object
`callback`	google.cloud.tasks.v2beta2.CloudTasks.UpdateQueueCallback	Node-style callback called with the error, if any, and Queue

Returns:

Type	Description
undefined

updateQueue(request) → {Promise.<google.cloud.tasks.v2beta2.Queue>}

Calls UpdateQueue.

Parameters:

Name	Type	Description
`request`	google.cloud.tasks.v2beta2.IUpdateQueueRequest	UpdateQueueRequest message or plain object

Returns:

Type	Description
Promise.<google.cloud.tasks.v2beta2.Queue>	Promise

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

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

Type Definitions

AcknowledgeTaskCallback(error, responseopt)

Callback as used by acknowledgeTask.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

CancelLeaseCallback(error, responseopt)

Callback as used by cancelLease.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Task	<optional>	Task

CreateQueueCallback(error, responseopt)

Callback as used by createQueue.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Queue	<optional>	Queue

CreateTaskCallback(error, responseopt)

Callback as used by createTask.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Task	<optional>	Task

DeleteQueueCallback(error, responseopt)

Callback as used by deleteQueue.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

DeleteTaskCallback(error, responseopt)

Callback as used by deleteTask.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.protobuf.Empty	<optional>	Empty

GetIamPolicyCallback(error, responseopt)

Callback as used by getIamPolicy.

Parameters:

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

GetQueueCallback(error, responseopt)

Callback as used by getQueue.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Queue	<optional>	Queue

GetTaskCallback(error, responseopt)

Callback as used by getTask.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Task	<optional>	Task

LeaseTasksCallback(error, responseopt)

Callback as used by leaseTasks.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.LeaseTasksResponse	<optional>	LeaseTasksResponse

ListQueuesCallback(error, responseopt)

Callback as used by listQueues.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.ListQueuesResponse	<optional>	ListQueuesResponse

ListTasksCallback(error, responseopt)

Callback as used by listTasks.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.ListTasksResponse	<optional>	ListTasksResponse

PauseQueueCallback(error, responseopt)

Callback as used by pauseQueue.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Queue	<optional>	Queue

PurgeQueueCallback(error, responseopt)

Callback as used by purgeQueue.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Queue	<optional>	Queue

RenewLeaseCallback(error, responseopt)

Callback as used by renewLease.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Task	<optional>	Task

ResumeQueueCallback(error, responseopt)

Callback as used by resumeQueue.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Queue	<optional>	Queue

RunTaskCallback(error, responseopt)

Callback as used by runTask.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Task	<optional>	Task

SetIamPolicyCallback(error, responseopt)

Callback as used by setIamPolicy.

Parameters:

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

TestIamPermissionsCallback(error, responseopt)

Callback as used by testIamPermissions.

Parameters:

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

UpdateQueueCallback(error, responseopt)

Callback as used by updateQueue.

Parameters:

Name	Type	Attributes	Description
`error`	Error \| null		Error, if any
`response`	google.cloud.tasks.v2beta2.Queue	<optional>	Queue