tasks.TaskQueueFunction interface
Stay organized with collections
Save and categorize content based on your preferences.
A handler for tasks.
Signature:
export interface TaskQueueFunction
Properties
Methods
Method |
Description |
run(data, context) |
The callback passed to the TaskQueueFunction constructor. |
tasks.TaskQueueFunction.__endpoint
Signature:
__endpoint: ManifestEndpoint;
tasks.TaskQueueFunction.__requiredAPIs
Signature:
__requiredAPIs?: ManifestRequiredAPI[];
tasks.TaskQueueFunction.__trigger
Signature:
__trigger: unknown;
tasks.TaskQueueFunction.run()
The callback passed to the TaskQueueFunction
constructor.
Signature:
run(data: any, context: TaskContext): void | Promise<void>;
Parameters
Parameter |
Type |
Description |
data |
any |
The body enqueued into a task queue. |
context |
TaskContext |
The request context of the enqueued task |
Returns:
void | Promise<void>
Any return value. Google Cloud Functions will await any promise before shutting down your function. Resolved return values are only used for unit testing purposes.
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 2025-06-04 UTC.
[null,null,["Last updated 2025-06-04 UTC."],[],[],null,["A handler for tasks.\n\n**Signature:** \n\n export interface TaskQueueFunction \n\nProperties\n\nMethods\n\ntasks.TaskQueueFunction.__endpoint\n\n**Signature:** \n\n __endpoint: ManifestEndpoint;\n\ntasks.TaskQueueFunction.__requiredAPIs\n\n**Signature:** \n\n __requiredAPIs?: ManifestRequiredAPI[];\n\ntasks.TaskQueueFunction.__trigger\n\n**Signature:** \n\n __trigger: unknown;\n\ntasks.TaskQueueFunction.run()\n\nThe callback passed to the `TaskQueueFunction` constructor.\n\n**Signature:** \n\n run(data: any, context: TaskContext): void | Promise\u003cvoid\u003e;\n\nParameters\n\n**Returns:**\n\nvoid \\| Promise\\\u003cvoid\\\u003e\n\nAny return value. Google Cloud Functions will await any promise before shutting down your function. Resolved return values are only used for unit testing purposes."]]