Skip to content

Commit f7cdb41

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
feat: sync with latest API updates
* Refresh documentation * Messages related to terminal point service were removed * The already deprecated available_capacity field was removed * Route information added to UpdateTrip PiperOrigin-RevId: 417686942
1 parent 489719a commit f7cdb41

9 files changed

Lines changed: 750 additions & 499 deletions

File tree

‎google/maps/fleetengine/v1/BUILD.bazel‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# This file was automatically generated by BuildFileGenerator
22
# https://github.com/googleapis/rules_gapic/tree/master/bazel
3+
34
# Most of the manual changes to this file will be overwritten.
45
# It's **only** allowed to change the following rule attribute values:
56
# - names of *_gapic_assembly_* rules
67
# - certain parameters of *_gapic_library rules, including but not limited to:
78
# * extra_protoc_parameters
89
# * extra_protoc_file_parameters
910
# The complete list of preserved parameters can be found in the source code.
11+
1012
# This is an API workspace, having public visibility by default makes perfect sense.
1113
package(default_visibility = ["//visibility:public"])
1214

@@ -21,6 +23,7 @@ proto_library(
2123
srcs = [
2224
"fleetengine.proto",
2325
"header.proto",
26+
"traffic.proto",
2427
"trip_api.proto",
2528
"trips.proto",
2629
"vehicle_api.proto",
@@ -32,7 +35,6 @@ proto_library(
3235
"//google/api:field_behavior_proto",
3336
"//google/api:resource_proto",
3437
"//google/type:latlng_proto",
35-
"@com_google_protobuf//:any_proto",
3638
"@com_google_protobuf//:duration_proto",
3739
"@com_google_protobuf//:empty_proto",
3840
"@com_google_protobuf//:field_mask_proto",
@@ -75,12 +77,15 @@ java_grpc_library(
7577
java_gapic_library(
7678
name = "fleetengine_java_gapic",
7779
srcs = [":fleetengine_proto_with_info"],
80+
gapic_yaml = None,
7881
grpc_service_config = "fleetengine_grpc_service_config.json",
82+
service_yaml = "fleetengine.yaml",
7983
test_deps = [
8084
":fleetengine_java_grpc",
8185
],
8286
deps = [
8387
":fleetengine_java_proto",
88+
"//google/api:api_java_proto",
8489
],
8590
)
8691

@@ -134,7 +139,7 @@ go_gapic_library(
134139
metadata = True,
135140
service_yaml = "fleetengine.yaml",
136141
deps = [
137-
":fleetengine_go_proto",
142+
":fleetengine_go_proto",
138143
"@io_bazel_rules_go//proto/wkt:duration_go_proto",
139144
],
140145
)

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

Lines changed: 60 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ syntax = "proto3";
1717
package maps.fleetengine.v1;
1818

1919
import "google/api/field_behavior.proto";
20-
import "google/protobuf/any.proto";
20+
import "google/maps/fleetengine/v1/traffic.proto";
2121
import "google/protobuf/duration.proto";
2222
import "google/protobuf/timestamp.proto";
2323
import "google/protobuf/wrappers.proto";
@@ -55,10 +55,10 @@ message TerminalLocation {
5555
// Deprecated.
5656
string access_point_id = 3 [deprecated = true];
5757

58-
// Deprecated. Use vehicle.waypoint instead.
58+
// Deprecated.
5959
string trip_id = 4 [deprecated = true];
6060

61-
// Deprecated. Vehicle.waypoint will have this data.
61+
// Deprecated: `Vehicle.waypoint` will have this data.
6262
WaypointType terminal_location_type = 5 [deprecated = true];
6363
}
6464

@@ -79,64 +79,33 @@ message TripWaypoint {
7979
// current waypoint.
8080
repeated google.type.LatLng path_to_waypoint = 4;
8181

82+
// The path calculated by the server from the previous waypoint to the current
83+
// waypoint. Decoding is not yet supported.
84+
string encoded_path_to_waypoint = 5;
85+
86+
// The traffic conditions along the path to this waypoint.
87+
// Note that traffic is only available for Geo Enterprise Rides and Deliveries
88+
// Solution customers.
89+
ConsumableTrafficPolyline traffic_to_waypoint = 10;
90+
8291
// The path distance calculated by Fleet Engine from the previous waypoint to
83-
// the current waypoint.
84-
// If the current waypoint is the first waypoint in the list (Vehicle.waypoint
85-
// or Trip.remaining_waypoints), then the starting point is the vehicle's
86-
// location recorded at the time this TripWaypoint was added to the list.
92+
// the current waypoint. If the waypoint is the first waypoint in the list
93+
// (e.g., `Vehicle.waypoints[0]` or `Trip.remaining_waypoints[0]`), then the
94+
// value of this field is undefined.
8795
google.protobuf.Int32Value distance_meters = 6;
8896

8997
// The arrival time to this waypoint calculated by Fleet Engine.
9098
google.protobuf.Timestamp eta = 7;
9199

92-
// The travel time from previous waypoint to this point.
93-
// If the current waypoint is the first waypoint in the list (Vehicle.waypoint
94-
// or Trip.remaining_waypoints), then the starting point is the vehicle's
95-
// location recorded at the time that this waypoint was added to the list.
96-
// This field is filled only when returning Trip/Vehicle data.
100+
// The travel time from previous waypoint to this point. If the waypoint is
101+
// the first waypoint in the list (e.g., `Vehicle.waypoints[0]` or
102+
// `Trip.remaining_waypoints[0]`), then this value indicates the remaining
103+
// time to the waypoint.
97104
google.protobuf.Duration duration = 8;
98105
}
99106

100-
// The 'Status' defines a FleetEngine custom logical error mode.
101-
message Status {
102-
// The canonical error code.
103-
enum Code {
104-
// Unspecified status, not a valid value to set.
105-
UNSPECIFIED = 0;
106-
107-
// Internal server error. Usually expect the client to retry in this case.
108-
FAILURE = 1;
109-
110-
// There is no possible route. Client should not retry.
111-
ROUTE_NOT_POSSIBLE = 2;
112-
}
113-
114-
// The error code. It is not possible to have a value as 0 if it is explicitly
115-
// set by the server.
116-
Code code = 1;
117-
118-
// Detailed error message.
119-
string message = 2;
120-
121-
// A list of messages that carry the error details. There is a common set of
122-
// message types for APIs to use.
123-
repeated google.protobuf.Any details = 3;
124-
}
125-
126-
// A full, human-readable address for the entity containing this message.
127-
message FormattedAddress {
128-
// The lines of text that describe the address.
129-
// At least one line must be present.
130-
repeated string lines = 1;
131-
}
132-
133-
// Address of a place.
134-
message Address {
135-
// A full, human-readable address for this place.
136-
FormattedAddress formatted_address = 1;
137-
}
138-
139-
// Describes a vehicle attribute as a key-value pair.
107+
// Describes a vehicle attribute as a key-value pair. The "key:value" string
108+
// length cannot exceed 256 characters.
140109
message VehicleAttribute {
141110
// The attribute's key. Keys may not contain the colon character (:).
142111
string key = 1;
@@ -148,72 +117,68 @@ message VehicleAttribute {
148117
// The location, speed, and heading of a vehicle at a point in time.
149118
message VehicleLocation {
150119
// The location of the vehicle.
151-
// When it is sent to FleetEngine, the vehicle's location is a GPS location.
120+
// When it is sent to Fleet Engine, the vehicle's location is a GPS location.
152121
// When you receive it in a response, the vehicle's location can be either a
153-
// GPS location or a supplemental location. The source is specified in the
154-
// field 'location_sensor'.
122+
// GPS location, a supplemental location, or some other estimated location.
123+
// The source is specified in `location_sensor`.
155124
google.type.LatLng location = 1;
156125

157-
// Deprecated. Use latlng_accuracy instead.
126+
// Deprecated: Use `latlng_accuracy` instead.
158127
google.protobuf.DoubleValue horizontal_accuracy = 8 [deprecated = true];
159128

160-
// Accuracy of horizontal measurements (lat/lng) in meters as a radius.
129+
// Accuracy of `location` in meters as a radius.
161130
google.protobuf.DoubleValue latlng_accuracy = 22;
162131

163132
// Direction the vehicle is moving in degrees. 0 represents North.
164133
// The valid range is [0,360).
165134
google.protobuf.Int32Value heading = 2;
166135

167-
// Deprecated. Use heading_accuracy instead.
136+
// Deprecated: Use `heading_accuracy` instead.
168137
google.protobuf.DoubleValue bearing_accuracy = 10 [deprecated = true];
169138

170-
// Accuracy of heading (bearing) in degrees.
139+
// Accuracy of `heading` in degrees.
171140
google.protobuf.DoubleValue heading_accuracy = 23;
172141

173142
// Altitude in meters above WGS84.
174143
google.protobuf.DoubleValue altitude = 5;
175144

176-
// Deprecated. Use altitude_accurarcy instead.
145+
// Deprecated: Use `altitude_accuracy` instead.
177146
google.protobuf.DoubleValue vertical_accuracy = 9 [deprecated = true];
178147

179-
// Accuracy of altitude measurement in meters.
148+
// Accuracy of `altitude` in meters.
180149
google.protobuf.DoubleValue altitude_accuracy = 24;
181150

182151
// Speed of the vehicle in kilometers per hour.
183-
// Deprecated. Use speed instead.
152+
// Deprecated: Use `speed` instead.
184153
google.protobuf.Int32Value speed_kmph = 3 [deprecated = true];
185154

186155
// Speed of the vehicle in meters/second
187156
google.protobuf.DoubleValue speed = 6;
188157

189-
// Accuracy of speed in meters/second.
158+
// Accuracy of `speed` in meters/second.
190159
google.protobuf.DoubleValue speed_accuracy = 7;
191160

192-
// The time when the location was recorded.
161+
// The time when `location` was reported by the sensor.
193162
google.protobuf.Timestamp update_time = 4;
194163

195-
// Output only. The time when the server receives the location information, filled by
196-
// FleetEngine.
164+
// Output only. The time when the server received the location information.
197165
google.protobuf.Timestamp server_time = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
198166

199-
// Provider of location data (for example, "gps").
167+
// Provider of location data (for example, `GPS`).
200168
LocationSensor location_sensor = 11;
201169

202-
// Whether the vehicle location given by "location" field is snapped to a road
203-
// closest to the location given by "raw_location".
204-
// Driver SDK 1.15.1/2.1.1 and up will always set this field.
205-
// Unset value will be treated as true.
170+
// Whether `location` is snapped to a road.
206171
google.protobuf.BoolValue is_road_snapped = 27;
207172

208-
// Input only. Indicates whether the GPS sensor is enabled.
173+
// Input only. Indicates whether the GPS sensor is enabled on the mobile device.
209174
google.protobuf.BoolValue is_gps_sensor_enabled = 12 [(google.api.field_behavior) = INPUT_ONLY];
210175

211-
// Input only. Time (in seconds) since this location sample was first sent to the server.
176+
// Input only. Time (in seconds) since this location was first sent to the server.
212177
// This will be zero for the first update. If the time is unknown
213178
// (for example, when the app restarts), this value resets to zero.
214179
google.protobuf.Int32Value time_since_update = 14 [(google.api.field_behavior) = INPUT_ONLY];
215180

216-
// Input only. Number of additional attempts to send the current location to the server.
181+
// Input only. Number of additional attempts to send this location to the server.
217182
// If this value is zero, then it is not stale.
218183
google.protobuf.Int32Value num_stale_updates = 15 [(google.api.field_behavior) = INPUT_ONLY];
219184

@@ -226,7 +191,7 @@ message VehicleLocation {
226191
// Input only. Source of the raw location.
227192
LocationSensor raw_location_sensor = 28 [(google.api.field_behavior) = INPUT_ONLY];
228193

229-
// Input only. Accuracy of the raw location (lat/lng) as a radius, measured in meters.
194+
// Input only. Accuracy of `raw_location` as a radius, in meters.
230195
google.protobuf.DoubleValue raw_location_accuracy = 25 [(google.api.field_behavior) = INPUT_ONLY];
231196

232197
// Input only. Supplemental location provided by the integrating app, such as the location
@@ -239,11 +204,10 @@ message VehicleLocation {
239204
// Input only. Source of the supplemental location.
240205
LocationSensor supplemental_location_sensor = 20 [(google.api.field_behavior) = INPUT_ONLY];
241206

242-
// Input only. Accuracy of supplemental location (lat/lng) as a radius, measured in
243-
// meters.
207+
// Input only. Accuracy of `supplemental_location` as a radius, in meters.
244208
google.protobuf.DoubleValue supplemental_location_accuracy = 21 [(google.api.field_behavior) = INPUT_ONLY];
245209

246-
// Deprecated, use is_road_snapped instead.
210+
// Deprecated: Use `is_road_snapped` instead.
247211
bool road_snapped = 26 [deprecated = true];
248212
}
249213

@@ -261,13 +225,13 @@ enum TripType {
261225

262226
// The type of waypoint.
263227
enum WaypointType {
264-
// Default, unknown waypoint type
228+
// Unknown or unspecified waypoint type.
265229
UNKNOWN_WAYPOINT_TYPE = 0;
266230

267-
// Waypoints for picking up customers or merchandise.
231+
// Waypoints for picking up riders or items.
268232
PICKUP_WAYPOINT_TYPE = 1;
269233

270-
// Waypoints for dropping off customers or merchandise.
234+
// Waypoints for dropping off riders or items.
271235
DROP_OFF_WAYPOINT_TYPE = 2;
272236

273237
// Waypoints for intermediate destinations in a multi-destination trip.
@@ -276,54 +240,53 @@ enum WaypointType {
276240

277241
// The type of polyline format.
278242
enum PolylineFormatType {
279-
// Unspecified format type.
243+
// The format is unspecified or unknown.
280244
UNKNOWN_FORMAT_TYPE = 0;
281245

282-
// Repeated LatLng.
246+
// A list of `google.type.LatLng`.
283247
LAT_LNG_LIST_TYPE = 1;
284248

285249
// A polyline encoded with a polyline compression algorithm. Decoding is not
286250
// yet supported.
287251
ENCODED_POLYLINE_TYPE = 2;
288252
}
289253

290-
// A set of values that specify the vehicle's navigation status.
254+
// The vehicle's navigation status.
291255
enum NavigationStatus {
292256
// Unspecified navigation status.
293257
UNKNOWN_NAVIGATION_STATUS = 0;
294258

295-
// The Driver app's navigation is in FREE_NAV mode.
259+
// The Driver app's navigation is in `FREE_NAV` mode.
296260
NO_GUIDANCE = 1;
297261

298-
// Turn-by-turn navigation starts and the Driver app navigation enters
299-
// GUIDED_NAV mode showing the green header, route, and destination marker.
262+
// Turn-by-turn navigation is available and the Driver app navigation has
263+
// entered `GUIDED_NAV` mode.
300264
ENROUTE_TO_DESTINATION = 2;
301265

302-
// Vehicle has gone off the suggested route.
266+
// The vehicle has gone off the suggested route.
303267
OFF_ROUTE = 3;
304268

305-
// The vehicle is within 50m of the destination and onArrival was
306-
// automatically triggered.
269+
// The vehicle is within approximately 50m of the destination.
307270
ARRIVED_AT_DESTINATION = 4;
308271
}
309272

310-
// Possible location providers.
273+
// The sensor or methodology used to determine the location.
311274
enum LocationSensor {
312-
// Undefined sensor.
275+
// The sensor is unspecified or unknown.
313276
UNKNOWN_SENSOR = 0;
314277

315-
// Sensors: (GPS, AGPS).
278+
// GPS or Assisted GPS.
316279
GPS = 1;
317280

318-
// Sensors: (AGPS, CellID, WiFi MACID).
281+
// Assisted GPS, cell tower ID, or WiFi access point.
319282
NETWORK = 2;
320283

321-
// Sensors: (CellID, WiFi MACID).
284+
// Cell tower ID or WiFi access point.
322285
PASSIVE = 3;
323286

324-
// GMM's road snapped (gmfc) location.
287+
// A location signal snapped to the best road position.
325288
ROAD_SNAPPED_LOCATION_PROVIDER = 4;
326289

327-
// Unspecified, but generated by the Fused Location Provider.
290+
// The fused location provider in Google Play services.
328291
FUSED_LOCATION_PROVIDER = 100;
329292
}

‎google/maps/fleetengine/v1/fleetengine.yaml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,15 @@ apis:
88
- name: maps.fleetengine.v1.VehicleService
99

1010
documentation:
11-
summary: Services for ridesharing providers.
11+
summary: |-
12+
Enables Fleet Engine for access to the On Demand Rides and Deliveries and
13+
Last Mile Fleet Solution APIs.
1214
1315
backend:
1416
rules:
1517
- selector: 'maps.fleetengine.v1.TripService.*'
1618
deadline: 10.0
1719
- selector: 'maps.fleetengine.v1.VehicleService.*'
1820
deadline: 10.0
21+
- selector: maps.fleetengine.v1.VehicleService.UpdateVehicleLocation
22+
deadline: 3.0

0 commit comments

Comments
 (0)