SearchVehiclesLog

{
  "header": {
    object (RequestHeaderLog)
  },
  "pickupPoint": {
    object (TerminalLocationLog)
  },
  "dropoffPoint": {
    object (TerminalLocationLog)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "searchTripTypes": [
    enum (TripTypeLog)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleTypeLog)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttributeLog)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeListLog)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeListLog)
    }
  ],
  "matchOrderBy": enum (VehicleMatchOrderLog),
  "includeBackToBack": boolean,
  "tripId": string,
  "filter": string
}

object (RequestHeaderLog)

Request header.

object (TerminalLocationLog)

The pickup point to search near.

object (TerminalLocationLog)

The customer's intended dropoff location.

integer

Specifies the vehicle search radius around the pickup point.

integer

Specifies the maximum number of vehicles to return.

integer

Specifies the required minimum capacity of the vehicle.

enum (TripTypeLog)

Restricts the search to only those vehicles that support at least one of the specified trip types.

string (Duration format)

Restricts the search to only those vehicles that have updated their locations within the specified duration back from now.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

object (VehicleTypeLog)

The types of vehicle searching for.

object (VehicleAttributeLog)

Restricts the search to only those vehicles with the specified attributes.

object (VehicleAttributeListLog)

Restricts the search to only those vehicles with at least one of the specified attributes applied to each VehicleAttributeList.

object (VehicleAttributeListLog)

Restricts the search to only those vehicles with at least one set of the specified attributes in the VehicleAttributeList.

enum (VehicleMatchOrderLog)

Sort order of the search result.

boolean

Indicates if a vehicle with an active trip is eligible for another match.

string

ID of the trip associated with the searchVehiclesRequest.

string

An AIP-160 query that limits vehicles returned based on vehicle attributes.

{
  "attributes": [
    {
      object (VehicleAttributeLog)
    }
  ]
}

object (VehicleAttributeLog)

A list of attributes in this collection.

{
  "matchIds": [
    string
  ],
  "matches": [
    {
      object (VehicleMatchLog)
    }
  ]
}

string

Deprecated: List of the vehicle IDs for the returned vehicles. Please use matches.vehicle.name to derive this ID.

object (VehicleMatchLog)

List of VehicleMatches for the returned vehicles.

{
  "vehicle": {
    object (VehicleLog)
  },
  "vehiclePickupEta": string,
  "vehiclePickupDistanceMeters": integer,
  "vehiclePickupStraightLineDistanceMeters": integer,
  "vehicleDropoffEta": string,
  "vehiclePickupToDropoffDistanceMeters": integer,
  "tripType": enum (TripTypeLog),
  "vehicleMatchType": enum (VehicleMatchTypeLog),
  "requestedOrderedBy": enum (VehicleMatchOrderLog),
  "orderedBy": enum (VehicleMatchOrderLog)
}

object (VehicleLog)

A vehicle that matches the request.

string (Timestamp format)

The vehicle's driving ETA to the pickup point specified in the request. An empty value indicates a failure in calculating ETA for the vehicle.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

integer

The vehicle's driving distance to the pickup point specified in the request, including any intermediate pickup or dropoff points for an existing ride. An empty value indicates a failure in calculating distance for the vehicle.

integer

The straight-line distance between the vehicle and the pickup point specified in the request, including intermediate waypoints for existing trips.

string (Timestamp format)

The complete vehicle's driving ETA to the drop off point specified in the request. The ETA includes any required visits for active trips that must be completed before the vehicle arrives at the dropoff point specified in the request. The value will only be populated when a dropoff point is specified in the request. An empty value indicates a failure in calculating the ETA for the vehicle to reach the dropoff point.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

integer

The vehicle's driving distance (in meters) from the pickup point to the dropoff point specified in the request. The distance is only between the two points and does not include the vehicle location or any other waypoints before the vehicle arrives at the pickup point or dropoff point. The value will only be populated when a dropoff point is specified in the request. An empty value indicates a failure in calculating the distance from the pickup to dropoff points specified in the request.

enum (TripTypeLog)

The trip type of the request that was used to calculate the ETA to the pickup point.

enum (VehicleMatchTypeLog)

Type of the vehicle match.

enum (VehicleMatchOrderLog)

The method the caller requested for sorting vehicle matches.

enum (VehicleMatchOrderLog)

The actual method that is used to order this vehicle. Normally, this will match the 'order_by' field from the request. However, in certain circumstances such as a failure of Google Maps backends, a different method may be used (such as PICKUP_POINT_STRAIGHT_DISTANCE).