On-demand Rides and Deliveries Solution is currently available only to select partners. Contact sales to learn more.

ListVehiclesLog

Stay organized with collections Save and categorize content based on your preferences.

Details on ListVehicles request and response.

JSON representation
{
  "request": {
    object (ListVehiclesRequestLog)
  },
  "response": {
    object (ListVehiclesResponseLog)
  },
  "errorResponse": {
    object (ErrorResponseLog)
  }
}
Fields
request

object (ListVehiclesRequestLog)

The request sent to Fleet Engine.

response

object (ListVehiclesResponseLog)

The response returned to the client. If the RPC call results in an error the response is not set.

errorResponse

object (ErrorResponseLog)

The error response returned to the client. It will be unset if the RPC call succeeded.

ListVehiclesRequestLog

Details on ListVehicles request.

JSON representation
{
  "header": {
    object (RequestHeaderLog)
  },
  "pageSize": integer,
  "pageToken": string,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripTypeLog)
  ],
  "maximumStaleness": string,
  "vehicleTypeCategories": [
    enum (VehicleTypeCategoryLog)
  ],
  "requiredAttributes": [
    string
  ],
  "requiredOneOfAttributes": [
    string
  ],
  "requiredOneOfAttributeSets": [
    string
  ],
  "vehicleState": enum (VehicleStateLog),
  "onTripOnly": boolean
}
Fields
header

object (RequestHeaderLog)

Request header.

pageSize

integer

The maximum number of vehicles to return.

pageToken

string

The value of the next_page_token provided by a previous call to ListVehicles so that you can paginate through groups of vehicles. The value is undefined if the filter criteria of the request is not the same as the filter criteria for the previous call to ListVehicles.

minimumCapacity

integer

Specifies the required minimum capacity of the vehicle. All vehicles returned will have a maximumCapacity greater than or equal to this value. If set, must be greater or equal to 0.

tripTypes[]

enum (TripTypeLog)

Restricts the response to vehicles that support at least one of the specified trip types.

maximumStaleness

string (Duration format)

Restricts the response to vehicles that have updated their locations within the specified duration at the time of the call. If present, must be a valid positive duration.

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

vehicleTypeCategories[]

enum (VehicleTypeCategoryLog)

Restricts the response to vehicles with one of the specified type categories.

requiredAttributes[]

string

Restricts the response to vehicles with the specified attributes.

requiredOneOfAttributes[]

string

Restricts the response to vehicles with at least one of the specified attributes in each VehicleAttributeList.

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets provides additional functionality.

Similar to requiredOneOfAttributes, requiredOneOfAttributeSets uses a message which allows a list of lists.

vehicleState

enum (VehicleStateLog)

Restricts the response to vehicles that have this vehicle state.

onTripOnly

boolean

Only return the vehicles with current trip(s).

ListVehiclesResponseLog

Details on ListVehicles response.

JSON representation
{
  "vehicles": [
    {
      object (VehicleLog)
    }
  ],
  "totalSize": string
}
Fields
vehicles[]

object (VehicleLog)

Vehicles that match the request.

totalSize

string (int64 format)

Total number of vehicles matching the request criteria across all pages.