TaskQueue class

TaskQueue 接口。

签名

export declare class TaskQueue<Args = Record<string, any>> 

方法

方法 修饰符 说明
delete(id) 删除已加入队列的任务(如果尚未完成)。
enqueue(data, opts) 创建任务并将其添加到队列中。任务一经创建便无法更新。此操作需要服务账号的 cloudtasks.tasks.create IAM 权限。

TaskQueue.delete()

删除已加入队列的任务(如果尚未完成)。

签名

delete(id: string): Promise<void>;

参数

参数 类型 说明
id 字符串 任务的 ID(相对于该队列)。

返回

承诺<void>

在删除任务时解析的 promise。

TaskQueue.enqueue()

创建任务并将其添加到队列中。任务一经创建便无法更新。此操作需要服务账号的 cloudtasks.tasks.create IAM 权限。

签名

enqueue(data: Args, opts?: TaskOptions): Promise<void>;

参数

参数 类型 说明
数据 参数 任务的数据载荷。
优化 TaskOptions 将新任务加入队列时的可选选项。

返回

承诺<void>

在成功将任务添加到队列中后解析的 promise。