google-maps-fleet_engine-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 (52) 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/v1/rest.rb +38 -0
  6. data/lib/google/maps/fleet_engine/v1/trip_service/client.rb +996 -0
  7. data/lib/google/maps/fleet_engine/v1/trip_service/credentials.rb +47 -0
  8. data/lib/google/maps/fleet_engine/v1/trip_service/paths.rb +50 -0
  9. data/lib/google/maps/fleet_engine/v1/trip_service/rest/client.rb +930 -0
  10. data/lib/google/maps/fleet_engine/v1/trip_service/rest/service_stub.rb +368 -0
  11. data/lib/google/maps/fleet_engine/v1/trip_service/rest.rb +52 -0
  12. data/lib/google/maps/fleet_engine/v1/trip_service.rb +55 -0
  13. data/lib/google/maps/fleet_engine/v1/vehicle_service/client.rb +1639 -0
  14. data/lib/google/maps/fleet_engine/v1/vehicle_service/credentials.rb +47 -0
  15. data/lib/google/maps/fleet_engine/v1/vehicle_service/paths.rb +50 -0
  16. data/lib/google/maps/fleet_engine/v1/vehicle_service/rest/client.rb +1545 -0
  17. data/lib/google/maps/fleet_engine/v1/vehicle_service/rest/service_stub.rb +547 -0
  18. data/lib/google/maps/fleet_engine/v1/vehicle_service/rest.rb +52 -0
  19. data/lib/google/maps/fleet_engine/v1/vehicle_service.rb +55 -0
  20. data/lib/google/maps/fleet_engine/v1/version.rb +8 -3
  21. data/lib/google/maps/fleet_engine/v1.rb +46 -0
  22. data/lib/google/maps/fleetengine/v1/fleetengine_pb.rb +63 -0
  23. data/lib/google/maps/fleetengine/v1/header_pb.rb +46 -0
  24. data/lib/google/maps/fleetengine/v1/traffic_pb.rb +44 -0
  25. data/lib/google/maps/fleetengine/v1/trip_api_pb.rb +66 -0
  26. data/lib/google/maps/fleetengine/v1/trip_api_services_pb.rb +53 -0
  27. data/lib/google/maps/fleetengine/v1/trips_pb.rb +61 -0
  28. data/lib/google/maps/fleetengine/v1/vehicle_api_pb.rb +81 -0
  29. data/lib/google/maps/fleetengine/v1/vehicle_api_services_pb.rb +108 -0
  30. data/lib/google/maps/fleetengine/v1/vehicles_pb.rb +64 -0
  31. data/lib/google-maps-fleet_engine-v1.rb +21 -0
  32. data/proto_docs/README.md +4 -0
  33. data/proto_docs/google/api/client.rb +399 -0
  34. data/proto_docs/google/api/field_behavior.rb +85 -0
  35. data/proto_docs/google/api/launch_stage.rb +71 -0
  36. data/proto_docs/google/api/resource.rb +222 -0
  37. data/proto_docs/google/api/routing.rb +459 -0
  38. data/proto_docs/google/geo/type/viewport.rb +70 -0
  39. data/proto_docs/google/maps/fleetengine/v1/fleetengine.rb +342 -0
  40. data/proto_docs/google/maps/fleetengine/v1/header.rb +111 -0
  41. data/proto_docs/google/maps/fleetengine/v1/traffic.rb +76 -0
  42. data/proto_docs/google/maps/fleetengine/v1/trip_api.rb +296 -0
  43. data/proto_docs/google/maps/fleetengine/v1/trips.rb +286 -0
  44. data/proto_docs/google/maps/fleetengine/v1/vehicle_api.rb +684 -0
  45. data/proto_docs/google/maps/fleetengine/v1/vehicles.rb +358 -0
  46. data/proto_docs/google/protobuf/duration.rb +98 -0
  47. data/proto_docs/google/protobuf/empty.rb +34 -0
  48. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  49. data/proto_docs/google/protobuf/timestamp.rb +127 -0
  50. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  51. data/proto_docs/google/type/latlng.rb +38 -0
  52. metadata +119 -13
