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。