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 标头填充。
previousResponse 数字 来自上一次重试的 HTTP 响应代码。通过 X-CloudTasks-TaskPreviousResponse 标头填充
queueName 字符串 队列名称。通过 X-CloudTasks-QueueName 标头填充。
retryCount 数字 此任务已经重试的次数。对于第一次尝试,此值为 0。此数字包括任务由于 5XX 错误代码而失败以及从未到达执行阶段的尝试次数。通过 X-CloudTasks-TaskRetryCount 标头填充。
retryReason 字符串 重试任务的原因。通过 X-CloudTasks-TaskRetryReason 标头填充。
scheduledTime 字符串 任务的计划时间,采用世界协调时间 (UTC) 时区的 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;

tasks.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;

Tasks.TaskContext.scheduledTime

任务的计划时间,采用世界协调时间 (UTC) 时区的 RFC 3339 字符串。通过 X-CloudTasks-TaskETA 标头填充,该标头使用自 1970 年 1 月 1 日以来的秒数。

签名

scheduledTime: string;