@googlemaps/fleetengine-delivery 0.1.0 → 0.3.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.
- package/CHANGELOG.md +16 -0
- package/README.md +4 -2
- package/build/protos/google/geo/type/viewport.proto +1 -1
- package/build/protos/google/maps/fleetengine/delivery/v1/common.proto +4 -2
- package/build/protos/google/maps/fleetengine/delivery/v1/delivery_api.proto +70 -60
- package/build/protos/google/maps/fleetengine/delivery/v1/delivery_vehicles.proto +17 -9
- package/build/protos/google/maps/fleetengine/delivery/v1/header.proto +4 -2
- package/build/protos/google/maps/fleetengine/delivery/v1/task_tracking_info.proto +4 -2
- package/build/protos/google/maps/fleetengine/delivery/v1/tasks.proto +4 -2
- package/build/protos/protos.d.ts +268 -168
- package/build/protos/protos.js +619 -452
- package/build/protos/protos.json +78 -58
- package/build/src/index.js +1 -1
- package/build/src/v1/delivery_service_client.d.ts +79 -152
- package/build/src/v1/delivery_service_client.js +46 -156
- package/build/src/v1/delivery_service_client.js.map +1 -1
- package/build/src/v1/delivery_service_client_config.json +7 -4
- package/build/src/v1/index.js +1 -1
- package/package.json +2 -2
package/build/protos/protos.json
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
{
|
|
2
|
+
"options": {
|
|
3
|
+
"syntax": "proto3"
|
|
4
|
+
},
|
|
2
5
|
"nested": {
|
|
3
6
|
"maps": {
|
|
4
7
|
"nested": {
|
|
@@ -12,8 +15,10 @@
|
|
|
12
15
|
"go_package": "cloud.google.com/go/maps/fleetengine/delivery/apiv1/deliverypb;deliverypb",
|
|
13
16
|
"java_multiple_files": true,
|
|
14
17
|
"java_outer_classname": "Tasks",
|
|
15
|
-
"java_package": "google.maps.fleetengine.delivery.v1",
|
|
18
|
+
"java_package": "com.google.maps.fleetengine.delivery.v1",
|
|
16
19
|
"objc_class_prefix": "CFED",
|
|
20
|
+
"php_namespace": "Google\\Maps\\FleetEngine\\Delivery\\V1",
|
|
21
|
+
"ruby_package": "Google::Maps::FleetEngine::Delivery::V1",
|
|
17
22
|
"(google.api.resource_definition).type": "fleetengine.googleapis.com/Provider",
|
|
18
23
|
"(google.api.resource_definition).pattern": "providers/{provider}"
|
|
19
24
|
},
|
|
@@ -328,6 +333,34 @@
|
|
|
328
333
|
}
|
|
329
334
|
]
|
|
330
335
|
},
|
|
336
|
+
"DeleteDeliveryVehicle": {
|
|
337
|
+
"requestType": "DeleteDeliveryVehicleRequest",
|
|
338
|
+
"responseType": "google.protobuf.Empty",
|
|
339
|
+
"options": {
|
|
340
|
+
"(google.api.http).delete": "/v1/{name=providers/*/deliveryVehicles/*}",
|
|
341
|
+
"(google.api.routing).routing_parameters.field": "name",
|
|
342
|
+
"(google.api.routing).routing_parameters.path_template": "{provider_id=providers/*}",
|
|
343
|
+
"(google.api.method_signature)": "name"
|
|
344
|
+
},
|
|
345
|
+
"parsedOptions": [
|
|
346
|
+
{
|
|
347
|
+
"(google.api.http)": {
|
|
348
|
+
"delete": "/v1/{name=providers/*/deliveryVehicles/*}"
|
|
349
|
+
}
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
"(google.api.routing)": {
|
|
353
|
+
"routing_parameters": {
|
|
354
|
+
"field": "name",
|
|
355
|
+
"path_template": "{provider_id=providers/*}"
|
|
356
|
+
}
|
|
357
|
+
}
|
|
358
|
+
},
|
|
359
|
+
{
|
|
360
|
+
"(google.api.method_signature)": "name"
|
|
361
|
+
}
|
|
362
|
+
]
|
|
363
|
+
},
|
|
331
364
|
"UpdateDeliveryVehicle": {
|
|
332
365
|
"requestType": "UpdateDeliveryVehicleRequest",
|
|
333
366
|
"responseType": "DeliveryVehicle",
|
|
@@ -442,35 +475,31 @@
|
|
|
442
475
|
}
|
|
443
476
|
]
|
|
444
477
|
},
|
|
445
|
-
"
|
|
446
|
-
"requestType": "
|
|
447
|
-
"responseType": "
|
|
478
|
+
"DeleteTask": {
|
|
479
|
+
"requestType": "DeleteTaskRequest",
|
|
480
|
+
"responseType": "google.protobuf.Empty",
|
|
448
481
|
"options": {
|
|
449
|
-
"
|
|
450
|
-
"(google.api.
|
|
451
|
-
"(google.api.routing).routing_parameters.field": "parent",
|
|
482
|
+
"(google.api.http).delete": "/v1/{name=providers/*/tasks/*}",
|
|
483
|
+
"(google.api.routing).routing_parameters.field": "name",
|
|
452
484
|
"(google.api.routing).routing_parameters.path_template": "{provider_id=providers/*}",
|
|
453
|
-
"(google.api.method_signature)": "
|
|
485
|
+
"(google.api.method_signature)": "name"
|
|
454
486
|
},
|
|
455
487
|
"parsedOptions": [
|
|
456
|
-
{
|
|
457
|
-
"deprecated": true
|
|
458
|
-
},
|
|
459
488
|
{
|
|
460
489
|
"(google.api.http)": {
|
|
461
|
-
"
|
|
490
|
+
"delete": "/v1/{name=providers/*/tasks/*}"
|
|
462
491
|
}
|
|
463
492
|
},
|
|
464
493
|
{
|
|
465
494
|
"(google.api.routing)": {
|
|
466
495
|
"routing_parameters": {
|
|
467
|
-
"field": "
|
|
496
|
+
"field": "name",
|
|
468
497
|
"path_template": "{provider_id=providers/*}"
|
|
469
498
|
}
|
|
470
499
|
}
|
|
471
500
|
},
|
|
472
501
|
{
|
|
473
|
-
"(google.api.method_signature)": "
|
|
502
|
+
"(google.api.method_signature)": "name"
|
|
474
503
|
}
|
|
475
504
|
]
|
|
476
505
|
},
|
|
@@ -641,6 +670,25 @@
|
|
|
641
670
|
}
|
|
642
671
|
}
|
|
643
672
|
},
|
|
673
|
+
"DeleteDeliveryVehicleRequest": {
|
|
674
|
+
"fields": {
|
|
675
|
+
"header": {
|
|
676
|
+
"type": "DeliveryRequestHeader",
|
|
677
|
+
"id": 1,
|
|
678
|
+
"options": {
|
|
679
|
+
"(google.api.field_behavior)": "OPTIONAL"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
"name": {
|
|
683
|
+
"type": "string",
|
|
684
|
+
"id": 2,
|
|
685
|
+
"options": {
|
|
686
|
+
"(google.api.field_behavior)": "REQUIRED",
|
|
687
|
+
"(google.api.resource_reference).type": "fleetengine.googleapis.com/DeliveryVehicle"
|
|
688
|
+
}
|
|
689
|
+
}
|
|
690
|
+
}
|
|
691
|
+
},
|
|
644
692
|
"ListDeliveryVehiclesRequest": {
|
|
645
693
|
"fields": {
|
|
646
694
|
"header": {
|
|
@@ -817,10 +865,7 @@
|
|
|
817
865
|
}
|
|
818
866
|
}
|
|
819
867
|
},
|
|
820
|
-
"
|
|
821
|
-
"options": {
|
|
822
|
-
"deprecated": true
|
|
823
|
-
},
|
|
868
|
+
"DeleteTaskRequest": {
|
|
824
869
|
"fields": {
|
|
825
870
|
"header": {
|
|
826
871
|
"type": "DeliveryRequestHeader",
|
|
@@ -829,52 +874,16 @@
|
|
|
829
874
|
"(google.api.field_behavior)": "OPTIONAL"
|
|
830
875
|
}
|
|
831
876
|
},
|
|
832
|
-
"
|
|
833
|
-
"type": "string",
|
|
834
|
-
"id": 3,
|
|
835
|
-
"options": {
|
|
836
|
-
"(google.api.field_behavior)": "REQUIRED"
|
|
837
|
-
}
|
|
838
|
-
},
|
|
839
|
-
"trackingId": {
|
|
840
|
-
"type": "string",
|
|
841
|
-
"id": 4,
|
|
842
|
-
"options": {
|
|
843
|
-
"(google.api.field_behavior)": "REQUIRED"
|
|
844
|
-
}
|
|
845
|
-
},
|
|
846
|
-
"pageSize": {
|
|
847
|
-
"type": "int32",
|
|
848
|
-
"id": 5,
|
|
849
|
-
"options": {
|
|
850
|
-
"(google.api.field_behavior)": "OPTIONAL"
|
|
851
|
-
}
|
|
852
|
-
},
|
|
853
|
-
"pageToken": {
|
|
877
|
+
"name": {
|
|
854
878
|
"type": "string",
|
|
855
|
-
"id":
|
|
879
|
+
"id": 2,
|
|
856
880
|
"options": {
|
|
857
|
-
"(google.api.field_behavior)": "
|
|
881
|
+
"(google.api.field_behavior)": "REQUIRED",
|
|
882
|
+
"(google.api.resource_reference).type": "fleetengine.googleapis.com/Task"
|
|
858
883
|
}
|
|
859
884
|
}
|
|
860
885
|
}
|
|
861
886
|
},
|
|
862
|
-
"SearchTasksResponse": {
|
|
863
|
-
"options": {
|
|
864
|
-
"deprecated": true
|
|
865
|
-
},
|
|
866
|
-
"fields": {
|
|
867
|
-
"tasks": {
|
|
868
|
-
"rule": "repeated",
|
|
869
|
-
"type": "Task",
|
|
870
|
-
"id": 1
|
|
871
|
-
},
|
|
872
|
-
"nextPageToken": {
|
|
873
|
-
"type": "string",
|
|
874
|
-
"id": 2
|
|
875
|
-
}
|
|
876
|
-
}
|
|
877
|
-
},
|
|
878
887
|
"UpdateTaskRequest": {
|
|
879
888
|
"fields": {
|
|
880
889
|
"header": {
|
|
@@ -990,6 +999,14 @@
|
|
|
990
999
|
"type": "DeliveryVehicleLocation",
|
|
991
1000
|
"id": 2
|
|
992
1001
|
},
|
|
1002
|
+
"pastLocations": {
|
|
1003
|
+
"rule": "repeated",
|
|
1004
|
+
"type": "DeliveryVehicleLocation",
|
|
1005
|
+
"id": 12,
|
|
1006
|
+
"options": {
|
|
1007
|
+
"(google.api.field_behavior)": "INPUT_ONLY"
|
|
1008
|
+
}
|
|
1009
|
+
},
|
|
993
1010
|
"navigationStatus": {
|
|
994
1011
|
"type": "DeliveryVehicleNavigationStatus",
|
|
995
1012
|
"id": 3
|
|
@@ -3424,6 +3441,9 @@
|
|
|
3424
3441
|
}
|
|
3425
3442
|
}
|
|
3426
3443
|
},
|
|
3444
|
+
"Empty": {
|
|
3445
|
+
"fields": {}
|
|
3446
|
+
},
|
|
3427
3447
|
"FieldMask": {
|
|
3428
3448
|
"fields": {
|
|
3429
3449
|
"paths": {
|
package/build/src/index.js
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
1
|
import type * as gax from 'google-gax';
|
|
3
2
|
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
|
|
4
3
|
import { Transform } from 'stream';
|
|
@@ -139,6 +138,7 @@ export declare class DeliveryServiceClient {
|
|
|
139
138
|
* Required. The `DeliveryVehicle` entity to create. When creating a new
|
|
140
139
|
* delivery vehicle, you may set the following optional fields:
|
|
141
140
|
*
|
|
141
|
+
* * type
|
|
142
142
|
* * last_location
|
|
143
143
|
* * attributes
|
|
144
144
|
*
|
|
@@ -188,12 +188,43 @@ export declare class DeliveryServiceClient {
|
|
|
188
188
|
]>;
|
|
189
189
|
getDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
190
190
|
getDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
191
|
+
/**
|
|
192
|
+
* Deletes a DeliveryVehicle from the Fleet Engine.
|
|
193
|
+
*
|
|
194
|
+
* Returns FAILED_PRECONDITION if the DeliveryVehicle has OPEN Tasks
|
|
195
|
+
* assigned to it.
|
|
196
|
+
*
|
|
197
|
+
* @param {Object} request
|
|
198
|
+
* The request object that will be sent.
|
|
199
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
200
|
+
* Optional. The standard Delivery API request header.
|
|
201
|
+
* @param {string} request.name
|
|
202
|
+
* Required. Must be in the format
|
|
203
|
+
* `providers/{provider}/deliveryVehicles/{delivery_vehicle}`.
|
|
204
|
+
* The `provider` must be the Google Cloud Project ID. For example,
|
|
205
|
+
* `sample-cloud-project`.
|
|
206
|
+
* @param {object} [options]
|
|
207
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
208
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
209
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
|
210
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
211
|
+
* for more details and examples.
|
|
212
|
+
* @example <caption>include:samples/generated/v1/delivery_service.delete_delivery_vehicle.js</caption>
|
|
213
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_DeleteDeliveryVehicle_async
|
|
214
|
+
*/
|
|
215
|
+
deleteDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest, options?: CallOptions): Promise<[
|
|
216
|
+
protos.google.protobuf.IEmpty,
|
|
217
|
+
(protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | undefined),
|
|
218
|
+
{} | undefined
|
|
219
|
+
]>;
|
|
220
|
+
deleteDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
221
|
+
deleteDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
191
222
|
/**
|
|
192
223
|
* Writes updated `DeliveryVehicle` data to Fleet Engine, and assigns
|
|
193
224
|
* `Tasks` to the `DeliveryVehicle`. You cannot update the name of the
|
|
194
|
-
* `DeliveryVehicle`. You *can* update `remaining_vehicle_journey_segments
|
|
195
|
-
*
|
|
196
|
-
*
|
|
225
|
+
* `DeliveryVehicle`. You *can* update `remaining_vehicle_journey_segments`,
|
|
226
|
+
* but it must contain all of the `VehicleJourneySegment`s to be persisted on
|
|
227
|
+
* the `DeliveryVehicle`. The `task_id`s are retrieved from
|
|
197
228
|
* `remaining_vehicle_journey_segments`, and their corresponding `Tasks` are
|
|
198
229
|
* assigned to the `DeliveryVehicle` if they have not yet been assigned.
|
|
199
230
|
*
|
|
@@ -294,6 +325,12 @@ export declare class DeliveryServiceClient {
|
|
|
294
325
|
* * `planned_location` (optional for `UNAVAILABLE` tasks)
|
|
295
326
|
* * `task_duration`
|
|
296
327
|
*
|
|
328
|
+
* The following fields can be optionally set:
|
|
329
|
+
*
|
|
330
|
+
* * `target_time_window`
|
|
331
|
+
* * `task_tracking_view_config`
|
|
332
|
+
* * `attributes`
|
|
333
|
+
*
|
|
297
334
|
* Note: The Task's `name` field is ignored. All other Task fields must not be
|
|
298
335
|
* set; otherwise, an error is returned.
|
|
299
336
|
* @param {object} [options]
|
|
@@ -339,6 +376,36 @@ export declare class DeliveryServiceClient {
|
|
|
339
376
|
]>;
|
|
340
377
|
getTask(request: protos.maps.fleetengine.delivery.v1.IGetTaskRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
341
378
|
getTask(request: protos.maps.fleetengine.delivery.v1.IGetTaskRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.IGetTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
379
|
+
/**
|
|
380
|
+
* Deletes a single Task.
|
|
381
|
+
*
|
|
382
|
+
* Returns FAILED_PRECONDITION if the Task is OPEN and assigned to a
|
|
383
|
+
* DeliveryVehicle.
|
|
384
|
+
*
|
|
385
|
+
* @param {Object} request
|
|
386
|
+
* The request object that will be sent.
|
|
387
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
388
|
+
* Optional. The standard Delivery API request header.
|
|
389
|
+
* @param {string} request.name
|
|
390
|
+
* Required. Must be in the format `providers/{provider}/tasks/{task}`. The
|
|
391
|
+
* `provider` must be the Google Cloud Project ID. For example,
|
|
392
|
+
* `sample-cloud-project`.
|
|
393
|
+
* @param {object} [options]
|
|
394
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
395
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
396
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
|
397
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
398
|
+
* for more details and examples.
|
|
399
|
+
* @example <caption>include:samples/generated/v1/delivery_service.delete_task.js</caption>
|
|
400
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_DeleteTask_async
|
|
401
|
+
*/
|
|
402
|
+
deleteTask(request?: protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest, options?: CallOptions): Promise<[
|
|
403
|
+
protos.google.protobuf.IEmpty,
|
|
404
|
+
protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest | undefined,
|
|
405
|
+
{} | undefined
|
|
406
|
+
]>;
|
|
407
|
+
deleteTask(request: protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
408
|
+
deleteTask(request: protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.maps.fleetengine.delivery.v1.IDeleteTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
342
409
|
/**
|
|
343
410
|
* Updates `Task` data.
|
|
344
411
|
*
|
|
@@ -414,146 +481,6 @@ export declare class DeliveryServiceClient {
|
|
|
414
481
|
]>;
|
|
415
482
|
getTaskTrackingInfo(request: protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.ITaskTrackingInfo, protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest | null | undefined, {} | null | undefined>): void;
|
|
416
483
|
getTaskTrackingInfo(request: protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.ITaskTrackingInfo, protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest | null | undefined, {} | null | undefined>): void;
|
|
417
|
-
/**
|
|
418
|
-
* Deprecated: Use `GetTaskTrackingInfo` instead.
|
|
419
|
-
*
|
|
420
|
-
* @param {Object} request
|
|
421
|
-
* The request object that will be sent.
|
|
422
|
-
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
423
|
-
* Optional. The standard Delivery API request header.
|
|
424
|
-
* @param {string} request.parent
|
|
425
|
-
* Required. Must be in the format `providers/{provider}`.
|
|
426
|
-
* The provider must be the Google Cloud Project ID. For example,
|
|
427
|
-
* `sample-cloud-project`.
|
|
428
|
-
* @param {string} request.trackingId
|
|
429
|
-
* Required. The identifier of the set of related Tasks being requested.
|
|
430
|
-
* Tracking IDs are subject to the following restrictions:
|
|
431
|
-
*
|
|
432
|
-
* * Must be a valid Unicode string.
|
|
433
|
-
* * Limited to a maximum length of 64 characters.
|
|
434
|
-
* * Normalized according to [Unicode Normalization Form C]
|
|
435
|
-
* (http://www.unicode.org/reports/tr15/).
|
|
436
|
-
* * May not contain any of the following ASCII characters: '/', ':', '?',
|
|
437
|
-
* ',', or '#'.
|
|
438
|
-
* @param {number} [request.pageSize]
|
|
439
|
-
* Optional. The maximum number of Tasks to return. The service may return
|
|
440
|
-
* fewer than this value. If you don't specify this value, then the server
|
|
441
|
-
* determines the number of results to return.
|
|
442
|
-
* @param {string} [request.pageToken]
|
|
443
|
-
* Optional. A page token, received from a previous `SearchTasks` call. You
|
|
444
|
-
* must provide this value to retrieve the subsequent page.
|
|
445
|
-
*
|
|
446
|
-
* When paginating, all other parameters provided to `SearchTasks` must match
|
|
447
|
-
* the call that provided the page token.
|
|
448
|
-
* @param {object} [options]
|
|
449
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
450
|
-
* @returns {Promise} - The promise which resolves to an array.
|
|
451
|
-
* The first element of the array is Array of {@link protos.maps.fleetengine.delivery.v1.Task|Task}.
|
|
452
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
453
|
-
* times as needed and will merge results from all the pages into this array.
|
|
454
|
-
* Note that it can affect your quota.
|
|
455
|
-
* We recommend using `searchTasksAsync()`
|
|
456
|
-
* method described below for async iteration which you can stop as needed.
|
|
457
|
-
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
458
|
-
* for more details and examples.
|
|
459
|
-
* @deprecated SearchTasks is deprecated and may be removed in a future version.
|
|
460
|
-
*/
|
|
461
|
-
searchTasks(request?: protos.maps.fleetengine.delivery.v1.ISearchTasksRequest, options?: CallOptions): Promise<[
|
|
462
|
-
protos.maps.fleetengine.delivery.v1.ITask[],
|
|
463
|
-
protos.maps.fleetengine.delivery.v1.ISearchTasksRequest | null,
|
|
464
|
-
protos.maps.fleetengine.delivery.v1.ISearchTasksResponse
|
|
465
|
-
]>;
|
|
466
|
-
searchTasks(request: protos.maps.fleetengine.delivery.v1.ISearchTasksRequest, options: CallOptions, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.ISearchTasksRequest, protos.maps.fleetengine.delivery.v1.ISearchTasksResponse | null | undefined, protos.maps.fleetengine.delivery.v1.ITask>): void;
|
|
467
|
-
searchTasks(request: protos.maps.fleetengine.delivery.v1.ISearchTasksRequest, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.ISearchTasksRequest, protos.maps.fleetengine.delivery.v1.ISearchTasksResponse | null | undefined, protos.maps.fleetengine.delivery.v1.ITask>): void;
|
|
468
|
-
/**
|
|
469
|
-
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
|
470
|
-
* @param {Object} request
|
|
471
|
-
* The request object that will be sent.
|
|
472
|
-
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
473
|
-
* Optional. The standard Delivery API request header.
|
|
474
|
-
* @param {string} request.parent
|
|
475
|
-
* Required. Must be in the format `providers/{provider}`.
|
|
476
|
-
* The provider must be the Google Cloud Project ID. For example,
|
|
477
|
-
* `sample-cloud-project`.
|
|
478
|
-
* @param {string} request.trackingId
|
|
479
|
-
* Required. The identifier of the set of related Tasks being requested.
|
|
480
|
-
* Tracking IDs are subject to the following restrictions:
|
|
481
|
-
*
|
|
482
|
-
* * Must be a valid Unicode string.
|
|
483
|
-
* * Limited to a maximum length of 64 characters.
|
|
484
|
-
* * Normalized according to [Unicode Normalization Form C]
|
|
485
|
-
* (http://www.unicode.org/reports/tr15/).
|
|
486
|
-
* * May not contain any of the following ASCII characters: '/', ':', '?',
|
|
487
|
-
* ',', or '#'.
|
|
488
|
-
* @param {number} [request.pageSize]
|
|
489
|
-
* Optional. The maximum number of Tasks to return. The service may return
|
|
490
|
-
* fewer than this value. If you don't specify this value, then the server
|
|
491
|
-
* determines the number of results to return.
|
|
492
|
-
* @param {string} [request.pageToken]
|
|
493
|
-
* Optional. A page token, received from a previous `SearchTasks` call. You
|
|
494
|
-
* must provide this value to retrieve the subsequent page.
|
|
495
|
-
*
|
|
496
|
-
* When paginating, all other parameters provided to `SearchTasks` must match
|
|
497
|
-
* the call that provided the page token.
|
|
498
|
-
* @param {object} [options]
|
|
499
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
500
|
-
* @returns {Stream}
|
|
501
|
-
* An object stream which emits an object representing {@link protos.maps.fleetengine.delivery.v1.Task|Task} on 'data' event.
|
|
502
|
-
* The client library will perform auto-pagination by default: it will call the API as many
|
|
503
|
-
* times as needed. Note that it can affect your quota.
|
|
504
|
-
* We recommend using `searchTasksAsync()`
|
|
505
|
-
* method described below for async iteration which you can stop as needed.
|
|
506
|
-
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
507
|
-
* for more details and examples.
|
|
508
|
-
* @deprecated SearchTasks is deprecated and may be removed in a future version.
|
|
509
|
-
*/
|
|
510
|
-
searchTasksStream(request?: protos.maps.fleetengine.delivery.v1.ISearchTasksRequest, options?: CallOptions): Transform;
|
|
511
|
-
/**
|
|
512
|
-
* Equivalent to `searchTasks`, but returns an iterable object.
|
|
513
|
-
*
|
|
514
|
-
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
515
|
-
* @param {Object} request
|
|
516
|
-
* The request object that will be sent.
|
|
517
|
-
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
518
|
-
* Optional. The standard Delivery API request header.
|
|
519
|
-
* @param {string} request.parent
|
|
520
|
-
* Required. Must be in the format `providers/{provider}`.
|
|
521
|
-
* The provider must be the Google Cloud Project ID. For example,
|
|
522
|
-
* `sample-cloud-project`.
|
|
523
|
-
* @param {string} request.trackingId
|
|
524
|
-
* Required. The identifier of the set of related Tasks being requested.
|
|
525
|
-
* Tracking IDs are subject to the following restrictions:
|
|
526
|
-
*
|
|
527
|
-
* * Must be a valid Unicode string.
|
|
528
|
-
* * Limited to a maximum length of 64 characters.
|
|
529
|
-
* * Normalized according to [Unicode Normalization Form C]
|
|
530
|
-
* (http://www.unicode.org/reports/tr15/).
|
|
531
|
-
* * May not contain any of the following ASCII characters: '/', ':', '?',
|
|
532
|
-
* ',', or '#'.
|
|
533
|
-
* @param {number} [request.pageSize]
|
|
534
|
-
* Optional. The maximum number of Tasks to return. The service may return
|
|
535
|
-
* fewer than this value. If you don't specify this value, then the server
|
|
536
|
-
* determines the number of results to return.
|
|
537
|
-
* @param {string} [request.pageToken]
|
|
538
|
-
* Optional. A page token, received from a previous `SearchTasks` call. You
|
|
539
|
-
* must provide this value to retrieve the subsequent page.
|
|
540
|
-
*
|
|
541
|
-
* When paginating, all other parameters provided to `SearchTasks` must match
|
|
542
|
-
* the call that provided the page token.
|
|
543
|
-
* @param {object} [options]
|
|
544
|
-
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
545
|
-
* @returns {Object}
|
|
546
|
-
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
547
|
-
* When you iterate the returned iterable, each element will be an object representing
|
|
548
|
-
* {@link protos.maps.fleetengine.delivery.v1.Task|Task}. The API will be called under the hood as needed, once per the page,
|
|
549
|
-
* so you can stop the iteration when you don't need more results.
|
|
550
|
-
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
551
|
-
* for more details and examples.
|
|
552
|
-
* @example <caption>include:samples/generated/v1/delivery_service.search_tasks.js</caption>
|
|
553
|
-
* region_tag:fleetengine_v1_generated_DeliveryService_SearchTasks_async
|
|
554
|
-
* @deprecated SearchTasks is deprecated and may be removed in a future version.
|
|
555
|
-
*/
|
|
556
|
-
searchTasksAsync(request?: protos.maps.fleetengine.delivery.v1.ISearchTasksRequest, options?: CallOptions): AsyncIterable<protos.maps.fleetengine.delivery.v1.ITask>;
|
|
557
484
|
/**
|
|
558
485
|
* Gets all `Task`s that meet the specified filtering criteria.
|
|
559
486
|
*
|
|
@@ -579,8 +506,8 @@ export declare class DeliveryServiceClient {
|
|
|
579
506
|
* Optional. A filter query to apply when listing Tasks. See
|
|
580
507
|
* http://aip.dev/160 for examples of filter syntax. If you don't specify a
|
|
581
508
|
* value, or if you filter on an empty string, then all Tasks are returned.
|
|
582
|
-
* For information about the Task properties that you can filter on, see [
|
|
583
|
-
*
|
|
509
|
+
* For information about the Task properties that you can filter on, see [List
|
|
510
|
+
* tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/journeys/tasks/find-tasks#filter_listed_tasks).
|
|
584
511
|
* @param {object} [options]
|
|
585
512
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
586
513
|
* @returns {Promise} - The promise which resolves to an array.
|
|
@@ -601,7 +528,7 @@ export declare class DeliveryServiceClient {
|
|
|
601
528
|
listTasks(request: protos.maps.fleetengine.delivery.v1.IListTasksRequest, options: CallOptions, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListTasksRequest, protos.maps.fleetengine.delivery.v1.IListTasksResponse | null | undefined, protos.maps.fleetengine.delivery.v1.ITask>): void;
|
|
602
529
|
listTasks(request: protos.maps.fleetengine.delivery.v1.IListTasksRequest, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListTasksRequest, protos.maps.fleetengine.delivery.v1.IListTasksResponse | null | undefined, protos.maps.fleetengine.delivery.v1.ITask>): void;
|
|
603
530
|
/**
|
|
604
|
-
* Equivalent to `
|
|
531
|
+
* Equivalent to `listTasks`, but returns a NodeJS Stream object.
|
|
605
532
|
* @param {Object} request
|
|
606
533
|
* The request object that will be sent.
|
|
607
534
|
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
@@ -624,8 +551,8 @@ export declare class DeliveryServiceClient {
|
|
|
624
551
|
* Optional. A filter query to apply when listing Tasks. See
|
|
625
552
|
* http://aip.dev/160 for examples of filter syntax. If you don't specify a
|
|
626
553
|
* value, or if you filter on an empty string, then all Tasks are returned.
|
|
627
|
-
* For information about the Task properties that you can filter on, see [
|
|
628
|
-
*
|
|
554
|
+
* For information about the Task properties that you can filter on, see [List
|
|
555
|
+
* tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/journeys/tasks/find-tasks#filter_listed_tasks).
|
|
629
556
|
* @param {object} [options]
|
|
630
557
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
631
558
|
* @returns {Stream}
|
|
@@ -664,8 +591,8 @@ export declare class DeliveryServiceClient {
|
|
|
664
591
|
* Optional. A filter query to apply when listing Tasks. See
|
|
665
592
|
* http://aip.dev/160 for examples of filter syntax. If you don't specify a
|
|
666
593
|
* value, or if you filter on an empty string, then all Tasks are returned.
|
|
667
|
-
* For information about the Task properties that you can filter on, see [
|
|
668
|
-
*
|
|
594
|
+
* For information about the Task properties that you can filter on, see [List
|
|
595
|
+
* tasks](https://developers.google.com/maps/documentation/mobility/fleet-engine/journeys/tasks/find-tasks#filter_listed_tasks).
|
|
669
596
|
* @param {object} [options]
|
|
670
597
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
671
598
|
* @returns {Object}
|
|
@@ -742,7 +669,7 @@ export declare class DeliveryServiceClient {
|
|
|
742
669
|
listDeliveryVehicles(request: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, options: CallOptions, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesResponse | null | undefined, protos.maps.fleetengine.delivery.v1.IDeliveryVehicle>): void;
|
|
743
670
|
listDeliveryVehicles(request: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, callback: PaginationCallback<protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesResponse | null | undefined, protos.maps.fleetengine.delivery.v1.IDeliveryVehicle>): void;
|
|
744
671
|
/**
|
|
745
|
-
* Equivalent to `
|
|
672
|
+
* Equivalent to `listDeliveryVehicles`, but returns a NodeJS Stream object.
|
|
746
673
|
* @param {Object} request
|
|
747
674
|
* The request object that will be sent.
|
|
748
675
|
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|