ルートの更新と状態の管理

このドキュメントでは、フィールド マスクを使用してルートに関連するフィールドを設定するなど、ルートを更新してその状態を管理する方法について説明します。このサイトの説明に沿って Fleet Engine を設定し、ルートに割り当てられた車両を操作していることを前提としています。

ルート更新情報の基本

システムは、次の状況で Fleet Engine を使用してルートを更新します。

  • 作成後に車両をルートに割り当てる場合。
  • ルートのステータスが変更されたとき(車両がウェイポイントを通過したときなど)。
  • 乗客数や降車場所など、ルートのフィールドを更新する場合。

ルートを更新するには、gRPC または REST を使用してリクエストを送信します。

  • UpdateTrip() メソッド: gRPC または REST
  • UpdateTripRequest メッセージ: gRPC のみ

Fleet Engine: サービス アカウントのロールの説明に沿って、プロジェクトのサービス アカウントに適切な認証情報を使用します。

ルート フィールドを更新する

1 つの目的地のルートを作成するのルート フィールドに記載されているルート フィールドは、すべて更新できます。たとえば、ルートを作成した後、まず車両を検索し、次にルートの 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 の前に成功しています。

Consumer SDK のネットワーク エラーのリスト(Android または iOS)をご覧ください。

次のステップ