@@ -0,0 +1,368 @@
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
+ require "google/maps/fleetengine/v1/trip_api_pb"
20
+
21
+ module Google
22
+ module Maps
23
+ module FleetEngine
24
+ module V1
25
+ module TripService
26
+ module Rest
27
+ ##
28
+ # REST service stub for the TripService service.
29
+ # Service stub contains baseline method implementations
30
+ # including transcoding, making the REST call, and deserialing the response.
31
+ #
32
+ class ServiceStub
33
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
+ # These require statements are intentionally placed here to initialize
35
+ # the REST modules only when it's required.
36
+ require "gapic/rest"
37
+
38
+ @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
39
+ endpoint_template: endpoint_template,
40
+ universe_domain: universe_domain,
41
+ credentials: credentials,
42
+ numeric_enums: true,
43
+ raise_faraday_errors: false
44
+ end
45
+
46
+ ##
47
+ # The effective universe domain
48
+ #
49
+ # @return [String]
50
+ #
51
+ def universe_domain
52
+ @client_stub.universe_domain
53
+ end
54
+
55
+ ##
56
+ # The effective endpoint
57
+ #
58
+ # @return [String]
59
+ #
60
+ def endpoint
61
+ @client_stub.endpoint
62
+ end
63
+
64
+ ##
65
+ # Baseline implementation for the create_trip REST call
66
+ #
67
+ # @param request_pb [::Google::Maps::FleetEngine::V1::CreateTripRequest]
68
+ # A request object representing the call parameters. Required.
69
+ # @param options [::Gapic::CallOptions]
70
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
71
+ #
72
+ # @yield [result, operation] Access the result along with the TransportOperation object
73
+ # @yieldparam result [::Google::Maps::FleetEngine::V1::Trip]
74
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
75
+ #
76
+ # @return [::Google::Maps::FleetEngine::V1::Trip]
77
+ # A result object deserialized from the server's reply
78
+ def create_trip request_pb, options = nil
79
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
80
+
81
+ verb, uri, query_string_params, body = ServiceStub.transcode_create_trip_request request_pb
82
+ query_string_params = if query_string_params.any?
83
+ query_string_params.to_h { |p| p.split "=", 2 }
84
+ else
85
+ {}
86
+ end
87
+
88
+ response = @client_stub.make_http_request(
89
+ verb,
90
+ uri: uri,
91
+ body: body || "",
92
+ params: query_string_params,
93
+ options: options
94
+ )
95
+ operation = ::Gapic::Rest::TransportOperation.new response
96
+ result = ::Google::Maps::FleetEngine::V1::Trip.decode_json response.body, ignore_unknown_fields: true
97
+
98
+ yield result, operation if block_given?
99
+ result
100
+ end
101
+
102
+ ##
103
+ # Baseline implementation for the get_trip REST call
104
+ #
105
+ # @param request_pb [::Google::Maps::FleetEngine::V1::GetTripRequest]
106
+ # A request object representing the call parameters. Required.
107
+ # @param options [::Gapic::CallOptions]
108
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
109
+ #
110
+ # @yield [result, operation] Access the result along with the TransportOperation object
111
+ # @yieldparam result [::Google::Maps::FleetEngine::V1::Trip]
112
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
113
+ #
114
+ # @return [::Google::Maps::FleetEngine::V1::Trip]
115
+ # A result object deserialized from the server's reply
116
+ def get_trip request_pb, options = nil
117
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
118
+
119
+ verb, uri, query_string_params, body = ServiceStub.transcode_get_trip_request request_pb
120
+ query_string_params = if query_string_params.any?
121
+ query_string_params.to_h { |p| p.split "=", 2 }
122
+ else
123
+ {}
124
+ end
125
+
126
+ response = @client_stub.make_http_request(
127
+ verb,
128
+ uri: uri,
129
+ body: body || "",
130
+ params: query_string_params,
131
+ options: options
132
+ )
133
+ operation = ::Gapic::Rest::TransportOperation.new response
134
+ result = ::Google::Maps::FleetEngine::V1::Trip.decode_json response.body, ignore_unknown_fields: true
135
+
136
+ yield result, operation if block_given?
137
+ result
138
+ end
139
+
140
+ ##
141
+ # Baseline implementation for the report_billable_trip REST call
142
+ #
143
+ # @param request_pb [::Google::Maps::FleetEngine::V1::ReportBillableTripRequest]
144
+ # A request object representing the call parameters. Required.
145
+ # @param options [::Gapic::CallOptions]
146
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
147
+ #
148
+ # @yield [result, operation] Access the result along with the TransportOperation object
149
+ # @yieldparam result [::Google::Protobuf::Empty]
150
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
151
+ #
152
+ # @return [::Google::Protobuf::Empty]
153
+ # A result object deserialized from the server's reply
154
+ def report_billable_trip request_pb, options = nil
155
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
156
+
157
+ verb, uri, query_string_params, body = ServiceStub.transcode_report_billable_trip_request request_pb
158
+ query_string_params = if query_string_params.any?
159
+ query_string_params.to_h { |p| p.split "=", 2 }
160
+ else
161
+ {}
162
+ end
163
+
164
+ response = @client_stub.make_http_request(
165
+ verb,
166
+ uri: uri,
167
+ body: body || "",
168
+ params: query_string_params,
169
+ options: options
170
+ )
171
+ operation = ::Gapic::Rest::TransportOperation.new response
172
+ result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
173
+
174
+ yield result, operation if block_given?
175
+ result
176
+ end
177
+
178
+ ##
179
+ # Baseline implementation for the search_trips REST call
180
+ #
181
+ # @param request_pb [::Google::Maps::FleetEngine::V1::SearchTripsRequest]
182
+ # A request object representing the call parameters. Required.
183
+ # @param options [::Gapic::CallOptions]
184
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
185
+ #
186
+ # @yield [result, operation] Access the result along with the TransportOperation object
187
+ # @yieldparam result [::Google::Maps::FleetEngine::V1::SearchTripsResponse]
188
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
189
+ #
190
+ # @return [::Google::Maps::FleetEngine::V1::SearchTripsResponse]
191
+ # A result object deserialized from the server's reply
192
+ def search_trips request_pb, options = nil
193
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
194
+
195
+ verb, uri, query_string_params, body = ServiceStub.transcode_search_trips_request request_pb
196
+ query_string_params = if query_string_params.any?
197
+ query_string_params.to_h { |p| p.split "=", 2 }
198
+ else
199
+ {}
200
+ end
201
+
202
+ response = @client_stub.make_http_request(
203
+ verb,
204
+ uri: uri,
205
+ body: body || "",
206
+ params: query_string_params,
207
+ options: options
208
+ )
209
+ operation = ::Gapic::Rest::TransportOperation.new response
210
+ result = ::Google::Maps::FleetEngine::V1::SearchTripsResponse.decode_json response.body, ignore_unknown_fields: true
211
+
212
+ yield result, operation if block_given?
213
+ result
214
+ end
215
+
216
+ ##
217
+ # Baseline implementation for the update_trip REST call
218
+ #
219
+ # @param request_pb [::Google::Maps::FleetEngine::V1::UpdateTripRequest]
220
+ # A request object representing the call parameters. Required.
221
+ # @param options [::Gapic::CallOptions]
222
+ # Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
223
+ #
224
+ # @yield [result, operation] Access the result along with the TransportOperation object
225
+ # @yieldparam result [::Google::Maps::FleetEngine::V1::Trip]
226
+ # @yieldparam operation [::Gapic::Rest::TransportOperation]
227
+ #
228
+ # @return [::Google::Maps::FleetEngine::V1::Trip]
229
+ # A result object deserialized from the server's reply
230
+ def update_trip request_pb, options = nil
231
+ raise ::ArgumentError, "request must be provided" if request_pb.nil?
232
+
233
+ verb, uri, query_string_params, body = ServiceStub.transcode_update_trip_request request_pb
234
+ query_string_params = if query_string_params.any?
235
+ query_string_params.to_h { |p| p.split "=", 2 }
236
+ else
237
+ {}
238
+ end
239
+
240
+ response = @client_stub.make_http_request(
241
+ verb,
242
+ uri: uri,
243
+ body: body || "",
244
+ params: query_string_params,
245
+ options: options
246
+ )
247
+ operation = ::Gapic::Rest::TransportOperation.new response
248
+ result = ::Google::Maps::FleetEngine::V1::Trip.decode_json response.body, ignore_unknown_fields: true
249
+
250
+ yield result, operation if block_given?
251
+ result
252
+ end
253
+
254
+ ##
255
+ # @private
256
+ #
257
+ # GRPC transcoding helper method for the create_trip REST call
258
+ #
259
+ # @param request_pb [::Google::Maps::FleetEngine::V1::CreateTripRequest]
260
+ # A request object representing the call parameters. Required.
261
+ # @return [Array(String, [String, nil], Hash{String => String})]
262
+ # Uri, Body, Query string parameters
263
+ def self.transcode_create_trip_request request_pb
264
+ transcoder = Gapic::Rest::GrpcTranscoder.new
265
+ .with_bindings(
266
+ uri_method: :post,
267
+ uri_template: "/v1/{parent}/trips",
268
+ body: "trip",
269
+ matches: [
270
+ ["parent", %r{^providers/[^/]+/?$}, false]
271
+ ]
272
+ )
273
+ transcoder.transcode request_pb
274
+ end
275
+
276
+ ##
277
+ # @private
278
+ #
279
+ # GRPC transcoding helper method for the get_trip REST call
280
+ #
281
+ # @param request_pb [::Google::Maps::FleetEngine::V1::GetTripRequest]
282
+ # A request object representing the call parameters. Required.
283
+ # @return [Array(String, [String, nil], Hash{String => String})]
284
+ # Uri, Body, Query string parameters
285
+ def self.transcode_get_trip_request request_pb
286
+ transcoder = Gapic::Rest::GrpcTranscoder.new
287
+ .with_bindings(
288
+ uri_method: :get,
289
+ uri_template: "/v1/{name}",
290
+ matches: [
291
+ ["name", %r{^providers/[^/]+/trips/[^/]+/?$}, false]
292
+ ]
293
+ )
294
+ transcoder.transcode request_pb
295
+ end
296
+
297
+ ##
298
+ # @private
299
+ #
300
+ # GRPC transcoding helper method for the report_billable_trip REST call
301
+ #
302
+ # @param request_pb [::Google::Maps::FleetEngine::V1::ReportBillableTripRequest]
303
+ # A request object representing the call parameters. Required.
304
+ # @return [Array(String, [String, nil], Hash{String => String})]
305
+ # Uri, Body, Query string parameters
306
+ def self.transcode_report_billable_trip_request request_pb
307
+ transcoder = Gapic::Rest::GrpcTranscoder.new
308
+ .with_bindings(
309
+ uri_method: :post,
310
+ uri_template: "/v1/{name}:report",
311
+ body: "*",
312
+ matches: [
313
+ ["name", %r{^providers/[^/]+/billableTrips/[^/]+/?$}, false]
314
+ ]
315
+ )
316
+ transcoder.transcode request_pb
317
+ end
318
+
319
+ ##
320
+ # @private
321
+ #
322
+ # GRPC transcoding helper method for the search_trips REST call
323
+ #
324
+ # @param request_pb [::Google::Maps::FleetEngine::V1::SearchTripsRequest]
325
+ # A request object representing the call parameters. Required.
326
+ # @return [Array(String, [String, nil], Hash{String => String})]
327
+ # Uri, Body, Query string parameters
328
+ def self.transcode_search_trips_request request_pb
329
+ transcoder = Gapic::Rest::GrpcTranscoder.new
330
+ .with_bindings(
331
+ uri_method: :post,
332
+ uri_template: "/v1/{parent}/trips:search",
333
+ body: "*",
334
+ matches: [
335
+ ["parent", %r{^providers/[^/]+/?$}, false]
336
+ ]
337
+ )
338
+ transcoder.transcode request_pb
339
+ end
340
+
341
+ ##
342
+ # @private
343
+ #
344
+ # GRPC transcoding helper method for the update_trip REST call
345
+ #
346
+ # @param request_pb [::Google::Maps::FleetEngine::V1::UpdateTripRequest]
347
+ # A request object representing the call parameters. Required.
348
+ # @return [Array(String, [String, nil], Hash{String => String})]
349
+ # Uri, Body, Query string parameters
350
+ def self.transcode_update_trip_request request_pb
351
+ transcoder = Gapic::Rest::GrpcTranscoder.new
352
+ .with_bindings(
353
+ uri_method: :put,
354
+ uri_template: "/v1/{name}",
355
+ body: "trip",
356
+ matches: [
357
+ ["name", %r{^providers/[^/]+/trips/[^/]+/?$}, false]
358
+ ]
359
+ )
360
+ transcoder.transcode request_pb
361
+ end
362
+ end
363
+ end
364
+ end
365
+ end
366
+ end
367
+ end
368
+ end
@@ -0,0 +1,52 @@
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
+ require "gapic/rest"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/maps/fleet_engine/v1/version"
24
+
25
+ require "google/maps/fleet_engine/v1/trip_service/credentials"
26
+ require "google/maps/fleet_engine/v1/trip_service/paths"
27
+ require "google/maps/fleet_engine/v1/trip_service/rest/client"
28
+
29
+ module Google
30
+ module Maps
31
+ module FleetEngine
32
+ module V1
33
+ ##
34
+ # Trip management service.
35
+ #
36
+ # To load this service and instantiate a REST client:
37
+ #
38
+ # require "google/maps/fleet_engine/v1/trip_service/rest"
39
+ # client = ::Google::Maps::FleetEngine::V1::TripService::Rest::Client.new
40
+ #
41
+ module TripService
42
+ # Client for the REST transport
43
+ module Rest
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
50
+
51
+ helper_path = ::File.join __dir__, "rest", "helpers.rb"
52
+ require "google/maps/fleet_engine/v1/trip_service/rest/helpers" if ::File.file? helper_path
@@ -0,0 +1,55 @@
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
+ require "gapic/common"
20
+ require "gapic/config"
21
+ require "gapic/config/method"
22
+
23
+ require "google/maps/fleet_engine/v1/version"
24
+
25
+ require "google/maps/fleet_engine/v1/trip_service/credentials"
26
+ require "google/maps/fleet_engine/v1/trip_service/paths"
27
+ require "google/maps/fleet_engine/v1/trip_service/client"
28
+ require "google/maps/fleet_engine/v1/trip_service/rest"
29
+
30
+ module Google
31
+ module Maps
32
+ module FleetEngine
33
+ module V1
34
+ ##
35
+ # Trip management service.
36
+ #
37
+ # @example Load this service and instantiate a gRPC client
38
+ #
39
+ # require "google/maps/fleet_engine/v1/trip_service"
40
+ # client = ::Google::Maps::FleetEngine::V1::TripService::Client.new
41
+ #
42
+ # @example Load this service and instantiate a REST client
43
+ #
44
+ # require "google/maps/fleet_engine/v1/trip_service/rest"
45
+ # client = ::Google::Maps::FleetEngine::V1::TripService::Rest::Client.new
46
+ #
47
+ module TripService
48
+ end
49
+ end
50
+ end
51
+ end
52
+ end
53
+
54
+ helper_path = ::File.join __dir__, "trip_service", "helpers.rb"
55
+ require "google/maps/fleet_engine/v1/trip_service/helpers" if ::File.file? helper_path