tasks.TaskContext interface

Metadados sobre uma chamada para uma função da fila de tarefas.

Assinatura:

export interface TaskContext 

Propriedades

Propriedade Tipo Descrição
autenticação DadosdoAuth O resultado da decodificação e verificação de um token ODIC.
executionCount number O número total de vezes em que a tarefa recebeu uma resposta do gerenciador. Como o Cloud Tasks exclui a tarefa depois que uma resposta bem-sucedida foi recebida, todas as respostas anteriores do gerenciador falharam. Esse número não inclui falhas devido a códigos de erro 5XX. Preenchido pelo cabeçalho X-CloudTasks-TaskExecutionCount.
headers Record<string, string> Cabeçalhos brutos de solicitação.
id string O nome abreviado da tarefa ou, se nenhum nome foi especificado na criação, um código exclusivo gerado pelo sistema. Esse é o "my-task-id" no nome completo da tarefa, como "task_name = projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id". Preenchido pelo cabeçalho X-CloudTasks-TaskName.
previousResponse (link em inglês) number O código de resposta HTTP da tentativa anterior. Preenchido pelo cabeçalho X-CloudTasks-TaskPreviousResponse
queueName string O nome da fila. Preenchido pelo cabeçalho X-CloudTasks-QueueName.
retryCount (em inglês) number O número de novas tentativas para a tarefa. Para a primeira tentativa, esse valor é 0. Esse número inclui tentativas em que a tarefa falhou devido a códigos de erro 5XX e nunca chegou à fase de execução. Preenchido pelo cabeçalho X-CloudTasks-TaskRetryCount.
retryReason (em inglês) string O motivo para tentar novamente a tarefa. Preenchido pelo cabeçalho X-CloudTasks-TaskRetryReason.
ScheduledTime (em inglês) string O horário de agendamento da tarefa, como uma string RFC 3339 no fuso horário UTC. Preenchido pelo cabeçalho X-CloudTasks-TaskETA, que usa segundos desde 1o de janeiro de 1970.

tarefas.TaskContext.auth

O resultado da decodificação e verificação de um token ODIC.

Assinatura:

auth?: AuthData;

tarefas.TaskContext.executionCount

O número total de vezes em que a tarefa recebeu uma resposta do gerenciador. Como o Cloud Tasks exclui a tarefa depois que uma resposta bem-sucedida foi recebida, todas as respostas anteriores do gerenciador falharam. Esse número não inclui falhas devido a códigos de erro 5XX. Preenchido pelo cabeçalho X-CloudTasks-TaskExecutionCount.

Assinatura:

executionCount: number;

tarefas.TaskContext.headers

Cabeçalhos brutos de solicitação.

Assinatura:

headers?: Record<string, string>;

tasks.TaskContext.id

O nome abreviado da tarefa ou, se nenhum nome foi especificado na criação, um código exclusivo gerado pelo sistema. Esse é o "my-task-id" no nome completo da tarefa, como "task_name = projects/my-project-id/locations/my-location/queues/my-queue-id/tasks/my-task-id". Preenchido pelo cabeçalho X-CloudTasks-TaskName.

Assinatura:

id: string;

tarefas.TaskContext.previousResponse

O código de resposta HTTP da tentativa anterior. Preenchido pelo cabeçalho X-CloudTasks-TaskPreviousResponse

Assinatura:

previousResponse?: number;

tarefas.TaskContext.queueName

O nome da fila. Preenchido pelo cabeçalho X-CloudTasks-QueueName.

Assinatura:

queueName: string;

tarefas.TaskContext.retryCount

O número de novas tentativas para a tarefa. Para a primeira tentativa, esse valor é 0. Esse número inclui tentativas em que a tarefa falhou devido a códigos de erro 5XX e nunca chegou à fase de execução. Preenchido pelo cabeçalho X-CloudTasks-TaskRetryCount.

Assinatura:

retryCount: number;

tarefas.TaskContext.retryReason

O motivo para tentar novamente a tarefa. Preenchido pelo cabeçalho X-CloudTasks-TaskRetryReason.

Assinatura:

retryReason?: string;

tarefas.TaskContext.scheduledTime

O horário de agendamento da tarefa, como uma string RFC 3339 no fuso horário UTC. Preenchido pelo cabeçalho X-CloudTasks-TaskETA, que usa segundos desde 1o de janeiro de 1970.

Assinatura:

scheduledTime: string;