Skip to content

Commit 0cb8499

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
docs: clarified wording around route-related fields
PiperOrigin-RevId: 471592585
1 parent e1b54cd commit 0cb8499

3 files changed

Lines changed: 57 additions & 56 deletions

File tree

‎google/maps/fleetengine/v1/fleetengine.proto‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -74,31 +74,31 @@ message TripWaypoint {
7474
// The role this waypoint plays in this trip, such as pickup or dropoff.
7575
WaypointType waypoint_type = 3;
7676

77-
// The path from the previous waypoint to the current waypoint.
77+
// The path from the previous waypoint to the current waypoint. Undefined for
78+
// the first waypoint in a list. This field is only populated when requested.
7879
repeated google.type.LatLng path_to_waypoint = 4;
7980

8081
// The encoded path from the previous waypoint to the current waypoint.
81-
// Decoding is not yet supported.
82+
//
83+
// <p>Note: This field is intended only for use by the Driver SDK and Consumer
84+
// SDK. Decoding is not yet supported.
8285
string encoded_path_to_waypoint = 5;
8386

8487
// The traffic conditions along the path to this waypoint. Note that traffic
8588
// is only available for Google Map Platform Rides and Deliveries Solution
8689
// customers.
8790
ConsumableTrafficPolyline traffic_to_waypoint = 10;
8891

89-
// The path distance from the previous waypoint to the current waypoint. If
90-
// the waypoint is the first waypoint in the list (e.g.,
91-
// `Vehicle.waypoints[0]` or `Trip.remaining_waypoints[0]`), then the value of
92-
// this field is undefined.
92+
// The path distance from the previous waypoint to the current waypoint.
93+
// Undefined for the first waypoint in a list.
9394
google.protobuf.Int32Value distance_meters = 6;
9495

95-
// The estimated time of arrival at this waypoint.
96+
// The estimated time of arrival at this waypoint. Undefined for the first
97+
// waypoint in a list.
9698
google.protobuf.Timestamp eta = 7;
9799

98-
// The travel time from previous waypoint to this point. If the waypoint is
99-
// the first waypoint in the list (e.g., `Vehicle.waypoints[0]` or
100-
// `Trip.remaining_waypoints[0]`), then this value indicates the remaining
101-
// time to the waypoint.
100+
// The travel time from previous waypoint to this point. Undefined for the
101+
// first waypoint in a list.
102102
google.protobuf.Duration duration = 8;
103103
}
104104

