tasks.TaskContext interface

タスクキュー関数の呼び出しに関するメタデータ。

サイン:

export interface TaskContext 

プロパティ

財産タイプ説明
認証認証データODIC トークンをデコードして検証した結果。
実行回数番号タスクがハンドラーから応答を受信した合計回数。 Cloud Tasks は成功の応答を受信するとタスクを削除するため、以前のハンドラーの応答はすべて失敗しました。この数値には、5XX エラー コードによる障害は含まれません。 X-CloudTasks-TaskExecutionCountヘッダーを介して設定されます。
ヘッダーレコード<文字列、文字列>生のリクエストヘッダー。
IDタスクの「短い」名前、または作成時に名前が指定されていない場合は、システムが生成した一意の ID。これは、完全なタスク名の「my-task-id」値です (「task_name = project/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-)」 ID。」 X-CloudTasks-TaskNameヘッダーを介して設定されます。
前の回答番号前回の再試行からの HTTP 応答コード。 X-CloudTasks-TaskPreviousResponseヘッダーを介して設定されます
キュー名キューの名前。 X-CloudTasks-QueueNameヘッダーを介して設定されます。
再試行回数番号このタスクが再試行された回数。最初の試行では、この値は 0 です。この数には、タスクが 5XX エラー コードにより失敗し、実行フェーズに到達しなかった試行も含まれます。 X-CloudTasks-TaskRetryCountヘッダーを介して設定されます。
再試行理由タスクを再試行する理由。 X-CloudTasks-TaskRetryReasonヘッダーを介して設定されます。
予定時刻UTC タイムゾーンの RFC 3339 文字列としてのタスクのスケジュール時刻。 X-CloudTasks-TaskETAヘッダーを介して設定されます。これには、1970 年 1 月 1 日からの秒数が使用されます。

タスク.TaskContext.auth

ODIC トークンをデコードして検証した結果。

サイン:

auth?: AuthData;

task.TaskContext.executionCount

タスクがハンドラーから応答を受信した合計回数。 Cloud Tasks は成功の応答を受信するとタスクを削除するため、以前のハンドラーの応答はすべて失敗しました。この数値には、5XX エラー コードによる障害は含まれません。 X-CloudTasks-TaskExecutionCountヘッダーを介して設定されます。

サイン:

executionCount: number;

タスク.TaskContext.headers

生のリクエストヘッダー。

サイン:

headers?: Record<string, string>;

タスク.TaskContext.id

タスクの「短い」名前、または作成時に名前が指定されていない場合は、システムが生成した一意の ID。これは、完全なタスク名の「my-task-id」値です (「task_name = project/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;

task.TaskContext.retryCount

このタスクが再試行された回数。最初の試行では、この値は 0 です。この数には、タスクが 5XX エラー コードにより失敗し、実行フェーズに到達しなかった試行も含まれます。 X-CloudTasks-TaskRetryCountヘッダーを介して設定されます。

サイン:

retryCount: number;

task.TaskContext.retryReason

タスクを再試行する理由。 X-CloudTasks-TaskRetryReasonヘッダーを介して設定されます。

サイン:

retryReason?: string;

task.TaskContext.scheduledTime

UTC タイムゾーンの RFC 3339 文字列としてのタスクのスケジュール時刻。 X-CloudTasks-TaskETAヘッダーを介して設定されます。これには、1970 年 1 月 1 日からの秒数が使用されます。

サイン:

scheduledTime: string;