Class Trip

Trip metadata.

Inheritance

object

Trip

Implements

IMessage<Trip>

IEquatable<Trip>

IDeepCloneable<Trip>

IBufferMessage

IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace: Google.Maps.FleetEngine.V1

Assembly: Google.Maps.FleetEngine.V1.dll

Syntax

public sealed class Trip : IMessage<Trip>, IEquatable<Trip>, IDeepCloneable<Trip>, IBufferMessage, IMessage

Constructors

Trip()

Declaration

public Trip()

Trip(Trip)

Declaration

public Trip(Trip other)

Parameters

Type	Name	Description
Trip	other

Properties

ActualDropoffPoint

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.

Declaration

public StopLocation ActualDropoffPoint { get; set; }

Property Value

Type	Description
StopLocation

ActualIntermediateDestinationArrivalPoints

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.

Declaration

public RepeatedField<StopLocation> ActualIntermediateDestinationArrivalPoints { get; }

Property Value

Type	Description
RepeatedField<StopLocation>

ActualIntermediateDestinations

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.

Declaration

public RepeatedField<StopLocation> ActualIntermediateDestinations { get; }

Property Value

Type	Description
RepeatedField<StopLocation>

ActualPickupArrivalPoint

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.

Declaration

public StopLocation ActualPickupArrivalPoint { get; set; }

Property Value

Type	Description
StopLocation

ActualPickupPoint

Input only. The actual location when and where customer was picked up. This field is for provider to provide feedback on actual pickup information.

Declaration

public StopLocation ActualPickupPoint { get; set; }

Property Value

Type	Description
StopLocation

CurrentRouteSegment

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.

Declaration

public string CurrentRouteSegment { get; set; }

Property Value

Type	Description
string

CurrentRouteSegmentEndPoint

Output only. The waypoint where current_route_segment ends.

Declaration

public TripWaypoint CurrentRouteSegmentEndPoint { get; set; }

Property Value

Type	Description
TripWaypoint

CurrentRouteSegmentTraffic

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.

Declaration

public ConsumableTrafficPolyline CurrentRouteSegmentTraffic { get; set; }

Property Value

Type	Description
ConsumableTrafficPolyline

CurrentRouteSegmentTrafficVersion

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.

Declaration

public Timestamp CurrentRouteSegmentTrafficVersion { get; set; }

Property Value

Type	Description
Timestamp

CurrentRouteSegmentVersion

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.

Declaration

public Timestamp CurrentRouteSegmentVersion { get; set; }

Property Value

Type	Description
Timestamp

DropoffPoint

Location where customer indicates they will be dropped off.

Declaration

public TerminalLocation DropoffPoint { get; set; }

Property Value

Type	Description
TerminalLocation

DropoffTime

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.

Declaration

public Timestamp DropoffTime { get; set; }

Property Value

Type	Description
Timestamp

EtaToFirstWaypoint

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).

Declaration

public Timestamp EtaToFirstWaypoint { get; set; }

Property Value

Type	Description
Timestamp

IntermediateDestinationIndex

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.

Declaration

public int IntermediateDestinationIndex { get; set; }

Property Value

Type	Description
int

IntermediateDestinations

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

Declaration

public RepeatedField<TerminalLocation> IntermediateDestinations { get; }

Property Value

Type	Description
RepeatedField<TerminalLocation>

IntermediateDestinationsVersion

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.

Declaration

public Timestamp IntermediateDestinationsVersion { get; set; }

Property Value

Type	Description
Timestamp

LastLocation

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

Declaration

public VehicleLocation LastLocation { get; set; }

Property Value

Type	Description
VehicleLocation

LastLocationSnappable

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.

Declaration

public bool LastLocationSnappable { get; set; }

Property Value

Type	Description
bool

Name

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

Declaration

public string Name { get; set; }

Property Value

Type	Description
string

NumberOfPassengers

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.

Declaration

public int NumberOfPassengers { get; set; }

Property Value

Type	Description
int

PickupPoint

Location where customer indicates they will be picked up.

Declaration

public TerminalLocation PickupPoint { get; set; }

Property Value

Type	Description
TerminalLocation

PickupTime

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

Declaration

public Timestamp PickupTime { get; set; }

Property Value

Type	Description
Timestamp

RemainingDistanceMeters

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.

Declaration

public int? RemainingDistanceMeters { get; set; }

Property Value

Type	Description
int?

RemainingTimeToFirstWaypoint

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).

Declaration

public Duration RemainingTimeToFirstWaypoint { get; set; }

Property Value

Type	Description
Duration

RemainingWaypoints

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

Declaration

public RepeatedField<TripWaypoint> RemainingWaypoints { get; }

Property Value

Type	Description
RepeatedField<TripWaypoint>

RemainingWaypointsRouteVersion

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.

Declaration

public Timestamp RemainingWaypointsRouteVersion { get; set; }

Property Value

Type	Description
Timestamp

RemainingWaypointsVersion

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

Declaration

public Timestamp RemainingWaypointsVersion { get; set; }

Property Value

Type	Description
Timestamp

Route

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.

Declaration

public RepeatedField<LatLng> Route { get; }

Property Value

Type	Description
RepeatedField<LatLng>

TripName

TripName-typed view over the Name resource name property.

Declaration

public TripName TripName { get; set; }

Property Value

Type	Description
TripName

TripStatus

Current status of the trip.

Declaration

public TripStatus TripStatus { get; set; }

Property Value

Type	Description
TripStatus

TripType

The type of the trip.

Declaration

public TripType TripType { get; set; }

Property Value

Type	Description
TripType

VehicleId

ID of the vehicle making this trip.

Declaration

public string VehicleId { get; set; }

Property Value

Type	Description
string

VehicleWaypoints

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.

Declaration

public RepeatedField<TripWaypoint> VehicleWaypoints { get; }

Property Value

Type	Description
RepeatedField<TripWaypoint>

View

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

Declaration

public TripView View { get; set; }

Property Value

Type	Description
TripView