google-maps-fleet_engine-delivery-v1 0.a → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +122 -0
  4. data/README.md +144 -8
  5. data/lib/google/maps/fleet_engine/delivery/v1/delivery_service/client.rb +1621 -0
  6. data/lib/google/maps/fleet_engine/delivery/v1/delivery_service/credentials.rb +49 -0
  7. data/lib/google/maps/fleet_engine/delivery/v1/delivery_service/paths.rb +100 -0
  8. data/lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/client.rb +1505 -0
  9. data/lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest/service_stub.rb +725 -0
  10. data/lib/google/maps/fleet_engine/delivery/v1/delivery_service/rest.rb +54 -0
  11. data/lib/google/maps/fleet_engine/delivery/v1/delivery_service.rb +57 -0
  12. data/lib/google/maps/fleet_engine/delivery/v1/rest.rb +39 -0
  13. data/lib/google/maps/fleet_engine/delivery/v1/version.rb +8 -3
  14. data/lib/google/maps/fleet_engine/delivery/v1.rb +47 -0
  15. data/lib/google/maps/fleetengine/delivery/v1/common_pb.rb +57 -0
  16. data/lib/google/maps/fleetengine/delivery/v1/delivery_api_pb.rb +75 -0
  17. data/lib/google/maps/fleetengine/delivery/v1/delivery_api_services_pb.rb +73 -0
  18. data/lib/google/maps/fleetengine/delivery/v1/delivery_vehicles_pb.rb +61 -0
  19. data/lib/google/maps/fleetengine/delivery/v1/header_pb.rb +48 -0
  20. data/lib/google/maps/fleetengine/delivery/v1/task_tracking_info_pb.rb +58 -0
  21. data/lib/google/maps/fleetengine/delivery/v1/tasks_pb.rb +62 -0
  22. data/lib/google-maps-fleet_engine-delivery-v1.rb +21 -0
  23. data/proto_docs/README.md +4 -0
  24. data/proto_docs/google/api/client.rb +399 -0
  25. data/proto_docs/google/api/field_behavior.rb +85 -0
  26. data/proto_docs/google/api/launch_stage.rb +71 -0
  27. data/proto_docs/google/api/resource.rb +222 -0
  28. data/proto_docs/google/api/routing.rb +459 -0
  29. data/proto_docs/google/geo/type/viewport.rb +70 -0
  30. data/proto_docs/google/maps/fleetengine/delivery/v1/common.rb +251 -0
  31. data/proto_docs/google/maps/fleetengine/delivery/v1/delivery_api.rb +416 -0
  32. data/proto_docs/google/maps/fleetengine/delivery/v1/delivery_vehicles.rb +271 -0
  33. data/proto_docs/google/maps/fleetengine/delivery/v1/header.rb +113 -0
  34. data/proto_docs/google/maps/fleetengine/delivery/v1/task_tracking_info.rb +91 -0
  35. data/proto_docs/google/maps/fleetengine/delivery/v1/tasks.rb +281 -0
  36. data/proto_docs/google/protobuf/duration.rb +98 -0
  37. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  38. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  39. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  40. data/proto_docs/google/type/latlng.rb +38 -0
  41. metadata +109 -13
