Google Maps FleetEngine V1 Client - Class Trip (0.1.2)

Reference documentation and code samples for the Google Maps FleetEngine V1 Client class Trip.

Trip metadata.

Generated from protobuf message maps.fleetengine.v1.Trip

Namespace

Google \ Maps \ FleetEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. In the format "providers/{provider}/trips/{trip}"
↳ vehicle_id string

ID of the vehicle making this trip.
↳ trip_status int

Current status of the trip.
↳ trip_type int

The type of the trip.
↳ pickup_point Google\Maps\FleetEngine\V1\TerminalLocation

Location where customer indicates they will be picked up.
↳ actual_pickup_point Google\Maps\FleetEngine\V1\StopLocation

Input only. The actual location when and where customer was picked up. This field is for provider to provide feedback on actual pickup information.
↳ actual_pickup_arrival_point Google\Maps\FleetEngine\V1\StopLocation

Input only. The actual time and location of the driver arrival at the pickup point. This field is for provider to provide feedback on actual arrival information at the pickup point.
↳ pickup_time Google\Protobuf\Timestamp

Output only. Either the estimated future time when the rider(s) will be picked up, or the actual time when they were picked up.
↳ intermediate_destinations array<Google\Maps\FleetEngine\V1\TerminalLocation>

Intermediate stops in order that the trip requests (in addition to pickup and dropoff). Initially this will not be supported for shared trips.
↳ intermediate_destinations_version Google\Protobuf\Timestamp

Indicates the last time the intermediate_destinations was modified. Your server should cache this value and pass it in UpdateTripRequest when update intermediate_destination_index to ensure the intermediate_destinations is not changed.
↳ intermediate_destination_index int

When TripStatus is ENROUTE_TO_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle will cross next. When TripStatus is ARRIVED_AT_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle is at. The provider sets this value. If there are no intermediate_destinations, this field is ignored.
↳ actual_intermediate_destination_arrival_points array<Google\Maps\FleetEngine\V1\StopLocation>

Input only. The actual time and location of the driver's arrival at an intermediate destination. This field is for provider to provide feedback on actual arrival information at intermediate destinations.
↳ actual_intermediate_destinations array<Google\Maps\FleetEngine\V1\StopLocation>

Input only. The actual time and location when and where the customer was picked up from an intermediate destination. This field is for provider to provide feedback on actual pickup information at intermediate destinations.
↳ dropoff_point Google\Maps\FleetEngine\V1\TerminalLocation

Location where customer indicates they will be dropped off.
↳ actual_dropoff_point Google\Maps\FleetEngine\V1\StopLocation

Input only. The actual time and location when and where customer was dropped off. This field is for provider to provide feedback on actual dropoff information.
↳ dropoff_time Google\Protobuf\Timestamp

Output only. Either the estimated future time when the rider(s) will be dropped off at the final destination, or the actual time when they were dropped off.
↳ remaining_waypoints array<Google\Maps\FleetEngine\V1\TripWaypoint>

Output only. The full path from the current location to the dropoff point, inclusive. This path could include waypoints from other trips.
↳ vehicle_waypoints array<Google\Maps\FleetEngine\V1\TripWaypoint>

This field supports manual ordering of the waypoints for the trip. It contains all of the remaining waypoints for the assigned vehicle, as well as the pickup and drop-off waypoints for this trip. If the trip hasn't been assigned to a vehicle, then Fleet Engine ignores this field. For privacy reasons, this field is only populated by the server on UpdateTrip and CreateTrip calls, NOT on GetTrip calls.
↳ route array<Google\Type\LatLng>

Output only. Anticipated route for this trip to the first entry in remaining_waypoints. Note that the first waypoint may belong to a different trip.
↳ current_route_segment string

Output only. An encoded path to the next waypoint. Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.
↳ current_route_segment_version Google\Protobuf\Timestamp

Output only. Indicates the last time the route was modified. Note: This field is intended only for use by the Driver SDK and Consumer SDK.
↳ current_route_segment_traffic Google\Maps\FleetEngine\V1\ConsumableTrafficPolyline

