Returns a list of vehicles that match the request options.
HTTP request
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Must be in the format |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "header": { object ( |
Fields | |
---|---|
header |
The standard Fleet Engine request header. |
pickupPoint |
Required. The pickup point to search near. |
dropoffPoint |
The customer's intended dropoff location. The field is required if |
pickupRadiusMeters |
Required. Defines the vehicle search radius around the pickup point. Only vehicles within the search radius will be returned. Value must be between 400 and 10000 meters (inclusive). |
count |
Required. Specifies the maximum number of vehicles to return. The value must be between 1 and 50 (inclusive). |
minimumCapacity |
Required. Specifies the number of passengers being considered for a trip. The value must be greater than or equal to one. The driver is not considered in the capacity value. |
tripTypes[] |
Required. Represents the type of proposed trip. Eligible vehicles are those that can support at least one of the specified trip type.
|
maximumStaleness |
Restricts the search to only those vehicles that have sent location updates to Fleet Engine within the specified duration. Stationary vehicles still transmitting their locations are not considered stale. If this field is not set, the server uses five minutes as the default value. A duration in seconds with up to nine fractional digits, ending with ' |
vehicleTypes[] |
Required. Restricts the search to vehicles with one of the specified types. At least one vehicle type must be specified. VehicleTypes with a category of |
requiredAttributes[] |
Callers can form complex logical operations using any combination of the
Restricts the search to only those vehicles with the specified attributes. This field is a conjunction/AND operation. A max of 50 requiredAttributes is allowed. This matches the maximum number of attributes allowed on a vehicle. |
requiredOneOfAttributes[] |
Restricts the search to only those vehicles with at least one of the specified attributes in each |
requiredOneOfAttributeSets[] |
Similar to
Restricts the search to only those vehicles with all the attributes in a |
orderBy |
Required. Specifies the desired ordering criterion for results. |
includeBackToBack |
Indicates if a vehicle with a single active trip is eligible for another match. If This field is only considered if a single The default value is |
tripId |
Indicates the trip associated with this |
currentTripsPresent |
Restricts vehicles from appearing in the search results based on their current trips. When currentTripsPresent is |
filter |
Optional. A filter query to apply when searching vehicles. See http://aip.dev/160 for examples of the filter syntax. This field is designed to replace the This filter functions as an AND clause with other constraints, such as Note that the only queries supported are on vehicle attributes (for example, Also, all attributes are stored as strings, so the only supported comparisons against attributes are string comparisons. In order to compare against number or boolean values, the values must be explicitly quoted to be treated as strings (for example, |
Response body
If successful, the response body contains an instance of SearchVehiclesResponse
.