‎google/maps/fleetengine/v1/trips.proto‎

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -112,60 +112,62 @@ message Trip {
112112
google.protobuf.Timestamp dropoff_time = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
113113

114114
// Output only. The full path from the current location to the dropoff point, inclusive.
115-
// If this is a shared ride, this path could include waypoints from other
116-
// trips.
115+
// This path could include waypoints from other trips.
117116
repeated TripWaypoint remaining_waypoints = 16 [(google.api.field_behavior) = OUTPUT_ONLY];
118117

119-
// This field supports manual ordering of the waypoints for the trip.
120-
// It contains all of the remaining waypoints of vehicle assigned, as well as
121-
// the pickup and drop-off waypoints for this trip.
122-
// If the trip hasn't been assigned to a vehicle, then this field is ignored.
123-
// For privacy reasons, this field is only populated by the server on
124-
// UpdateTrip and CreateTrip calls, and NOT on GetTrip calls.
118+
// This field supports manual ordering of the waypoints for the trip. It
119+
// contains all of the remaining waypoints for the assigned vehicle, as well
120+
// as the pickup and drop-off waypoints for this trip. If the trip hasn't been
121+
// assigned to a vehicle, then this field is ignored. For privacy reasons,
122+
// this field is only populated by the server on UpdateTrip and CreateTrip
123+
// calls, NOT on GetTrip calls.
125124
repeated TripWaypoint vehicle_waypoints = 20;
126125

127126
// Output only. Anticipated route for this trip to the first entry in remaining_waypoints.
128-
// If back_to_back or shared trips are enabled, the waypoints may belong to a
129-
// different trip.
127+
// Note that the first waypoint may belong to a different trip.
130128
repeated google.type.LatLng route = 9 [(google.api.field_behavior) = OUTPUT_ONLY];
131129

132-
// Output only. An encoded path to the next waypoint. This field facilitates journey
133-
// sharing between a driver app and a rider app. Note: This field is intended
134-
// only for use by the Driver SDK and Consumer SDK.
130+
// Output only. An encoded path to the next waypoint.
131+
//
132+
// Note: This field is intended only for use by the Driver SDK and Consumer
133+
// SDK. Decoding is not yet supported.
135134
string current_route_segment = 21 [(google.api.field_behavior) = OUTPUT_ONLY];
136135

137-
// Output only. Indicates the last time the route was modified. Note: This field is
138-
// intended only for use by the Driver SDK and Consumer SDK.
136+
// Output only. Indicates the last time the route was modified.
137+
//
138+
// Note: This field is intended only for use by the Driver SDK and Consumer
139+
// SDK.
139140
google.protobuf.Timestamp current_route_segment_version = 17 [(google.api.field_behavior) = OUTPUT_ONLY];
140141

141142
// Output only. Indicates the traffic conditions along the `current_route_segment` when
142-
// they're available. Note: This field is intended only for use by the Driver
143-
// SDK and Consumer SDK.
143+
// they're available.
144+
//
145+
// Note: This field is intended only for use by the Driver SDK and Consumer
146+
// SDK.
144147
ConsumableTrafficPolyline current_route_segment_traffic = 28 [(google.api.field_behavior) = OUTPUT_ONLY];
145148

146149
// Output only. Indicates the last time the `current_route_segment_traffic` was modified.
150+
//
147151
// Note: This field is intended only for use by the Driver SDK and Consumer
148152
// SDK.
149153
google.protobuf.Timestamp current_route_segment_traffic_version = 30 [(google.api.field_behavior) = OUTPUT_ONLY];
150154

151155
// Output only. The waypoint where `current_route_segment` ends.
152156
TripWaypoint current_route_segment_end_point = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
153157

154-
// Output only. The remaining driving distance in `current_route_segment` field. This
155-
// field facilitates journey sharing between a driver and rider. The value
156-
// is unspecified if the trip is not assigned to a vehicle or the trip is
157-
// completed or cancelled.
158+
// Output only. The remaining driving distance in the `current_route_segment` field. The
159+
// value is unspecified if the trip is not assigned to a vehicle, or the trip
160+
// is completed or cancelled.
158161
google.protobuf.Int32Value remaining_distance_meters = 12 [(google.api.field_behavior) = OUTPUT_ONLY];
159162

160-
// Output only. The ETA to the next waypoint (the first entry in the
161-
// `remaining_waypoints` field). This field facilitates journey sharing
162-
// between a driver and a consumer. The value is unspecified if the trip is
163-
// not assigned to a vehicle, or the trip is inactive (completed or
164-
// cancelled).
163+
// Output only. The ETA to the next waypoint (the first entry in the `remaining_waypoints`
164+
// field). The value is unspecified if the trip is not assigned to a vehicle,
165+
// or the trip is inactive (completed or cancelled).
165166
google.protobuf.Timestamp eta_to_first_waypoint = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
166167

167168
// Output only. The duration from when the Trip data is returned to the time in
168-
// `Trip.eta_to_first_waypoint`.
169+
// `Trip.eta_to_first_waypoint`. The value is unspecified if the trip is not
170+
// assigned to a vehicle, or the trip is inactive (completed or cancelled).
169171
google.protobuf.Duration remaining_time_to_first_waypoint = 27 [(google.api.field_behavior) = OUTPUT_ONLY];
170172

171173
// Output only. Indicates the last time that `remaining_waypoints` was changed (a

‎google/maps/fleetengine/v1/vehicles.proto‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,9 @@ message Vehicle {
9696
// The polyline specifying the route the driver app intends to take to
9797
// the next waypoint. This list is also returned in
9898
// `Trip.current_route_segment` for all active trips assigned to the vehicle.
99-
// Note: This field is intended only for use by the Driver SDK.
99+
//
100+
// Note: This field is intended only for use by the Driver SDK. Decoding is
101+
// not yet supported.
100102
string current_route_segment = 20;
101103

102104
// Input only. Fleet Engine uses this information to improve Journey Sharing.
@@ -115,31 +117,28 @@ message Vehicle {
115117
// `current_route_segment` is also specified.
116118
TripWaypoint current_route_segment_end_point = 24;
117119

118-
// The remaining driving distance for the `current_route_segment`. This field
119-
// facilitates journey sharing between the Driver app and the Consumer app.
120-
// This value is provided by the Driver SDK. This field is also returned in
121-
// `Trip.remaining_distance_meters` for all active trips assigned to the
122-
// vehicle. The value is unspecified if the `current_route_segment` field is
123-
// empty, or if the Driver SDK has not updated its value.
120+
// The remaining driving distance for the `current_route_segment`.
121+
// This value is also returned in `Trip.remaining_distance_meters` for all
122+
// active trips assigned to the vehicle. The value is unspecified if the
123+
// `current_route_segment` field is empty.
124124
google.protobuf.Int32Value remaining_distance_meters = 18;
125125

126-
// The ETA to the first entry in the `waypoints` field. This field facilitates
127-
// journey sharing between a driver app and a consumer app. The Driver SDK
128-
// provides the value under typical conditions. This field is also returned in
129-
// `Trip.eta_to_first_waypoint` for all applicable trips assigned to the
130-
// vehicle. The value is unspecified if the `waypoints` field is empty.
126+
// The ETA to the first entry in the `waypoints` field. The value is
127+
// unspecified if the `waypoints` field is empty or the
128+
// `Vehicle.current_route_segment` field is empty.
129+
//
130+
// When updating a vehicle, `remaining_time_seconds` takes precedence over
131+
// `eta_to_first_waypoint` in the same request.
131132
google.protobuf.Timestamp eta_to_first_waypoint = 19;
132133

133-
// Input only. The remaining driving time for the `current_route_segment`. This field
134-
// facilitates journey sharing between the Driver app and the Consumer app.
135-
// This value is updated by the Driver SDK. The value is unspecified if the
134+
// Input only. The remaining driving time for the `current_route_segment`. The value is
135+
// unspecified if the `waypoints` field is empty or the
136136
// `Vehicle.current_route_segment` field is empty. This value should match
137137
// `eta_to_first_waypoint` - `current_time` if all parties are using the same
138138
// clock.
139139
//
140-
// <p>When updating a vehicle, if you update both `eta_to_first_waypoint` and
141-
// `remaining_time_seconds` in the same request, `remaining_time_seconds`
142-
// takes precedence.
140+
// When updating a vehicle, `remaining_time_seconds` takes precedence over
141+
// `eta_to_first_waypoint` in the same request.
143142
google.protobuf.Int32Value remaining_time_seconds = 25 [(google.api.field_behavior) = INPUT_ONLY];
144143

145144
// The remaining waypoints assigned to this Vehicle.

0 commit comments

Comments
 (0)