Output only. Indicates the traffic conditions along the current_route_segment when they're available. Note: This field is intended only for use by the Driver SDK and Consumer SDK.
↳ current_route_segment_traffic_version Google\Protobuf\Timestamp

Output only. Indicates the last time the current_route_segment_traffic was modified. Note: This field is intended only for use by the Driver SDK and Consumer SDK.
↳ current_route_segment_end_point Google\Maps\FleetEngine\V1\TripWaypoint

Output only. The waypoint where current_route_segment ends.
↳ remaining_distance_meters Google\Protobuf\Int32Value

Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.
↳ eta_to_first_waypoint Google\Protobuf\Timestamp

Output only. The ETA to the next waypoint (the first entry in the remaining_waypoints field). The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).
↳ remaining_time_to_first_waypoint Google\Protobuf\Duration

Output only. The duration from when the Trip data is returned to the time in Trip.eta_to_first_waypoint. The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).
↳ remaining_waypoints_version Google\Protobuf\Timestamp

Output only. Indicates the last time that remaining_waypoints was changed (a waypoint was added, removed, or changed).
↳ remaining_waypoints_route_version Google\Protobuf\Timestamp

Output only. Indicates the last time the remaining_waypoints.path_to_waypoint and remaining_waypoints.traffic_to_waypoint were modified. Your client app should cache this value and pass it in GetTripRequest to ensure the paths and traffic for remaining_waypoints are only returned if updated.
↳ number_of_passengers int

Immutable. Indicates the number of passengers on this trip and does not include the driver. A vehicle must have available capacity to be returned in a SearchVehicles response.
↳ last_location Google\Maps\FleetEngine\V1\VehicleLocation

Output only. Indicates the last reported location of the vehicle along the route.
↳ last_location_snappable bool

Output only. Indicates whether the vehicle's last_location can be snapped to the current_route_segment. False if last_location or current_route_segment doesn't exist. It is computed by Fleet Engine. Any update from clients will be ignored.
↳ view int

The subset of Trip fields that are populated and how they should be interpreted.

getName

Output only. In the format "providers/{provider}/trips/{trip}"

Returns
Type Description
string

setName

Output only. In the format "providers/{provider}/trips/{trip}"

Parameter
Name Description
var string
Returns
Type Description
$this

getVehicleId

ID of the vehicle making this trip.

Returns
Type Description
string

setVehicleId

ID of the vehicle making this trip.

Parameter
Name Description
var string
Returns
Type Description
$this

getTripStatus

Current status of the trip.

Returns
Type Description
int

setTripStatus

Current status of the trip.

Parameter
Name Description
var int
Returns
Type Description
$this

getTripType

The type of the trip.

Returns
Type Description
int

setTripType

The type of the trip.

Parameter
Name Description
var int
Returns
Type Description
$this

getPickupPoint

Location where customer indicates they will be picked up.

Returns
Type Description
Google\Maps\FleetEngine\V1\TerminalLocation|null

hasPickupPoint

clearPickupPoint

setPickupPoint

Location where customer indicates they will be picked up.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\TerminalLocation
Returns
Type Description
$this

getActualPickupPoint

Input only. The actual location when and where customer was picked up.

This field is for provider to provide feedback on actual pickup information.

Returns
Type Description
Google\Maps\FleetEngine\V1\StopLocation|null

hasActualPickupPoint

clearActualPickupPoint

setActualPickupPoint

Input only. The actual location when and where customer was picked up.

This field is for provider to provide feedback on actual pickup information.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\StopLocation
Returns
Type Description
$this

getActualPickupArrivalPoint

Input only. The actual time and location of the driver arrival at the pickup point.

This field is for provider to provide feedback on actual arrival information at the pickup point.

Returns
Type Description
Google\Maps\FleetEngine\V1\StopLocation|null

hasActualPickupArrivalPoint

clearActualPickupArrivalPoint

