Finaliza tareas

En este documento, se supone que comprendes cómo crear y usar tareas. Se proporcionan ejemplos específicos para finalizar las tareas de envío de la siguiente manera:

  • Cerrar una tarea: Si cierras una tarea de envío, su estado cambia a CLOSED y se indica que esa tarea ya no está activa.

  • Establecer el resultado de la tarea: Una vez que se cierra una tarea, se finaliza estableciendo su resultado en SUCCEEDED o FAILED. Esta es una parte importante para finalizar una tarea y mostrar el resultado de la entrega en el uso compartido del recorrido, además de garantizar la facturación correcta del servicio de Fleet Engine.

Cerrar una tarea

Puedes cerrar una tarea de las siguientes maneras:

  • Actualiza el estado de la parada del vehículo. Quita la parada del vehículo, lo que, a su vez, cierra todas las tareas asociadas con la parada. Consulta Actualiza el estado de la parada para obtener más detalles.
  • Quita la tarea de la lista de paradas del vehículo. Esto implica actualizar la lista de tareas de la parada, pero con la tarea cerrada que ya no forma parte de la lista. Consulta Actualiza el orden de las tareas en Actualiza las tareas.
  • Establece el estado de la tarea en CLOSED. Esto solo se puede hacer en tareas que no están asignadas a vehículos. En esta sección, se muestra este enfoque.

Una vez que cierres una tarea, no podrás volver a abrirla.

El cierre de una tarea no indica su éxito o falla. Indica que la tarea ya no se considera en curso. Para indicar el resultado real de una tarea y que se muestre para el seguimiento de la flota y el uso compartido del recorrido, debes indicar el resultado real de una tarea. Consulta Establece el resultado de la tarea a continuación.

Campos de tareas para cerrar tareas

En esta sección, se documentan los campos obligatorios que se deben establecer cuando se cierra una tarea. Fleet Engine ignora todos los demás campos de la entidad para la actualización.

Campo obligatorio Valor
state State.CLOSED

Cierra una tarea directamente

En los siguientes ejemplos, se muestra cómo establecer una tarea no asignada en un estado cerrado, ya sea en gRPC o con una llamada de solicitud HTTP REST a 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> es un identificador único de la tarea.
  • El encabezado de la solicitud debe contener un campo Authorization con el valor Bearer <token>, en el que <token> lo emite tu servidor según los lineamientos que se describen en Roles de cuentas de servicio y tokens web JSON.
  • Debes incluir una entidad Task en el cuerpo de la solicitud.

Ejemplo de comando curl:

 # 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

Establece el resultado de la tarea

Para indicar el resultado real de una tarea, debes establecer el resultado de las tareas cerradas en SUCCEEDED o FAILED. Una tarea debe cerrarse antes de que establezcas su resultado. Fleet Engine solo cobra por las tareas de entrega con un estado de SUCCEEDED.

Detalles del resultado de la tarea

Las tareas también proporcionan detalles adicionales sobre el resultado de la tarea. Puedes configurarlos directamente y Fleet Engine respeta tu configuración:

  • Ubicación del resultado de la tarea: Fleet Engine completa automáticamente la ubicación del resultado de la tarea con la última ubicación conocida del vehículo. Puedes proporcionar esta información si lo prefieres.
  • Hora del resultado de la tarea: Fleet Engine no completa este campo, pero está disponible para que lo configures.

Puedes usar cualquiera de los siguientes enfoques para configurar task_outcome_location y task_outcome_time:

  • Actualízalos en la misma solicitud que establece el resultado de la tarea.
  • Actualízalos más tarde, después de establecer el resultado de la tarea.
  • Vuelve a modificarlos después de que se hayan establecido.

Fleet Engine impide las siguientes actualizaciones relacionadas con los resultados de las tareas:

  • No puedes modificar el resultado de una tarea una vez que se establece en SUCCEEDED o FAILED.
  • No puedes establecer una ubicación ni una hora del resultado de la tarea para las tareas sin un resultado establecido.

Campos de tareas para establecer el resultado

En esta sección, se documentan los campos obligatorios y opcionales que se deben establecer cuando se establece el resultado de una tarea. Fleet Engine ignora otros campos de la entidad para la actualización.

Campo obligatorio Valor
taskOutcome Outcome.SUCCEEDED o Outcome.FAILED

Campo opcionalValor
taskOutcomeLocation Es la ubicación en la que se completó la tarea. Si no se establece, Fleet Engine establece de forma predeterminada la última ubicación del vehículo.
taskOutcomeTime Es la marca de tiempo en la que se completó la tarea.

Ejemplos de resultados de tareas

En el siguiente ejemplo, se muestra cómo usar la biblioteca Java gRPC y una llamada HTTP REST a UpdateTask para establecer el resultado de una tarea en SUCCEEDED y establecer la ubicación en la que se completó la tarea.

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> es un identificador único de la tarea.
  • El encabezado de la solicitud debe contener un campo Authorization con el valor Bearer <token>, en el que <token> lo emite tu servidor según los lineamientos que se describen en Roles de cuentas de servicio y tokens web JSON.
  • El cuerpo de la solicitud debe contener una entidad 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

¿Qué sigue?