本文档假定您了解如何创建和使用任务。它提供 具体说明如下:
关闭任务:关闭配送任务会将其状态更改为
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> 是任务的唯一标识符。
- 请求标头必须包含字段 Authorization(值为 Bearer <token>,其中 <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 自动填充任务 将结果位置与最近一次的已知车辆位置相关联。您可以提供 。
- 任务结果时间:Fleet Engine 不会填充此字段,但为 供您设置
您可以使用以下任一方法来设置 task_outcome_location
和 task_outcome_time
:
- 在设置任务结果的同一请求中更新它们。
- 在设置任务结果后,稍后更新这些信息。
- 完成设置后,请再次修改。
Fleet Engine 会阻止与任务结果相关的以下更新:
- 任务结果一旦设置为为
SUCCEEDED
或FAILED
。 - 对于未设置结果的任务,您无法设置任务结果地点或结果时间。
用于设置结果的任务字段
本部分介绍了设置 任务结果。Fleet Engine 会忽略实体中的其他字段进行更新。
必需字段 | 值 |
---|---|
taskOutcome |
Outcome.SUCCEEDED 或 Outcome.FAILED |
选填字段 | 值 |
---|---|
taskOutcomeLocation |
完成任务的位置。如果未设置,Fleet Engine 默认为最近一次使用车辆的位置。 |
taskOutcomeTime |
任务完成时的时间戳。 |
任务结果示例
以下示例展示了如何使用 Java gRPC 库和 HTTP
对 UpdateTask
进行 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> 是任务的唯一标识符。
- 请求标头必须包含字段 Authorization(值为 Bearer <token>,其中 <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