@@ -0,0 +1,70 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Geo
22
+ module Type
23
+ # A latitude-longitude viewport, represented as two diagonally opposite `low`
24
+ # and `high` points. A viewport is considered a closed region, i.e. it includes
25
+ # its boundary. The latitude bounds must range between -90 to 90 degrees
26
+ # inclusive, and the longitude bounds must range between -180 to 180 degrees
27
+ # inclusive. Various cases include:
28
+ #
29
+ # - If `low` = `high`, the viewport consists of that single point.
30
+ #
31
+ # - If `low.longitude` > `high.longitude`, the longitude range is inverted
32
+ # (the viewport crosses the 180 degree longitude line).
33
+ #
34
+ # - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees,
35
+ # the viewport includes all longitudes.
36
+ #
37
+ # - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees,
38
+ # the longitude range is empty.
39
+ #
40
+ # - If `low.latitude` > `high.latitude`, the latitude range is empty.
41
+ #
42
+ # Both `low` and `high` must be populated, and the represented box cannot be
43
+ # empty (as specified by the definitions above). An empty viewport will result
44
+ # in an error.
45
+ #
46
+ # For example, this viewport fully encloses New York City:
47
+ #
48
+ # {
49
+ # "low": {
50
+ # "latitude": 40.477398,
51
+ # "longitude": -74.259087
52
+ # },
53
+ # "high": {
54
+ # "latitude": 40.91618,
55
+ # "longitude": -73.70018
56
+ # }
57
+ # }
58
+ # @!attribute [rw] low
59
+ # @return [::Google::Type::LatLng]
60
+ # Required. The low point of the viewport.
61
+ # @!attribute [rw] high
62
+ # @return [::Google::Type::LatLng]
63
+ # Required. The high point of the viewport.
64
+ class Viewport
65
+ include ::Google::Protobuf::MessageExts
66
+ extend ::Google::Protobuf::MessageExts::ClassMethods
67
+ end
68
+ end
69
+ end
70
+ end
@@ -0,0 +1,251 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Maps
22
+ module FleetEngine
23
+ module Delivery
24
+ module V1
25
+ # Describes a vehicle attribute as a key-value pair. The "key:value" string
26
+ # length cannot exceed 256 characters.
27
+ # @!attribute [rw] key
28
+ # @return [::String]
29
+ # The attribute's key.
30
+ # @!attribute [rw] value
31
+ # @return [::String]
32
+ # The attribute's value.
33
+ # @!attribute [rw] string_value
34
+ # @return [::String]
35
+ # String typed attribute value.
36
+ #
37
+ # Note: This is identical to the `value` field which will eventually be
38
+ # deprecated. For create or update methods, either field can be used, but
39
+ # it's strongly recommended to use `string_value`. If both `string_value`
40
+ # and `value` are set, they must be identical or an error will be thrown.
41
+ # Both fields are populated in responses.
42
+ # @!attribute [rw] bool_value
43
+ # @return [::Boolean]
44
+ # Boolean typed attribute value.
45
+ # @!attribute [rw] number_value
46
+ # @return [::Float]
47
+ # Double typed attribute value.
48
+ class DeliveryVehicleAttribute
49
+ include ::Google::Protobuf::MessageExts
50
+ extend ::Google::Protobuf::MessageExts::ClassMethods
51
+ end
52
+
53
+ # The location, speed, and heading of a vehicle at a point in time.
54
+ # @!attribute [rw] location
55
+ # @return [::Google::Type::LatLng]
56
+ # The location of the vehicle.
57
+ # When it is sent to Fleet Engine, the vehicle's location is a GPS location.
58
+ # When you receive it in a response, the vehicle's location can be either a
59
+ # GPS location, a supplemental location, or some other estimated location.
60
+ # The source is specified in `location_sensor`.
61
+ # @!attribute [rw] horizontal_accuracy
62
+ # @deprecated This field is deprecated and may be removed in the next major version update.
63
+ # @return [::Google::Protobuf::DoubleValue]
64
+ # Deprecated: Use `latlng_accuracy` instead.
65
+ # @!attribute [rw] latlng_accuracy
66
+ # @return [::Google::Protobuf::DoubleValue]
67
+ # Accuracy of `location` in meters as a radius.
68
+ # @!attribute [rw] heading
69
+ # @return [::Google::Protobuf::Int32Value]
70
+ # Direction the vehicle is moving in degrees. 0 represents North.
71
+ # The valid range is [0,360).
72
+ # @!attribute [rw] bearing_accuracy
73
+ # @deprecated This field is deprecated and may be removed in the next major version update.
74
+ # @return [::Google::Protobuf::DoubleValue]
75
+ # Deprecated: Use `heading_accuracy` instead.
76
+ # @!attribute [rw] heading_accuracy
77
+ # @return [::Google::Protobuf::DoubleValue]
78
+ # Accuracy of `heading` in degrees.
79
+ # @!attribute [rw] altitude
80
+ # @return [::Google::Protobuf::DoubleValue]
81
+ # Altitude in meters above WGS84.
82
+ # @!attribute [rw] vertical_accuracy
83
+ # @deprecated This field is deprecated and may be removed in the next major version update.
84
+ # @return [::Google::Protobuf::DoubleValue]
85
+ # Deprecated: Use `altitude_accuracy` instead.
86
+ # @!attribute [rw] altitude_accuracy
87
+ # @return [::Google::Protobuf::DoubleValue]
88
+ # Accuracy of `altitude` in meters.
89
+ # @!attribute [rw] speed_kmph
90
+ # @deprecated This field is deprecated and may be removed in the next major version update.
91
+ # @return [::Google::Protobuf::Int32Value]
92
+ # Speed of the vehicle in kilometers per hour.
93
+ # Deprecated: Use `speed` instead.
94
+ # @!attribute [rw] speed
95
+ # @return [::Google::Protobuf::DoubleValue]
96
+ # Speed of the vehicle in meters/second
97
+ # @!attribute [rw] speed_accuracy
98
+ # @return [::Google::Protobuf::DoubleValue]
99
+ # Accuracy of `speed` in meters/second.
100
+ # @!attribute [rw] update_time
101
+ # @return [::Google::Protobuf::Timestamp]
102
+ # The time when `location` was reported by the sensor according to the
103
+ # sensor's clock.
104
+ # @!attribute [r] server_time
105
+ # @return [::Google::Protobuf::Timestamp]
106
+ # Output only. The time when the server received the location information.
107
+ # @!attribute [rw] location_sensor
108
+ # @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleLocationSensor]
109
+ # Provider of location data (for example, `GPS`).
110
+ # @!attribute [rw] is_road_snapped
111
+ # @return [::Google::Protobuf::BoolValue]
112
+ # Whether `location` is snapped to a road.
113
+ # @!attribute [rw] is_gps_sensor_enabled
114
+ # @return [::Google::Protobuf::BoolValue]
115
+ # Input only. Indicates whether the GPS sensor is enabled on the mobile
116
+ # device.
117
+ # @!attribute [rw] time_since_update
118
+ # @return [::Google::Protobuf::Int32Value]
119
+ # Input only. Time (in seconds) since this location was first sent to the
120
+ # server. This will be zero for the first update. If the time is unknown (for
121
+ # example, when the app restarts), this value resets to zero.
122
+ # @!attribute [rw] num_stale_updates
123
+ # @deprecated This field is deprecated and may be removed in the next major version update.
124
+ # @return [::Google::Protobuf::Int32Value]
125
+ # Input only. Deprecated: Other signals are now used to determine if a
126
+ # location is stale.
127
+ # @!attribute [rw] raw_location
128
+ # @return [::Google::Type::LatLng]
129
+ # Raw vehicle location (unprocessed by road-snapper).
130
+ # @!attribute [rw] raw_location_time
131
+ # @return [::Google::Protobuf::Timestamp]
132
+ # Timestamp associated with the raw location.
133
+ # @!attribute [rw] raw_location_sensor
134
+ # @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleLocationSensor]
135
+ # Source of the raw location. Defaults to `GPS`.
136
+ # @!attribute [rw] raw_location_accuracy
137
+ # @return [::Google::Protobuf::DoubleValue]
138
+ # Accuracy of `raw_location` as a radius, in meters.
139
+ # @!attribute [rw] supplemental_location
140
+ # @return [::Google::Type::LatLng]
141
+ # Supplemental location provided by the integrating app.
142
+ # @!attribute [rw] supplemental_location_time
143
+ # @return [::Google::Protobuf::Timestamp]
144
+ # Timestamp associated with the supplemental location.
145
+ # @!attribute [rw] supplemental_location_sensor
146
+ # @return [::Google::Maps::FleetEngine::Delivery::V1::DeliveryVehicleLocationSensor]
147
+ # Source of the supplemental location. Defaults to
148
+ # `CUSTOMER_SUPPLIED_LOCATION`.
149
+ # @!attribute [rw] supplemental_location_accuracy
150
+ # @return [::Google::Protobuf::DoubleValue]
151
+ # Accuracy of `supplemental_location` as a radius, in meters.
152
+ # @!attribute [rw] road_snapped
153
+ # @deprecated This field is deprecated and may be removed in the next major version update.
154
+ # @return [::Boolean]
155
+ # Deprecated: Use `is_road_snapped` instead.
156
+ class DeliveryVehicleLocation
157
+ include ::Google::Protobuf::MessageExts
158
+ extend ::Google::Protobuf::MessageExts::ClassMethods
159
+ end
160
+
161
+ # A time range.
162
+ # @!attribute [rw] start_time
163
+ # @return [::Google::Protobuf::Timestamp]
164
+ # Required. The start time of the time window (inclusive).
165
+ # @!attribute [rw] end_time
166
+ # @return [::Google::Protobuf::Timestamp]
167
+ # Required. The end time of the time window (inclusive).
168
+ class TimeWindow
169
+ include ::Google::Protobuf::MessageExts
170
+ extend ::Google::Protobuf::MessageExts::ClassMethods
171
+ end
172
+
173
+ # Describes a task attribute as a key-value pair. The "key:value" string length
174
+ # cannot exceed 256 characters.
175
+ # @!attribute [rw] key
176
+ # @return [::String]
177
+ # The attribute's key. Keys may not contain the colon character (:).
178
+ # @!attribute [rw] string_value
179
+ # @return [::String]
180
+ # String typed attribute value.
181
+ # @!attribute [rw] bool_value
182
+ # @return [::Boolean]
183
+ # Boolean typed attribute value.
184
+ # @!attribute [rw] number_value
185
+ # @return [::Float]
186
+ # Double typed attribute value.
187
+ class TaskAttribute
188
+ include ::Google::Protobuf::MessageExts
189
+ extend ::Google::Protobuf::MessageExts::ClassMethods
190
+ end
191
+
192
+ # The sensor or methodology used to determine the location.
193
+ module DeliveryVehicleLocationSensor
194
+ # The sensor is unspecified or unknown.
195
+ UNKNOWN_SENSOR = 0
196
+
197
+ # GPS or Assisted GPS.
198
+ GPS = 1
199
+
200
+ # Assisted GPS, cell tower ID, or WiFi access point.
201
+ NETWORK = 2
202
+
203
+ # Cell tower ID or WiFi access point.
204
+ PASSIVE = 3
205
+
206
+ # A location determined by the mobile device to be the most likely
207
+ # road position.
208
+ ROAD_SNAPPED_LOCATION_PROVIDER = 4
209
+
210
+ # A customer-supplied location from an independent source. Typically, this
211
+ # value is used for a location provided from sources other than the mobile
212
+ # device running Driver SDK. If the original source is described by one of
213
+ # the other enum values, use that value. Locations marked
214
+ # CUSTOMER_SUPPLIED_LOCATION are typically provided via a DeliveryVehicle's
215
+ # `last_location.supplemental_location_sensor`.
216
+ CUSTOMER_SUPPLIED_LOCATION = 5
217
+
218
+ # A location calculated by Fleet Engine based on the signals available to it.
219
+ # Output only. This value will be rejected if it is received in a request.
220
+ FLEET_ENGINE_LOCATION = 6
221
+
222
+ # Android's Fused Location Provider.
223
+ FUSED_LOCATION_PROVIDER = 100
224
+
225
+ # The location provider on Apple operating systems.
226
+ CORE_LOCATION = 200
227
+ end
228
+
229
+ # The vehicle's navigation status.
230
+ module DeliveryVehicleNavigationStatus
231
+ # Unspecified navigation status.
232
+ UNKNOWN_NAVIGATION_STATUS = 0
233
+
234
+ # The Driver app's navigation is in `FREE_NAV` mode.
235
+ NO_GUIDANCE = 1
236
+
237
+ # Turn-by-turn navigation is available and the Driver app navigation has
238
+ # entered `GUIDED_NAV` mode.
239
+ ENROUTE_TO_DESTINATION = 2
240
+
241
+ # The vehicle has gone off the suggested route.
242
+ OFF_ROUTE = 3
243
+
244
+ # The vehicle is within approximately 50m of the destination.
245
+ ARRIVED_AT_DESTINATION = 4
246
+ end
247
+ end
248
+ end
249
+ end
250
+ end
251
+ end