Reference documentation and code samples for the Google Maps FleetEngine V1 Client class VehicleMatch.
Contains the vehicle and related estimates for a vehicle that match the
points of active trips for the vehicle SearchVehiclesRequest
.
Generated from protobuf message maps.fleetengine.v1.VehicleMatch
Namespace
Google \ Maps \ FleetEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ vehicle
↳ vehicle_pickup_eta
Google\Protobuf\Timestamp
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. If SearchVehiclesRequest.include_back_to_back
was true
and this vehicle has an active trip, vehicle_pickup_eta
includes the time required to complete the current active trip.
↳ vehicle_pickup_distance_meters
Google\Protobuf\Int32Value
The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance.
↳ vehicle_pickup_straight_line_distance_meters
Google\Protobuf\Int32Value
Required. The straight-line distance between the vehicle and the pickup point specified in the request.
↳ vehicle_dropoff_eta
Google\Protobuf\Timestamp
The complete vehicle's driving ETA to the drop off point specified in the request. The ETA includes stopping at any waypoints before the dropoff_point
specified in the request. The value will only be populated when a drop off point is specified in the request. An empty value indicates an error calculating the ETA.
↳ vehicle_pickup_to_dropoff_distance_meters
Google\Protobuf\Int32Value
The vehicle's driving distance (in meters) from the pickup point to the drop off point specified in the request. The distance is only between the two points and does not include the vehicle location or any other points that must be visited before the vehicle visits either 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 drop off point specified in the request.
↳ trip_type
int
Required. The trip type of the request that was used to calculate the ETA to the pickup point.
↳ vehicle_trips_waypoints
array< Waypoint
>
The ordered list of waypoints used to calculate the ETA. The list includes vehicle location, the pickup points of active trips for the vehicle, and the pickup points provided in the request. An empty list indicates a failure in calculating ETA for the vehicle.
↳ vehicle_match_type
int
Type of the vehicle match.
↳ requested_ordered_by
int
The order requested for sorting vehicle matches. Equivalent to ordered_by
.
↳ ordered_by
int
The order requested for sorting vehicle matches. Equivalent to requested_ordered_by
.
getVehicle
Required. A vehicle that matches the request.
hasVehicle
clearVehicle
setVehicle
Required. A vehicle that matches the request.
$this
getVehiclePickupEta
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. If SearchVehiclesRequest.include_back_to_back
was true
and
this vehicle has an active trip, vehicle_pickup_eta
includes the time
required to complete the current active trip.
hasVehiclePickupEta
clearVehiclePickupEta
setVehiclePickupEta
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. If SearchVehiclesRequest.include_back_to_back
was true
and
this vehicle has an active trip, vehicle_pickup_eta
includes the time
required to complete the current active trip.
$this
getVehiclePickupDistanceMeters
The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance.
hasVehiclePickupDistanceMeters
clearVehiclePickupDistanceMeters
getVehiclePickupDistanceMetersUnwrapped
Returns the unboxed value from getVehiclePickupDistanceMeters()
The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance.
int|null
setVehiclePickupDistanceMeters
The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance.
$this
setVehiclePickupDistanceMetersUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
The distance from the Vehicle's current location to the pickup point specified in the request, including any intermediate pickup or dropoff points for existing trips. This distance comprises the calculated driving (route) distance, plus the straight line distance between the navigation end point and the requested pickup point. (The distance between the navigation end point and the requested pickup point is typically small.) An empty value indicates an error in calculating the distance.
var
int|null
$this
getVehiclePickupStraightLineDistanceMeters
Required. The straight-line distance between the vehicle and the pickup point specified in the request.
hasVehiclePickupStraightLineDistanceMeters
clearVehiclePickupStraightLineDistanceMeters
getVehiclePickupStraightLineDistanceMetersUnwrapped
Returns the unboxed value from getVehiclePickupStraightLineDistanceMeters()
Required. The straight-line distance between the vehicle and the pickup point specified in the request.
int|null
setVehiclePickupStraightLineDistanceMeters
Required. The straight-line distance between the vehicle and the pickup point specified in the request.
$this
setVehiclePickupStraightLineDistanceMetersUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
Required. The straight-line distance between the vehicle and the pickup point specified in the request.
var
int|null
$this
getVehicleDropoffEta
The complete vehicle's driving ETA to the drop off point specified in the
request. The ETA includes stopping at any waypoints before the dropoff_point
specified in the request. The value will only be populated
when a drop off point is specified in the request. An empty value indicates
an error calculating the ETA.
hasVehicleDropoffEta
clearVehicleDropoffEta
setVehicleDropoffEta
The complete vehicle's driving ETA to the drop off point specified in the
request. The ETA includes stopping at any waypoints before the dropoff_point
specified in the request. The value will only be populated
when a drop off point is specified in the request. An empty value indicates
an error calculating the ETA.
$this
getVehiclePickupToDropoffDistanceMeters
The vehicle's driving distance (in meters) from the pickup point
to the drop off point specified in the request. The distance is only
between the two points and does not include the vehicle location or any
other points that must be visited before the vehicle visits either 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
drop off point specified in the request.
hasVehiclePickupToDropoffDistanceMeters
clearVehiclePickupToDropoffDistanceMeters
getVehiclePickupToDropoffDistanceMetersUnwrapped
Returns the unboxed value from getVehiclePickupToDropoffDistanceMeters()
The vehicle's driving distance (in meters) from the pickup point
to the drop off point specified in the request. The distance is only
between the two points and does not include the vehicle location or any
other points that must be visited before the vehicle visits either 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
drop off point specified in the request.
int|null
setVehiclePickupToDropoffDistanceMeters
The vehicle's driving distance (in meters) from the pickup point
to the drop off point specified in the request. The distance is only
between the two points and does not include the vehicle location or any
other points that must be visited before the vehicle visits either 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
drop off point specified in the request.
$this
setVehiclePickupToDropoffDistanceMetersUnwrapped
Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.
The vehicle's driving distance (in meters) from the pickup point
to the drop off point specified in the request. The distance is only
between the two points and does not include the vehicle location or any
other points that must be visited before the vehicle visits either 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
drop off point specified in the request.
var
int|null
$this
getTripType
Required. The trip type of the request that was used to calculate the ETA to the pickup point.
int
setTripType
Required. The trip type of the request that was used to calculate the ETA to the pickup point.
var
int
$this
getVehicleTripsWaypoints
The ordered list of waypoints used to calculate the ETA. The list includes vehicle location, the pickup points of active trips for the vehicle, and the pickup points provided in the request. An empty list indicates a failure in calculating ETA for the vehicle.
setVehicleTripsWaypoints
The ordered list of waypoints used to calculate the ETA. The list includes vehicle location, the pickup points of active trips for the vehicle, and the pickup points provided in the request. An empty list indicates a failure in calculating ETA for the vehicle.
$this
getVehicleMatchType
Type of the vehicle match.
int
setVehicleMatchType
Type of the vehicle match.
var
int
$this
getRequestedOrderedBy
The order requested for sorting vehicle matches. Equivalent to ordered_by
.
int
setRequestedOrderedBy
The order requested for sorting vehicle matches. Equivalent to ordered_by
.
var
int
$this
getOrderedBy
The order requested for sorting vehicle matches. Equivalent to requested_ordered_by
.
int
setOrderedBy
The order requested for sorting vehicle matches. Equivalent to requested_ordered_by
.
var
int
$this
