Esta página foi traduzida pela API Cloud Translation.

Finalizar tarefas

Este documento pressupõe que você já sabe como criar e usar tarefas. Ele fornece exemplos específicos de como finalizar tarefas de envio da seguinte maneira:

Fechar uma tarefa: o fechamento de uma tarefa de frete muda o estado para CLOSED e indica que essa tarefa não está mais ativa.
Definir o resultado da tarefa: quando uma tarefa é fechada, você a finaliza definindo o resultado como SUCCEEDED ou FAILED. Essa é uma parte importante da finalização de uma tarefa para mostrar o resultado da entrega no compartilhamento de jornadas e garantir o faturamento correto do serviço do Fleet Engine.

Fechar uma tarefa

É possível fechar uma tarefa das seguintes maneiras:

Atualizar o status da parada do veículo. Você remove a parada do veículo, o que, por sua vez, encerra todas as tarefas associadas a ela. Consulte Atualizar o status de parada para detalhes.
Remover a tarefa da lista de paradas de veículos. Isso envolve atualizar a lista de tarefas da parada, mas com a tarefa fechada não mais fazendo parte da lista. Consulte a ordem de atualização de tarefas em Atualizar tarefas.
Defina o estado da tarefa como CLOSED. Isso só pode ser feito em tarefas não atribuídas a veículos. Esta seção mostra essa abordagem.

Depois de fechar uma tarefa, não é possível reabri-la.

O fechamento de uma tarefa não indica o sucesso ou a falha dela. Ele indica que a tarefa não é mais considerada em andamento. Para indicar o resultado real de uma tarefa e mostrá-lo para fins de rastreamento de frota e compartilhamento de jornadas, é preciso indicar o resultado real de uma tarefa. Consulte Definir o resultado da tarefa abaixo.

Campos de tarefas para tarefas fechadas

Esta seção documenta os campos obrigatórios a serem definidos ao fechar uma tarefa. O mecanismo de frota ignora todos os outros campos na entidade para a atualização.

Campo obrigatório	Valor
`state`	`State.CLOSED`

Fechar uma tarefa diretamente

Os exemplos a seguir mostram como definir uma tarefa não atribuída para um estado fechado, no gRPC ou usando uma chamada de solicitação REST HTTP para UpdateTask.

