タスクキュー関数の呼び出しに関するメタデータ。
署名:
export interface TaskContext
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| 認証 | 認証データ | ODIC トークンのデコードと検証の結果。 |
| executionCount | 数値 | タスクがハンドラからレスポンスを受け取った合計回数。Cloud Tasks は成功のレスポンスを受け取った時点でタスクを削除するため、それ以前のハンドラからのレスポンスはすべて失敗を意味します。この数値には、5XX エラーコードによる失敗は含まれません。X-CloudTasks-TaskExecutionCount ヘッダーを介して入力されます。 |
| ヘッダー | レコード<文字列, 文字列> | 未加工のリクエスト ヘッダー。 |
| id | 文字列 | タスクの「省略」名。または、作成時に名前が指定されなかった場合は、システムによって生成された一意の ID です。これが「my-task-id」値を完全なタスク名で指定する必要があります（例: task_name = projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id）。X-CloudTasks-TaskName ヘッダーを介して入力されます。 |
| previousResponse | 数値 | 前回の再試行の HTTP レスポンス コード。X-CloudTasks-TaskPreviousResponse ヘッダーを介して入力されます。 |
| queueName | 文字列 | キューの名前です。X-CloudTasks-QueueName ヘッダーを介して入力されます。 |
| retryCount | 数値 | このタスクが再試行された回数。最初の試行では、この値は 0 になります。この数値には、5XX エラーコードが原因でタスクが失敗し、実行フェーズまで到達しなかった試行回数が含まれます。X-CloudTasks-TaskRetryCount ヘッダーを介して入力されます。 |
| retryReason | 文字列 | タスクを再試行する理由。X-CloudTasks-TaskRetryReason ヘッダーを介して入力されます。 |
| scheduledTime | 文字列 | タスクのスケジュール時刻。RFC 3339 文字列（UTC タイムゾーン）で指定します。X-CloudTasks-TaskETA ヘッダーを介して入力されます。これは 1970 年 1 月 1 日からの秒数を使用します。 |
tasks.TaskContext.auth
ODIC トークンのデコードと検証の結果。
署名:
auth?: AuthData;
tasks.TaskContext.executionCount
タスクがハンドラからレスポンスを受け取った合計回数。Cloud Tasks は成功のレスポンスを受け取った時点でタスクを削除するため、それ以前のハンドラからのレスポンスはすべて失敗を意味します。この数値には、5XX エラーコードによる失敗は含まれません。X-CloudTasks-TaskExecutionCount ヘッダーを介して入力されます。
署名:
executionCount: number;
tasks.TaskContext.headers
未加工のリクエスト ヘッダー。
署名:
headers?: Record<string, string>;
tasks.TaskContext.id
タスクの「省略」名。または、作成時に名前が指定されなかった場合は、システムによって生成された一意の ID です。これが「my-task-id」値を完全なタスク名で指定する必要があります（例: task_name = projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id）。X-CloudTasks-TaskName ヘッダーを介して入力されます。
署名:
id: string;
task.TaskContext.previousResponse
前回の再試行の HTTP レスポンス コード。X-CloudTasks-TaskPreviousResponse ヘッダーを介して入力されます。
署名:
previousResponse?: number;
task.TaskContext.queueName
キューの名前です。X-CloudTasks-QueueName ヘッダーを介して入力されます。
署名:
queueName: string;
tasks.TaskContext.retryCount
このタスクが再試行された回数。最初の試行では、この値は 0 になります。この数値には、5XX エラーコードが原因でタスクが失敗し、実行フェーズまで到達しなかった試行回数が含まれます。X-CloudTasks-TaskRetryCount ヘッダーを介して入力されます。
署名:
retryCount: number;
task.TaskContext.retryReason
タスクを再試行する理由。X-CloudTasks-TaskRetryReason ヘッダーを介して入力されます。
署名:
retryReason?: string;
tasks.TaskContext.scheduledTime
タスクのスケジュール時刻。RFC 3339 文字列（UTC タイムゾーン）で指定します。X-CloudTasks-TaskETA ヘッダーを介して入力されます。これは 1970 年 1 月 1 日からの秒数を使用します。
署名:
scheduledTime: string;