本文档假定您了解如何创建和使用任务。它提供了有关如何最终确定配送任务的具体示例,如下所示:
关闭任务:关闭配送任务会将其状态更改为
CLOSED
,并表示该任务不再有效。设置任务结果:任务关闭后,您可以将其结果设置为
SUCCEEDED
或FAILED
,以最终确定该任务。这是最终完成任务的一个重要环节,目的是在分享历程中显示交付结果,并确保 Fleet Engine 服务正确结算。
关闭任务
您可以通过以下方式关闭任务:
- 更新车辆的停止状态。您从车辆中移除相应经停点,这会关闭与经停点关联的所有任务。如需了解详情,请参阅更新停止状态。
- 从车辆停靠点列表中移除任务。这涉及更新相应经停点的任务列表,但已关闭的任务不再包含在列表中。请参阅更新任务中的“更新任务顺序”。
- 将任务状态设置为
CLOSED
。此操作只能对未分配给车辆的任务完成。本部分介绍了此方法。
任务一旦关闭,就无法再重新打开。
任务关闭并不表示其成功或失败。它表示任务不再被视为正在进行。为了指示任务的实际结果,并将其用于舰队跟踪和行程共享目的,您必须指明任务的实际结果。请参阅下文的设置任务结果。
用于关闭任务的任务字段
本部分介绍关闭任务时要设置的必填字段。车队引擎会忽略实体中的所有其他字段进行更新。
必需字段 | 值 |
---|---|
state |
State.CLOSED |
直接关闭任务
以下示例展示了如何在 gRPC 中或使用 HTTP REST 请求调用 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> 是任务的唯一标识符。
- 请求标头必须包含值为 Bearer <token> 的 Authorization 字段,其中 <token> 由您的服务器根据服务账号角色和 JSON Web 令牌中所述的准则发出。
- 您必须在请求正文中添加
Task
实体
示例 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
设置任务结果
如需指明任务的实际结果,请将已关闭任务的结果设置为 SUCCEEDED
或 FAILED
。您必须先关闭任务,然后才能设置其结果。Fleet Engine 仅对状态为 SUCCEEDED
的交付任务收费。
任务结果详情
任务还会提供有关任务结果的更多详细信息。您可以直接设置这些参数,Fleet Engine 会遵循您的设置:
- 任务结果位置:车队引擎会自动使用最近一次的已知车辆位置填充任务结果位置。如果您愿意,也可以改为提供此信息。
- 任务结果时间:Fleet Engine 不会填写此字段,但您可以对其进行设置。
您可以使用以下任一方法来设置 task_outcome_location
和 task_outcome_time
:
- 在用于设置任务结果的同一请求中进行更新。
- 在设置任务结果后,稍后更新这些信息。
- 完成设置后,请再次修改。
Fleet Engine 会阻止以下与任务结果相关的更新:
- 任务结果一经设为
SUCCEEDED
或FAILED
,便无法修改。 - 您不能为未设置结果的任务设置任务结果位置或结果时间。
用于设置结果的任务字段
本部分介绍了设置任务结果时需要设置的必填字段和可选字段。Fleet Engine 会忽略实体中的其他字段进行更新。
必需字段 | 值 |
---|---|
taskOutcome |
Outcome.SUCCEEDED 或 Outcome.FAILED |
选填字段 | 值 |
---|---|
taskOutcomeLocation |
完成任务的位置。如果未设置,车队引擎会将其默认为上次车辆位置。 |
taskOutcomeTime |
任务完成时的时间戳。 |
任务结果示例
以下示例展示了如何使用 Java gRPC 库和对 UpdateTask
的 HTTP REST 调用将任务结果设置为 SUCCEEDED
,并设置任务完成的位置。
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> 是任务的唯一标识符。
- 请求标头必须包含一个值为 Bearer <token> 的 Authorization 字段,其中 <token> 由您的服务器根据服务账号角色和 JSON Web 令牌中所述的指南签发。
- 请求正文必须包含
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