このドキュメントでは、旅行を更新してその状態を管理する方法について説明します。これには、フィールド マスクを使用して旅行に関連するフィールドを設定します。このサイトの説明に従って Fleet Engine を設定し、旅行に割り当てられた車両を使用していることを前提としています。
旅行の更新の基本
システムは、次のような場合に Fleet Engine を使用して旅行を更新します。
- 旅行の作成後に車両を割り当てる場合。
- 旅行のステータスが変更された場合(車両が経由地を通過した場合など)。
- 乗客数や降車地点など、旅行のフィールドを更新する場合。
旅行を更新するには、gRPC または REST を使用してリクエストを送信します。
Fleet Engine: サービス アカウントのロールの説明に従って、プロジェクトのサービス アカウントに適切な認証情報を使用します。
旅行のフィールドを更新する
単一の目的地への旅行を作成する の旅行のフィールドで説明されている旅行のフィールドは、どれでも更新できます。たとえば、旅行を作成した後、最初に車両を見つけてから、旅行を実行する車両に関連付けるために旅行の vehicle_id フィールドを更新するのが一般的です。
フィールド マスクを使用する
フィールド マスクは、リクエストが取得または更新するフィールドを API 呼び出し元が一覧表示する方法です。FieldMask を使用すると、不要な作業を回避してパフォーマンスを向上させることができます。Fleet Engine は、すべてのリソースのフィールドを更新するためにフィールド マスクを使用します。
車両 ID で旅行を更新する
Fleet Engine がルートに沿って車両を追跡できるように、車両 ID を使用して旅行を構成する必要があります。次のコードサンプルは、車両 ID で旅行を更新する方法を示しています。
static final String PROJECT_ID = "my-rideshare-co-gcp-project";
static final String TRIP_ID = "trip-8241890";
String tripName = "providers/" + PROJECT_ID + "/trips/" + TRIP_ID;
TripServiceBlockingStub tripService = TripService.newBlockingStub(channel);
// The trip settings to update.
Trip trip = Trip.newBuilder()
.setVehicleId("8241890")
.build();
// The trip update request.
UpdateTripRequest updateTripRequest =
UpdateTripRequest.newBuilder() // No need for the header.
.setName(tripName)
.setTrip(trip)
.setUpdateMask(FieldMask.newBuilder().addPaths("vehicle_id"))
.build();
// Error handling.
// If the Fleet Engine has both a trip and vehicle with IDs, and if the
// credentials validate, then the service updates the trip.
try {
Trip updatedTrip = tripService.updateTrip(updateTripRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND: // Neither the trip nor vehicle exist.
break;
case PERMISSION_DENIED:
break;
}
return;
}
旅行の状態を管理する
旅行の状態は、TripStatus 列挙
値のいずれかを使用して指定します。旅行の状態が変更された場合(ENROUTE_TO_PICKUP から ARRIVED_AT_PICKUP に変更された場合など)、Fleet Engine で旅行の状態を更新します。旅行のライフサイクルは常に NEW の状態値で始まり、COMPLETE または CANCELED の値で終わります。
旅行の更新の例
次の例は、Fleet Engine で連続する旅行の旅行の状態を更新する方法を示しています。
static final String PROJECT_ID = "my-rideshare-co-gcp-project";
static final String TRIP_ID = "trip-8241890";
String tripName = "providers/" + PROJECT_ID + "/trips/" + TRIP_ID;
TripServiceBlockingStub tripService = TripService.newBlockingStub(channel);
// Trip settings to be updated.
Trip trip = Trip.newBuilder()
.setTripStatus(TripStatus.ARRIVED_AT_PICKUP)
.build();
// Trip update request
UpdateTripRequest updateTripRequest = UpdateTripRequest.newBuilder()
.setName(tripName)
.setTrip(trip)
.setUpdateMask(FieldMask.newBuilder().addPaths("trip_status"))
.build();
// Error handling.
try {
Trip updatedTrip = tripService.updateTrip(updateTripRequest);
} catch (StatusRuntimeException e) {
Status s = e.getStatus();
switch (s.getCode()) {
case NOT_FOUND: // The trip doesn't exist.
break;
case FAILED_PRECONDITION: // The given trip status is invalid.
break;
case PERMISSION_DENIED:
break;
}
return;
}
旅行を更新する方法の他の例については、その他の旅行タイプ のセクションをご覧ください。
旅行のエラーを処理する
既存の旅行を更新または検索するときに、DEADLINE_EXCEEDED エラーが発生する場合があります。この場合、Fleet Engine の状態は不明です。これを調査するには、更新またはモニタリングしようとしているのと同じ旅行 ID を使用して、CreateTrip をもう一度呼び出します。201(CREATED)または 409(CONFLICT)が返されます。後者の場合、前のリクエストは DEADLINE_EXCEEDED の前に成功しています。
ネットワーク エラーのリストについては、Android または iOS 用の Consumer SDK をご覧ください。