setActualPickupArrivalPoint

Input only. The actual time and location of the driver arrival at the pickup point.

This field is for provider to provide feedback on actual arrival information at the pickup point.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\StopLocation
Returns
Type Description
$this

getPickupTime

Output only. Either the estimated future time when the rider(s) will be picked up, or the actual time when they were picked up.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasPickupTime

clearPickupTime

setPickupTime

Output only. Either the estimated future time when the rider(s) will be picked up, or the actual time when they were picked up.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getIntermediateDestinations

Intermediate stops in order that the trip requests (in addition to pickup and dropoff). Initially this will not be supported for shared trips.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIntermediateDestinations

Intermediate stops in order that the trip requests (in addition to pickup and dropoff). Initially this will not be supported for shared trips.

Parameter
Name Description
var array<Google\Maps\FleetEngine\V1\TerminalLocation>
Returns
Type Description
$this

getIntermediateDestinationsVersion

Indicates the last time the intermediate_destinations was modified.

Your server should cache this value and pass it in UpdateTripRequest when update intermediate_destination_index to ensure the intermediate_destinations is not changed.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasIntermediateDestinationsVersion

clearIntermediateDestinationsVersion

setIntermediateDestinationsVersion

Indicates the last time the intermediate_destinations was modified.

Your server should cache this value and pass it in UpdateTripRequest when update intermediate_destination_index to ensure the intermediate_destinations is not changed.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getIntermediateDestinationIndex

When TripStatus is ENROUTE_TO_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle will cross next. When TripStatus is ARRIVED_AT_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle is at. The provider sets this value. If there are no intermediate_destinations, this field is ignored.

Returns
Type Description
int

setIntermediateDestinationIndex

When TripStatus is ENROUTE_TO_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle will cross next. When TripStatus is ARRIVED_AT_INTERMEDIATE_DESTINATION, a number between [0..N-1] indicating which intermediate destination the vehicle is at. The provider sets this value. If there are no intermediate_destinations, this field is ignored.

Parameter
Name Description
var int
Returns
Type Description
$this

getActualIntermediateDestinationArrivalPoints

Input only. The actual time and location of the driver's arrival at an intermediate destination.

This field is for provider to provide feedback on actual arrival information at intermediate destinations.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setActualIntermediateDestinationArrivalPoints

Input only. The actual time and location of the driver's arrival at an intermediate destination.

This field is for provider to provide feedback on actual arrival information at intermediate destinations.

Parameter
Name Description
var array<Google\Maps\FleetEngine\V1\StopLocation>
Returns
Type Description
$this

getActualIntermediateDestinations

Input only. The actual time and location when and where the customer was picked up from an intermediate destination. This field is for provider to provide feedback on actual pickup information at intermediate destinations.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setActualIntermediateDestinations

Input only. The actual time and location when and where the customer was picked up from an intermediate destination. This field is for provider to provide feedback on actual pickup information at intermediate destinations.

Parameter
Name Description
var array<Google\Maps\FleetEngine\V1\StopLocation>
Returns
Type Description
$this

getDropoffPoint

Location where customer indicates they will be dropped off.

Returns
Type Description
Google\Maps\FleetEngine\V1\TerminalLocation|null

hasDropoffPoint

clearDropoffPoint

setDropoffPoint

Location where customer indicates they will be dropped off.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\TerminalLocation
Returns
Type Description
$this

getActualDropoffPoint

Input only. The actual time and location when and where customer was dropped off. This field is for provider to provide feedback on actual dropoff information.

Returns
Type Description
Google\Maps\FleetEngine\V1\StopLocation|null

hasActualDropoffPoint

clearActualDropoffPoint

setActualDropoffPoint

Input only. The actual time and location when and where customer was dropped off. This field is for provider to provide feedback on actual dropoff information.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\StopLocation
Returns
Type Description
$this

getDropoffTime

Output only. Either the estimated future time when the rider(s) will be dropped off at the final destination, or the actual time when they were dropped off.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDropoffTime

