tasks.TaskContext interface

呼叫工作佇列函式的中繼資料。

簽名:

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 標頭填入。
上一個回應 數字 來自上次重試的 HTTP 回應代碼。透過 X-CloudTasks-TaskPreviousResponse 標頭填入
<佇列名稱> 字串 佇列的名稱。透過 X-CloudTasks-QueueName 標頭填入。
retryCount 數字 這個工作的已重試次數。若為第一次嘗試,這個值會是 0。這個數字包括工作因 5XX 錯誤代碼和從未達到執行階段而失敗的次數。透過 X-CloudTasks-TaskRetryCount 標頭填入。
retryReason 字串 重試工作的原因。透過 X-CloudTasks-TaskRetryReason 標頭填入。
scheduledTime 字串 工作的排程時間,格式為 RFC 3339 字串,世界標準時間。透過 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;

Tasks.TaskContext.previousResponse

來自上次重試的 HTTP 回應代碼。透過 X-CloudTasks-TaskPreviousResponse 標頭填入

簽名:

previousResponse?: number;

項工作.TaskContext.QueueName

佇列的名稱。透過 X-CloudTasks-QueueName 標頭填入。

簽名:

queueName: string;

Tasks.TaskContext.retryCount

這個工作的已重試次數。若為第一次嘗試,這個值會是 0。這個數字包括工作因 5XX 錯誤代碼和從未達到執行階段而失敗的次數。透過 X-CloudTasks-TaskRetryCount 標頭填入。

簽名:

retryCount: number;

Tasks.TaskContext.retryReason

重試工作的原因。透過 X-CloudTasks-TaskRetryReason 標頭填入。

簽名:

retryReason?: string;

項工作.TaskContext.scheduledTime

工作的排程時間,格式為 RFC 3339 字串,世界標準時間。透過 X-CloudTasks-TaskETA 標頭填入,該標頭使用自 1970 年 1 月 1 日以來的秒數。

簽名:

scheduledTime: string;