gRPC

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TASK_ID = "task-8241890";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task settings
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 Task task = Task.newBuilder()
   .setName(taskName)
   .setState(Task.State.CLOSED) // You can only directly CLOSE a
   .build();                    // task that is NOT assigned to a vehicle.

 // Task request
 UpdateTaskRequest updateTaskRequest =
   UpdateTaskRequest.newBuilder()  // No need for the header
       .setTask(task)
       .setUpdateMask(FieldMask.newBuilder().addPaths("state"))
       .build();

 try {
   Task updatedTask = deliveryService.updateTask(updateTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;
      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=state

<id> é um identificador exclusivo da tarefa.
O cabeçalho da solicitação precisa conter um campo Autorização com o valor Bearer <token>, em que <token> é emitido pelo servidor de acordo com as diretrizes descritas em Papéis da conta de serviço e Tokens JSON Web.
É necessário incluir uma entidade Task no corpo da solicitação.

Comando curl de exemplo:

 # Set JWT, PROJECT_ID, and TASK_ID in the local environment
 curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=state,taskOutcome,taskOutcomeTime" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "state": "CLOSED",
   "taskOutcome": "SUCCEEDED",
   "taskOutcomeTime": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")"
 }
 EOM

Definir o resultado da tarefa

Para indicar o resultado real de uma tarefa, defina o resultado de tarefas fechadas como SUCCEEDED ou FAILED. Uma tarefa precisa ser fechada antes de definir o resultado dela. O Fleet Engine só cobra por tarefas de entrega com um estado de SUCCEEDED.

Detalhes do resultado da tarefa

As tarefas também fornecem mais detalhes sobre o resultado da tarefa. É possível defini-las diretamente, e o Fleet Engine respeitará suas configurações:

Local do resultado da tarefa: o Fleet Engine preenche automaticamente o local de saída da tarefa com a última localização conhecida do veículo. Se preferir, você pode fornecer essa informação.
Tempo de conclusão da tarefa: o Fleet Engine não preenche esse campo, mas ele está disponível para você definir.

É possível usar qualquer uma das abordagens abaixo para definir task_outcome_location e task_outcome_time:

Atualize-as na mesma solicitação que define o resultado da tarefa.
Atualize-as mais tarde, depois de definir o resultado da tarefa.
Modifique-os novamente depois de definidos.

O Fleet Engine impede as seguintes atualizações relacionadas aos resultados da tarefa:

Não é possível modificar o resultado de uma tarefa depois que ela é definida como SUCCEEDED ou FAILED.
Não é possível definir um local ou horário de resultado da tarefa para tarefas sem um resultado definido.

Campos de tarefa para definir o resultado

Nesta seção, documentamos os campos obrigatórios e opcionais a serem definidos ao definir o resultado de uma tarefa. O Fleet Engine ignora outros campos na entidade da atualização.

Campo obrigatório	Valor
`taskOutcome`	`Outcome.SUCCEEDED` ou `Outcome.FAILED`

Campo opcional	Valor
`taskOutcomeLocation`	O local em que a tarefa foi concluída. Se não for definido, o Fleet Engine vai usar o último local do veículo.
`taskOutcomeTime`	O carimbo de data/hora em que a tarefa foi concluída.

Exemplos de resultados de tarefas

O exemplo a seguir mostra como usar a biblioteca Java gRPC e uma chamada REST HTTP para UpdateTask a fim de definir um resultado de tarefa como SUCCEEDED e definir o local em que a tarefa foi concluída.

gRPC

 static final String PROJECT_ID = "my-delivery-co-gcp-project";
 static final String TASK_ID = "task-8241890";

 DeliveryServiceBlockingStub deliveryService =
   DeliveryServiceGrpc.newBlockingStub(channel);

 // Task settings
 String taskName = "providers/" + PROJECT_ID + "/tasks/" + TASK_ID;
 Task task = Task.newBuilder()
   .setName(taskName)
   .setTaskOutcome(TaskOutcome.SUCCEEDED)
   .setTaskOutcomeTime(now())
   .setTaskOutcomeLocation(               // Grand Indonesia East Mall
     LocationInfo.newBuilder().setPoint(
       LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
   .build();

 // Task request
 UpdateTaskRequest updateTaskRequest =
   UpdateTaskRequest.newBuilder()  // No need for the header
       .setTask(task)
       .setUpdateMask(FieldMask.newBuilder().addPaths("task_outcome", "task_outcome_time", "task_outcome_location"))
       .build();

 try {
   Task updatedTask = deliveryService.updateTask(updateTaskRequest);
 } catch (StatusRuntimeException e) {
   Status s = e.getStatus();
   switch (s.getCode()) {
      case NOT_FOUND:
        break;
      case PERMISSION_DENIED:
        break;
   }
   return;
 }

REST

PATCH https://fleetengine.googleapis.com/v1/providers/<project_id>/tasks/<id>?updateMask=taskOutcome,taskOutcomeTime,taskOutcomeLocation

<id> é um identificador exclusivo da tarefa.
O cabeçalho da solicitação precisa conter um campo Autorização com o valor Bearer <token>, em que <token> é emitido pelo servidor de acordo com as diretrizes descritas em Papéis da conta de serviço e Tokens JSON Web.
O corpo da solicitação precisa conter uma entidade Task.

 # Set JWT, PROJECT_ID, and TASK_ID in the local environment
 curl -X PATCH "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/tasks/${TASK_ID}?updateMask=taskOutcome,taskOutcomeTime,taskOutcomeLocation" \
   -H "Content-type: application/json" \
   -H "Authorization: Bearer ${JWT}" \
   --data-binary @- << EOM
 {
   "taskOutcome": "SUCCEEDED",
   "taskOutcomeTime": "$(date -u +"%Y-%m-%dT%H:%M:%SZ")",
   "taskOutcomeLocation": {
     "point": {
       "latitude": -6.195139,
       "longitude": 106.820826
     }
   }
 }
 EOM

A seguir

Encontrar tarefas