clearDropoffTime

setDropoffTime

Output only. Either the estimated future time when the rider(s) will be dropped off at the final destination, or the actual time when they were dropped off.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRemainingWaypoints

Output only. The full path from the current location to the dropoff point, inclusive. This path could include waypoints from other trips.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRemainingWaypoints

Output only. The full path from the current location to the dropoff point, inclusive. This path could include waypoints from other trips.

Parameter
Name Description
var array<Google\Maps\FleetEngine\V1\TripWaypoint>
Returns
Type Description
$this

getVehicleWaypoints

This field supports manual ordering of the waypoints for the trip. It contains all of the remaining waypoints for the assigned vehicle, as well as the pickup and drop-off waypoints for this trip. If the trip hasn't been assigned to a vehicle, then Fleet Engine ignores this field. For privacy reasons, this field is only populated by the server on UpdateTrip and CreateTrip calls, NOT on GetTrip calls.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setVehicleWaypoints

This field supports manual ordering of the waypoints for the trip. It contains all of the remaining waypoints for the assigned vehicle, as well as the pickup and drop-off waypoints for this trip. If the trip hasn't been assigned to a vehicle, then Fleet Engine ignores this field. For privacy reasons, this field is only populated by the server on UpdateTrip and CreateTrip calls, NOT on GetTrip calls.

Parameter
Name Description
var array<Google\Maps\FleetEngine\V1\TripWaypoint>
Returns
Type Description
$this

getRoute

Output only. Anticipated route for this trip to the first entry in remaining_waypoints. Note that the first waypoint may belong to a different trip.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setRoute

Output only. Anticipated route for this trip to the first entry in remaining_waypoints. Note that the first waypoint may belong to a different trip.

Parameter
Name Description
var array<Google\Type\LatLng>
Returns
Type Description
$this

getCurrentRouteSegment

Output only. An encoded path to the next waypoint.

Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.

Returns
Type Description
string

setCurrentRouteSegment

Output only. An encoded path to the next waypoint.

Note: This field is intended only for use by the Driver SDK and Consumer SDK. Decoding is not yet supported.

Parameter
Name Description
var string
Returns
Type Description
$this

getCurrentRouteSegmentVersion

Output only. Indicates the last time the route was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCurrentRouteSegmentVersion

clearCurrentRouteSegmentVersion

setCurrentRouteSegmentVersion

Output only. Indicates the last time the route was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCurrentRouteSegmentTraffic

Output only. Indicates the traffic conditions along the current_route_segment when they're available.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Returns
Type Description
Google\Maps\FleetEngine\V1\ConsumableTrafficPolyline|null

hasCurrentRouteSegmentTraffic

clearCurrentRouteSegmentTraffic

setCurrentRouteSegmentTraffic

Output only. Indicates the traffic conditions along the current_route_segment when they're available.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\ConsumableTrafficPolyline
Returns
Type Description
$this

getCurrentRouteSegmentTrafficVersion

Output only. Indicates the last time the current_route_segment_traffic was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCurrentRouteSegmentTrafficVersion

clearCurrentRouteSegmentTrafficVersion

setCurrentRouteSegmentTrafficVersion

Output only. Indicates the last time the current_route_segment_traffic was modified.

Note: This field is intended only for use by the Driver SDK and Consumer SDK.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getCurrentRouteSegmentEndPoint

Output only. The waypoint where current_route_segment ends.

Returns
Type Description
Google\Maps\FleetEngine\V1\TripWaypoint|null

hasCurrentRouteSegmentEndPoint

clearCurrentRouteSegmentEndPoint

setCurrentRouteSegmentEndPoint

Output only. The waypoint where current_route_segment ends.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\TripWaypoint
Returns
Type Description
$this

getRemainingDistanceMeters

Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.

Returns
Type Description
Google\Protobuf\Int32Value|null

hasRemainingDistanceMeters

clearRemainingDistanceMeters

getRemainingDistanceMetersUnwrapped

