TaskQueue class
Stay organized with collections
Save and categorize content based on your preferences.
The TaskQueue interface.
Signature:
export declare class TaskQueue<Args = Record<string, any>>
Methods
| Method |
Modifiers |
Description |
| delete(id) |
|
Deletes an enqueued task if it has not yet completed. |
| enqueue(data, opts) |
|
Creates a task and adds it to the queue. Tasks cannot be updated after creation. This action requires cloudtasks.tasks.create IAM permission on the service account. |
TaskQueue.delete()
Deletes an enqueued task if it has not yet completed.
Signature:
delete(id: string): Promise<void>;
Parameters
| Parameter |
Type |
Description |
| id |
string |
the ID of the task, relative to this queue. |
Returns:
Promise<void>
A promise that resolves when the task has been deleted.
TaskQueue.enqueue()
Creates a task and adds it to the queue. Tasks cannot be updated after creation. This action requires cloudtasks.tasks.create IAM permission on the service account.
Signature:
enqueue(data: Args, opts?: TaskOptions): Promise<void>;
Parameters
| Parameter |
Type |
Description |
| data |
Args |
The data payload of the task. |
| opts |
TaskOptions |
Optional options when enqueuing a new task. |
Returns:
Promise<void>
A promise that resolves when the task has successfully been added to the queue.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-07-12 UTC.
[null,null,["Last updated 2023-07-12 UTC."],[],[],null,["The `TaskQueue` interface.\n\n**Signature:** \n\n export declare class TaskQueue\u003cArgs = Record\u003cstring, any\u003e\u003e \n\nMethods\n\nTaskQueue.delete()\n\nDeletes an enqueued task if it has not yet completed.\n\n**Signature:** \n\n delete(id: string): Promise\u003cvoid\u003e;\n\nParameters\n\n**Returns:**\n\nPromise\\\u003cvoid\\\u003e\n\nA promise that resolves when the task has been deleted.\n\nTaskQueue.enqueue()\n\nCreates a task and adds it to the queue. Tasks cannot be updated after creation. This action requires `cloudtasks.tasks.create` IAM permission on the service account.\n\n**Signature:** \n\n enqueue(data: Args, opts?: TaskOptions): Promise\u003cvoid\u003e;\n\nParameters\n\n**Returns:**\n\nPromise\\\u003cvoid\\\u003e\n\nA promise that resolves when the task has successfully been added to the queue."]]