Returns the unboxed value from getRemainingDistanceMeters()

Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.

Returns
Type Description
int|null

setRemainingDistanceMeters

Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.

Parameter
Name Description
var Google\Protobuf\Int32Value
Returns
Type Description
$this

setRemainingDistanceMetersUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int32Value object.

Output only. The remaining driving distance in the current_route_segment field. The value is unspecified if the trip is not assigned to a vehicle, or the trip is completed or cancelled.

Parameter
Name Description
var int|null
Returns
Type Description
$this

getEtaToFirstWaypoint

Output only. The ETA to the next waypoint (the first entry in the remaining_waypoints field). The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasEtaToFirstWaypoint

clearEtaToFirstWaypoint

setEtaToFirstWaypoint

Output only. The ETA to the next waypoint (the first entry in the remaining_waypoints field). The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRemainingTimeToFirstWaypoint

Output only. The duration from when the Trip data is returned to the time in Trip.eta_to_first_waypoint. The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Returns
Type Description
Google\Protobuf\Duration|null

hasRemainingTimeToFirstWaypoint

clearRemainingTimeToFirstWaypoint

setRemainingTimeToFirstWaypoint

Output only. The duration from when the Trip data is returned to the time in Trip.eta_to_first_waypoint. The value is unspecified if the trip is not assigned to a vehicle, or the trip is inactive (completed or cancelled).

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getRemainingWaypointsVersion

Output only. Indicates the last time that remaining_waypoints was changed (a waypoint was added, removed, or changed).

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRemainingWaypointsVersion

clearRemainingWaypointsVersion

setRemainingWaypointsVersion

Output only. Indicates the last time that remaining_waypoints was changed (a waypoint was added, removed, or changed).

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getRemainingWaypointsRouteVersion

Output only. Indicates the last time the remaining_waypoints.path_to_waypoint and remaining_waypoints.traffic_to_waypoint were modified. Your client app should cache this value and pass it in GetTripRequest to ensure the paths and traffic for remaining_waypoints are only returned if updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasRemainingWaypointsRouteVersion

clearRemainingWaypointsRouteVersion

setRemainingWaypointsRouteVersion

Output only. Indicates the last time the remaining_waypoints.path_to_waypoint and remaining_waypoints.traffic_to_waypoint were modified. Your client app should cache this value and pass it in GetTripRequest to ensure the paths and traffic for remaining_waypoints are only returned if updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getNumberOfPassengers

Immutable. Indicates the number of passengers on this trip and does not include the driver. A vehicle must have available capacity to be returned in a SearchVehicles response.

Returns
Type Description
int

setNumberOfPassengers

Immutable. Indicates the number of passengers on this trip and does not include the driver. A vehicle must have available capacity to be returned in a SearchVehicles response.

Parameter
Name Description
var int
Returns
Type Description
$this

getLastLocation

Output only. Indicates the last reported location of the vehicle along the route.

Returns
Type Description
Google\Maps\FleetEngine\V1\VehicleLocation|null

hasLastLocation

clearLastLocation

setLastLocation

Output only. Indicates the last reported location of the vehicle along the route.

Parameter
Name Description
var Google\Maps\FleetEngine\V1\VehicleLocation
Returns
Type Description
$this

getLastLocationSnappable

Output only. Indicates whether the vehicle's last_location can be snapped to the current_route_segment. False if last_location or current_route_segment doesn't exist.

It is computed by Fleet Engine. Any update from clients will be ignored.

Returns
Type Description
bool

setLastLocationSnappable

Output only. Indicates whether the vehicle's last_location can be snapped to the current_route_segment. False if last_location or current_route_segment doesn't exist.

It is computed by Fleet Engine. Any update from clients will be ignored.

Parameter
Name Description
var bool
Returns
Type Description
$this

getView

The subset of Trip fields that are populated and how they should be interpreted.

Returns
Type Description
int

setView

The subset of Trip fields that are populated and how they should be interpreted.

Parameter
Name Description
var int
Returns
Type Description
$this