@googlemaps/fleetengine-delivery 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.
- package/CHANGELOG.md +10 -0
- package/LICENSE +202 -0
- package/README.md +226 -0
- package/build/protos/google/geo/type/viewport.proto +69 -0
- package/build/protos/google/maps/fleetengine/delivery/v1/common.proto +247 -0
- package/build/protos/google/maps/fleetengine/delivery/v1/delivery_api.proto +597 -0
- package/build/protos/google/maps/fleetengine/delivery/v1/delivery_vehicles.proto +269 -0
- package/build/protos/google/maps/fleetengine/delivery/v1/header.proto +108 -0
- package/build/protos/google/maps/fleetengine/delivery/v1/task_tracking_info.proto +98 -0
- package/build/protos/google/maps/fleetengine/delivery/v1/tasks.proto +288 -0
- package/build/protos/protos.d.ts +11926 -0
- package/build/protos/protos.js +32304 -0
- package/build/protos/protos.json +3441 -0
- package/build/src/index.d.ts +11 -0
- package/build/src/index.js +28 -0
- package/build/src/index.js.map +1 -0
- package/build/src/v1/delivery_service_client.d.ts +949 -0
- package/build/src/v1/delivery_service_client.js +1210 -0
- package/build/src/v1/delivery_service_client.js.map +1 -0
- package/build/src/v1/delivery_service_client_config.json +93 -0
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +23 -0
- package/build/src/v1/index.js.map +1 -0
- package/package.json +70 -0
|
@@ -0,0 +1,949 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import type * as gax from 'google-gax';
|
|
3
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallback } from 'google-gax';
|
|
4
|
+
import { Transform } from 'stream';
|
|
5
|
+
import * as protos from '../../protos/protos';
|
|
6
|
+
/**
|
|
7
|
+
* The Last Mile Delivery service.
|
|
8
|
+
* @class
|
|
9
|
+
* @memberof v1
|
|
10
|
+
*/
|
|
11
|
+
export declare class DeliveryServiceClient {
|
|
12
|
+
private _terminated;
|
|
13
|
+
private _opts;
|
|
14
|
+
private _providedCustomServicePath;
|
|
15
|
+
private _gaxModule;
|
|
16
|
+
private _gaxGrpc;
|
|
17
|
+
private _protos;
|
|
18
|
+
private _defaults;
|
|
19
|
+
private _universeDomain;
|
|
20
|
+
private _servicePath;
|
|
21
|
+
auth: gax.GoogleAuth;
|
|
22
|
+
descriptors: Descriptors;
|
|
23
|
+
warn: (code: string, message: string, warnType?: string) => void;
|
|
24
|
+
innerApiCalls: {
|
|
25
|
+
[name: string]: Function;
|
|
26
|
+
};
|
|
27
|
+
pathTemplates: {
|
|
28
|
+
[name: string]: gax.PathTemplate;
|
|
29
|
+
};
|
|
30
|
+
deliveryServiceStub?: Promise<{
|
|
31
|
+
[name: string]: Function;
|
|
32
|
+
}>;
|
|
33
|
+
/**
|
|
34
|
+
* Construct an instance of DeliveryServiceClient.
|
|
35
|
+
*
|
|
36
|
+
* @param {object} [options] - The configuration object.
|
|
37
|
+
* The options accepted by the constructor are described in detail
|
|
38
|
+
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
|
|
39
|
+
* The common options are:
|
|
40
|
+
* @param {object} [options.credentials] - Credentials object.
|
|
41
|
+
* @param {string} [options.credentials.client_email]
|
|
42
|
+
* @param {string} [options.credentials.private_key]
|
|
43
|
+
* @param {string} [options.email] - Account email address. Required when
|
|
44
|
+
* using a .pem or .p12 keyFilename.
|
|
45
|
+
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
|
|
46
|
+
* .p12 key downloaded from the Google Developers Console. If you provide
|
|
47
|
+
* a path to a JSON file, the projectId option below is not necessary.
|
|
48
|
+
* NOTE: .pem and .p12 require you to specify options.email as well.
|
|
49
|
+
* @param {number} [options.port] - The port on which to connect to
|
|
50
|
+
* the remote host.
|
|
51
|
+
* @param {string} [options.projectId] - The project ID from the Google
|
|
52
|
+
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
|
|
53
|
+
* the environment variable GCLOUD_PROJECT for your project ID. If your
|
|
54
|
+
* app is running in an environment which supports
|
|
55
|
+
* {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
|
|
56
|
+
* your project ID will be detected automatically.
|
|
57
|
+
* @param {string} [options.apiEndpoint] - The domain name of the
|
|
58
|
+
* API remote host.
|
|
59
|
+
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
|
60
|
+
* Follows the structure of {@link gapicConfig}.
|
|
61
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
|
62
|
+
* For more information, please check the
|
|
63
|
+
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
|
64
|
+
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
|
65
|
+
* need to avoid loading the default gRPC version and want to use the fallback
|
|
66
|
+
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
|
67
|
+
* ```
|
|
68
|
+
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
|
69
|
+
* const client = new DeliveryServiceClient({fallback: true}, gax);
|
|
70
|
+
* ```
|
|
71
|
+
*/
|
|
72
|
+
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
|
73
|
+
/**
|
|
74
|
+
* Initialize the client.
|
|
75
|
+
* Performs asynchronous operations (such as authentication) and prepares the client.
|
|
76
|
+
* This function will be called automatically when any class method is called for the
|
|
77
|
+
* first time, but if you need to initialize it before calling an actual method,
|
|
78
|
+
* feel free to call initialize() directly.
|
|
79
|
+
*
|
|
80
|
+
* You can await on this method if you want to make sure the client is initialized.
|
|
81
|
+
*
|
|
82
|
+
* @returns {Promise} A promise that resolves to an authenticated service stub.
|
|
83
|
+
*/
|
|
84
|
+
initialize(): Promise<{
|
|
85
|
+
[name: string]: Function;
|
|
86
|
+
}>;
|
|
87
|
+
/**
|
|
88
|
+
* The DNS address for this API service.
|
|
89
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
|
90
|
+
* @returns {string} The DNS address for this service.
|
|
91
|
+
*/
|
|
92
|
+
static get servicePath(): string;
|
|
93
|
+
/**
|
|
94
|
+
* The DNS address for this API service - same as servicePath.
|
|
95
|
+
* @deprecated Use the apiEndpoint method of the client instance.
|
|
96
|
+
* @returns {string} The DNS address for this service.
|
|
97
|
+
*/
|
|
98
|
+
static get apiEndpoint(): string;
|
|
99
|
+
/**
|
|
100
|
+
* The DNS address for this API service.
|
|
101
|
+
* @returns {string} The DNS address for this service.
|
|
102
|
+
*/
|
|
103
|
+
get apiEndpoint(): string;
|
|
104
|
+
get universeDomain(): string;
|
|
105
|
+
/**
|
|
106
|
+
* The port for this API service.
|
|
107
|
+
* @returns {number} The default port for this service.
|
|
108
|
+
*/
|
|
109
|
+
static get port(): number;
|
|
110
|
+
/**
|
|
111
|
+
* The scopes needed to make gRPC calls for every method defined
|
|
112
|
+
* in this service.
|
|
113
|
+
* @returns {string[]} List of default scopes.
|
|
114
|
+
*/
|
|
115
|
+
static get scopes(): string[];
|
|
116
|
+
getProjectId(): Promise<string>;
|
|
117
|
+
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
|
118
|
+
/**
|
|
119
|
+
* Creates and returns a new `DeliveryVehicle`.
|
|
120
|
+
*
|
|
121
|
+
* @param {Object} request
|
|
122
|
+
* The request object that will be sent.
|
|
123
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
124
|
+
* Optional. The standard Delivery API request header.
|
|
125
|
+
* @param {string} request.parent
|
|
126
|
+
* Required. Must be in the format `providers/{provider}`. The provider must
|
|
127
|
+
* be the Google Cloud Project ID. For example, `sample-cloud-project`.
|
|
128
|
+
* @param {string} request.deliveryVehicleId
|
|
129
|
+
* Required. The Delivery Vehicle ID must be unique and subject to the
|
|
130
|
+
* following restrictions:
|
|
131
|
+
*
|
|
132
|
+
* * Must be a valid Unicode string.
|
|
133
|
+
* * Limited to a maximum length of 64 characters.
|
|
134
|
+
* * Normalized according to [Unicode Normalization Form C]
|
|
135
|
+
* (http://www.unicode.org/reports/tr15/).
|
|
136
|
+
* * May not contain any of the following ASCII characters: '/', ':', '?',
|
|
137
|
+
* ',', or '#'.
|
|
138
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryVehicle} request.deliveryVehicle
|
|
139
|
+
* Required. The `DeliveryVehicle` entity to create. When creating a new
|
|
140
|
+
* delivery vehicle, you may set the following optional fields:
|
|
141
|
+
*
|
|
142
|
+
* * last_location
|
|
143
|
+
* * attributes
|
|
144
|
+
*
|
|
145
|
+
* Note: The DeliveryVehicle's `name` field is ignored. All other
|
|
146
|
+
* DeliveryVehicle fields must not be set; otherwise, an error is returned.
|
|
147
|
+
* @param {object} [options]
|
|
148
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
149
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
150
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle}.
|
|
151
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
152
|
+
* for more details and examples.
|
|
153
|
+
* @example <caption>include:samples/generated/v1/delivery_service.create_delivery_vehicle.js</caption>
|
|
154
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_CreateDeliveryVehicle_async
|
|
155
|
+
*/
|
|
156
|
+
createDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest, options?: CallOptions): Promise<[
|
|
157
|
+
protos.maps.fleetengine.delivery.v1.IDeliveryVehicle,
|
|
158
|
+
(protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest | undefined),
|
|
159
|
+
{} | undefined
|
|
160
|
+
]>;
|
|
161
|
+
createDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
162
|
+
createDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.ICreateDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
163
|
+
/**
|
|
164
|
+
* Returns the specified `DeliveryVehicle` instance.
|
|
165
|
+
*
|
|
166
|
+
* @param {Object} request
|
|
167
|
+
* The request object that will be sent.
|
|
168
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
169
|
+
* Optional. The standard Delivery API request header.
|
|
170
|
+
* @param {string} request.name
|
|
171
|
+
* Required. Must be in the format
|
|
172
|
+
* `providers/{provider}/deliveryVehicles/{delivery_vehicle}`.
|
|
173
|
+
* The `provider` must be the Google Cloud Project ID. For example,
|
|
174
|
+
* `sample-cloud-project`.
|
|
175
|
+
* @param {object} [options]
|
|
176
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
177
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
178
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle}.
|
|
179
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
180
|
+
* for more details and examples.
|
|
181
|
+
* @example <caption>include:samples/generated/v1/delivery_service.get_delivery_vehicle.js</caption>
|
|
182
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_GetDeliveryVehicle_async
|
|
183
|
+
*/
|
|
184
|
+
getDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest, options?: CallOptions): Promise<[
|
|
185
|
+
protos.maps.fleetengine.delivery.v1.IDeliveryVehicle,
|
|
186
|
+
(protos.maps.fleetengine.delivery.v1.IGetDeliveryVehicleRequest | undefined),
|
|
187
|
+
{} | undefined
|
|
188
|
+
]>;
|
|
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
|
+
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
|
+
* Writes updated `DeliveryVehicle` data to Fleet Engine, and assigns
|
|
193
|
+
* `Tasks` to the `DeliveryVehicle`. You cannot update the name of the
|
|
194
|
+
* `DeliveryVehicle`. You *can* update `remaining_vehicle_journey_segments`
|
|
195
|
+
* though, but it must contain all of the `VehicleJourneySegment`s currently
|
|
196
|
+
* on the `DeliveryVehicle`. The `task_id`s are retrieved from
|
|
197
|
+
* `remaining_vehicle_journey_segments`, and their corresponding `Tasks` are
|
|
198
|
+
* assigned to the `DeliveryVehicle` if they have not yet been assigned.
|
|
199
|
+
*
|
|
200
|
+
* @param {Object} request
|
|
201
|
+
* The request object that will be sent.
|
|
202
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
203
|
+
* Optional. The standard Delivery API request header.
|
|
204
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryVehicle} request.deliveryVehicle
|
|
205
|
+
* Required. The `DeliveryVehicle` entity update to apply.
|
|
206
|
+
* Note: You cannot update the name of the `DeliveryVehicle`.
|
|
207
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
|
208
|
+
* Required. A field mask that indicates which `DeliveryVehicle` fields to
|
|
209
|
+
* update. Note that the update_mask must contain at least one field.
|
|
210
|
+
*
|
|
211
|
+
* This is a comma-separated list of fully qualified names of fields. Example:
|
|
212
|
+
* `"remaining_vehicle_journey_segments"`.
|
|
213
|
+
* @param {object} [options]
|
|
214
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
215
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
216
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle}.
|
|
217
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
218
|
+
* for more details and examples.
|
|
219
|
+
* @example <caption>include:samples/generated/v1/delivery_service.update_delivery_vehicle.js</caption>
|
|
220
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_UpdateDeliveryVehicle_async
|
|
221
|
+
*/
|
|
222
|
+
updateDeliveryVehicle(request?: protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest, options?: CallOptions): Promise<[
|
|
223
|
+
protos.maps.fleetengine.delivery.v1.IDeliveryVehicle,
|
|
224
|
+
(protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest | undefined),
|
|
225
|
+
{} | undefined
|
|
226
|
+
]>;
|
|
227
|
+
updateDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
228
|
+
updateDeliveryVehicle(request: protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle, protos.maps.fleetengine.delivery.v1.IUpdateDeliveryVehicleRequest | null | undefined, {} | null | undefined>): void;
|
|
229
|
+
/**
|
|
230
|
+
* Creates and returns a batch of new `Task` objects.
|
|
231
|
+
*
|
|
232
|
+
* @param {Object} request
|
|
233
|
+
* The request object that will be sent.
|
|
234
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
235
|
+
* Optional. The standard Delivery API request header.
|
|
236
|
+
* Note: If you set this field, then the header field in the
|
|
237
|
+
* `CreateTaskRequest` messages must either be empty, or it must match this
|
|
238
|
+
* field.
|
|
239
|
+
* @param {string} request.parent
|
|
240
|
+
* Required. The parent resource shared by all tasks. This value must be in
|
|
241
|
+
* the format `providers/{provider}`. The `provider` must be the Google Cloud
|
|
242
|
+
* Project ID. For example, `sample-cloud-project`. The parent field in the
|
|
243
|
+
* `CreateTaskRequest` messages must either be empty, or it must match this
|
|
244
|
+
* field.
|
|
245
|
+
* @param {number[]} request.requests
|
|
246
|
+
* Required. The request message that specifies the resources to create.
|
|
247
|
+
* Note: You can create a maximum of 500 tasks in a batch.
|
|
248
|
+
* @param {object} [options]
|
|
249
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
250
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
251
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.BatchCreateTasksResponse|BatchCreateTasksResponse}.
|
|
252
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
253
|
+
* for more details and examples.
|
|
254
|
+
* @example <caption>include:samples/generated/v1/delivery_service.batch_create_tasks.js</caption>
|
|
255
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_BatchCreateTasks_async
|
|
256
|
+
*/
|
|
257
|
+
batchCreateTasks(request?: protos.maps.fleetengine.delivery.v1.IBatchCreateTasksRequest, options?: CallOptions): Promise<[
|
|
258
|
+
protos.maps.fleetengine.delivery.v1.IBatchCreateTasksResponse,
|
|
259
|
+
protos.maps.fleetengine.delivery.v1.IBatchCreateTasksRequest | undefined,
|
|
260
|
+
{} | undefined
|
|
261
|
+
]>;
|
|
262
|
+
batchCreateTasks(request: protos.maps.fleetengine.delivery.v1.IBatchCreateTasksRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.IBatchCreateTasksResponse, protos.maps.fleetengine.delivery.v1.IBatchCreateTasksRequest | null | undefined, {} | null | undefined>): void;
|
|
263
|
+
batchCreateTasks(request: protos.maps.fleetengine.delivery.v1.IBatchCreateTasksRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.IBatchCreateTasksResponse, protos.maps.fleetengine.delivery.v1.IBatchCreateTasksRequest | null | undefined, {} | null | undefined>): void;
|
|
264
|
+
/**
|
|
265
|
+
* Creates and returns a new `Task` object.
|
|
266
|
+
*
|
|
267
|
+
* @param {Object} request
|
|
268
|
+
* The request object that will be sent.
|
|
269
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
270
|
+
* Optional. The standard Delivery API request header.
|
|
271
|
+
* @param {string} request.parent
|
|
272
|
+
* Required. Must be in the format `providers/{provider}`. The `provider` must
|
|
273
|
+
* be the Google Cloud Project ID. For example, `sample-cloud-project`.
|
|
274
|
+
* @param {string} request.taskId
|
|
275
|
+
* Required. The Task ID must be unique, but it should be not a shipment
|
|
276
|
+
* tracking ID. To store a shipment tracking ID, use the `tracking_id` field.
|
|
277
|
+
* Note that multiple tasks can have the same `tracking_id`. Task IDs are
|
|
278
|
+
* subject to the following restrictions:
|
|
279
|
+
*
|
|
280
|
+
* * Must be a valid Unicode string.
|
|
281
|
+
* * Limited to a maximum length of 64 characters.
|
|
282
|
+
* * Normalized according to [Unicode Normalization Form C]
|
|
283
|
+
* (http://www.unicode.org/reports/tr15/).
|
|
284
|
+
* * May not contain any of the following ASCII characters: '/', ':', '?',
|
|
285
|
+
* ',', or '#'.
|
|
286
|
+
* @param {maps.fleetengine.delivery.v1.Task} request.task
|
|
287
|
+
* Required. The Task entity to create.
|
|
288
|
+
* When creating a Task, the following fields are required:
|
|
289
|
+
*
|
|
290
|
+
* * `type`
|
|
291
|
+
* * `state` (must be set to `OPEN`)
|
|
292
|
+
* * `tracking_id` (must not be set for `UNAVAILABLE` or `SCHEDULED_STOP`
|
|
293
|
+
* tasks, but required for all other task types)
|
|
294
|
+
* * `planned_location` (optional for `UNAVAILABLE` tasks)
|
|
295
|
+
* * `task_duration`
|
|
296
|
+
*
|
|
297
|
+
* Note: The Task's `name` field is ignored. All other Task fields must not be
|
|
298
|
+
* set; otherwise, an error is returned.
|
|
299
|
+
* @param {object} [options]
|
|
300
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
301
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
302
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.Task|Task}.
|
|
303
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
304
|
+
* for more details and examples.
|
|
305
|
+
* @example <caption>include:samples/generated/v1/delivery_service.create_task.js</caption>
|
|
306
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_CreateTask_async
|
|
307
|
+
*/
|
|
308
|
+
createTask(request?: protos.maps.fleetengine.delivery.v1.ICreateTaskRequest, options?: CallOptions): Promise<[
|
|
309
|
+
protos.maps.fleetengine.delivery.v1.ITask,
|
|
310
|
+
protos.maps.fleetengine.delivery.v1.ICreateTaskRequest | undefined,
|
|
311
|
+
{} | undefined
|
|
312
|
+
]>;
|
|
313
|
+
createTask(request: protos.maps.fleetengine.delivery.v1.ICreateTaskRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.ICreateTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
314
|
+
createTask(request: protos.maps.fleetengine.delivery.v1.ICreateTaskRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.ICreateTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
315
|
+
/**
|
|
316
|
+
* Gets information about a `Task`.
|
|
317
|
+
*
|
|
318
|
+
* @param {Object} request
|
|
319
|
+
* The request object that will be sent.
|
|
320
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
321
|
+
* Optional. The standard Delivery API request header.
|
|
322
|
+
* @param {string} request.name
|
|
323
|
+
* Required. Must be in the format `providers/{provider}/tasks/{task}`. The
|
|
324
|
+
* `provider` must be the Google Cloud Project ID. For example,
|
|
325
|
+
* `sample-cloud-project`.
|
|
326
|
+
* @param {object} [options]
|
|
327
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
328
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
329
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.Task|Task}.
|
|
330
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
331
|
+
* for more details and examples.
|
|
332
|
+
* @example <caption>include:samples/generated/v1/delivery_service.get_task.js</caption>
|
|
333
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_GetTask_async
|
|
334
|
+
*/
|
|
335
|
+
getTask(request?: protos.maps.fleetengine.delivery.v1.IGetTaskRequest, options?: CallOptions): Promise<[
|
|
336
|
+
protos.maps.fleetengine.delivery.v1.ITask,
|
|
337
|
+
protos.maps.fleetengine.delivery.v1.IGetTaskRequest | undefined,
|
|
338
|
+
{} | undefined
|
|
339
|
+
]>;
|
|
340
|
+
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
|
+
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;
|
|
342
|
+
/**
|
|
343
|
+
* Updates `Task` data.
|
|
344
|
+
*
|
|
345
|
+
* @param {Object} request
|
|
346
|
+
* The request object that will be sent.
|
|
347
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
348
|
+
* Optional. The standard Delivery API request header.
|
|
349
|
+
* @param {maps.fleetengine.delivery.v1.Task} request.task
|
|
350
|
+
* Required. The Task associated with the update.
|
|
351
|
+
* The following fields are maintained by Fleet Engine. Do not update
|
|
352
|
+
* them using `Task.update`.
|
|
353
|
+
*
|
|
354
|
+
* * `last_location`.
|
|
355
|
+
* * `last_location_snappable`.
|
|
356
|
+
* * `name`.
|
|
357
|
+
* * `remaining_vehicle_journey_segments`.
|
|
358
|
+
* * `task_outcome_location_source`.
|
|
359
|
+
*
|
|
360
|
+
* Note: You cannot change the value of `task_outcome` once you set it.
|
|
361
|
+
*
|
|
362
|
+
* If the Task has been assigned to a delivery vehicle, then don't set the
|
|
363
|
+
* Task state to CLOSED using `Task.update`. Instead, remove the `VehicleStop`
|
|
364
|
+
* that contains the Task from the delivery vehicle, which automatically sets
|
|
365
|
+
* the Task state to CLOSED.
|
|
366
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
|
367
|
+
* Required. The field mask that indicates which Task fields to update.
|
|
368
|
+
* Note: The `update_mask` must contain at least one field.
|
|
369
|
+
*
|
|
370
|
+
* This is a comma-separated list of fully qualified names of fields. Example:
|
|
371
|
+
* `"task_outcome,task_outcome_time,task_outcome_location"`.
|
|
372
|
+
* @param {object} [options]
|
|
373
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
374
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
375
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.Task|Task}.
|
|
376
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
377
|
+
* for more details and examples.
|
|
378
|
+
* @example <caption>include:samples/generated/v1/delivery_service.update_task.js</caption>
|
|
379
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_UpdateTask_async
|
|
380
|
+
*/
|
|
381
|
+
updateTask(request?: protos.maps.fleetengine.delivery.v1.IUpdateTaskRequest, options?: CallOptions): Promise<[
|
|
382
|
+
protos.maps.fleetengine.delivery.v1.ITask,
|
|
383
|
+
protos.maps.fleetengine.delivery.v1.IUpdateTaskRequest | undefined,
|
|
384
|
+
{} | undefined
|
|
385
|
+
]>;
|
|
386
|
+
updateTask(request: protos.maps.fleetengine.delivery.v1.IUpdateTaskRequest, options: CallOptions, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.IUpdateTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
387
|
+
updateTask(request: protos.maps.fleetengine.delivery.v1.IUpdateTaskRequest, callback: Callback<protos.maps.fleetengine.delivery.v1.ITask, protos.maps.fleetengine.delivery.v1.IUpdateTaskRequest | null | undefined, {} | null | undefined>): void;
|
|
388
|
+
/**
|
|
389
|
+
* Returns the specified `TaskTrackingInfo` instance.
|
|
390
|
+
*
|
|
391
|
+
* @param {Object} request
|
|
392
|
+
* The request object that will be sent.
|
|
393
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
394
|
+
* Optional. The standard Delivery API request header.
|
|
395
|
+
* @param {string} request.name
|
|
396
|
+
* Required. Must be in the format
|
|
397
|
+
* `providers/{provider}/taskTrackingInfo/{tracking_id}`. The `provider`
|
|
398
|
+
* must be the Google Cloud Project ID, and the `tracking_id` must be the
|
|
399
|
+
* tracking ID associated with the task. An example name can be
|
|
400
|
+
* `providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id`.
|
|
401
|
+
* @param {object} [options]
|
|
402
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
403
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
404
|
+
* The first element of the array is an object representing {@link protos.maps.fleetengine.delivery.v1.TaskTrackingInfo|TaskTrackingInfo}.
|
|
405
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
406
|
+
* for more details and examples.
|
|
407
|
+
* @example <caption>include:samples/generated/v1/delivery_service.get_task_tracking_info.js</caption>
|
|
408
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_GetTaskTrackingInfo_async
|
|
409
|
+
*/
|
|
410
|
+
getTaskTrackingInfo(request?: protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest, options?: CallOptions): Promise<[
|
|
411
|
+
protos.maps.fleetengine.delivery.v1.ITaskTrackingInfo,
|
|
412
|
+
(protos.maps.fleetengine.delivery.v1.IGetTaskTrackingInfoRequest | undefined),
|
|
413
|
+
{} | undefined
|
|
414
|
+
]>;
|
|
415
|
+
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
|
+
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
|
+
/**
|
|
558
|
+
* Gets all `Task`s that meet the specified filtering criteria.
|
|
559
|
+
*
|
|
560
|
+
* @param {Object} request
|
|
561
|
+
* The request object that will be sent.
|
|
562
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
563
|
+
* Optional. The standard Delivery API request header.
|
|
564
|
+
* @param {string} request.parent
|
|
565
|
+
* Required. Must be in the format `providers/{provider}`.
|
|
566
|
+
* The `provider` must be the Google Cloud Project ID. For example,
|
|
567
|
+
* `sample-cloud-project`.
|
|
568
|
+
* @param {number} [request.pageSize]
|
|
569
|
+
* Optional. The maximum number of Tasks to return. The service may return
|
|
570
|
+
* fewer than this value. If you don't specify this value, then the server
|
|
571
|
+
* determines the number of results to return.
|
|
572
|
+
* @param {string} [request.pageToken]
|
|
573
|
+
* Optional. A page token received from a previous `ListTasks` call.
|
|
574
|
+
* You can provide this to retrieve the subsequent page.
|
|
575
|
+
*
|
|
576
|
+
* When paginating, all other parameters provided to `ListTasks` must match
|
|
577
|
+
* the call that provided the page token.
|
|
578
|
+
* @param {string} [request.filter]
|
|
579
|
+
* Optional. A filter query to apply when listing Tasks. See
|
|
580
|
+
* http://aip.dev/160 for examples of filter syntax. If you don't specify a
|
|
581
|
+
* 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 [Task
|
|
583
|
+
* list](/maps/documentation/transportation-logistics/last-mile-fleet-solution/fleet-performance/fleet-engine/deliveries_api#list_tasks).
|
|
584
|
+
* @param {object} [options]
|
|
585
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
586
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
587
|
+
* The first element of the array is Array of {@link protos.maps.fleetengine.delivery.v1.Task|Task}.
|
|
588
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
589
|
+
* times as needed and will merge results from all the pages into this array.
|
|
590
|
+
* Note that it can affect your quota.
|
|
591
|
+
* We recommend using `listTasksAsync()`
|
|
592
|
+
* method described below for async iteration which you can stop as needed.
|
|
593
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
594
|
+
* for more details and examples.
|
|
595
|
+
*/
|
|
596
|
+
listTasks(request?: protos.maps.fleetengine.delivery.v1.IListTasksRequest, options?: CallOptions): Promise<[
|
|
597
|
+
protos.maps.fleetengine.delivery.v1.ITask[],
|
|
598
|
+
protos.maps.fleetengine.delivery.v1.IListTasksRequest | null,
|
|
599
|
+
protos.maps.fleetengine.delivery.v1.IListTasksResponse
|
|
600
|
+
]>;
|
|
601
|
+
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
|
+
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
|
+
/**
|
|
604
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
|
605
|
+
* @param {Object} request
|
|
606
|
+
* The request object that will be sent.
|
|
607
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
608
|
+
* Optional. The standard Delivery API request header.
|
|
609
|
+
* @param {string} request.parent
|
|
610
|
+
* Required. Must be in the format `providers/{provider}`.
|
|
611
|
+
* The `provider` must be the Google Cloud Project ID. For example,
|
|
612
|
+
* `sample-cloud-project`.
|
|
613
|
+
* @param {number} [request.pageSize]
|
|
614
|
+
* Optional. The maximum number of Tasks to return. The service may return
|
|
615
|
+
* fewer than this value. If you don't specify this value, then the server
|
|
616
|
+
* determines the number of results to return.
|
|
617
|
+
* @param {string} [request.pageToken]
|
|
618
|
+
* Optional. A page token received from a previous `ListTasks` call.
|
|
619
|
+
* You can provide this to retrieve the subsequent page.
|
|
620
|
+
*
|
|
621
|
+
* When paginating, all other parameters provided to `ListTasks` must match
|
|
622
|
+
* the call that provided the page token.
|
|
623
|
+
* @param {string} [request.filter]
|
|
624
|
+
* Optional. A filter query to apply when listing Tasks. See
|
|
625
|
+
* http://aip.dev/160 for examples of filter syntax. If you don't specify a
|
|
626
|
+
* 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 [Task
|
|
628
|
+
* list](/maps/documentation/transportation-logistics/last-mile-fleet-solution/fleet-performance/fleet-engine/deliveries_api#list_tasks).
|
|
629
|
+
* @param {object} [options]
|
|
630
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
631
|
+
* @returns {Stream}
|
|
632
|
+
* An object stream which emits an object representing {@link protos.maps.fleetengine.delivery.v1.Task|Task} on 'data' event.
|
|
633
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
634
|
+
* times as needed. Note that it can affect your quota.
|
|
635
|
+
* We recommend using `listTasksAsync()`
|
|
636
|
+
* method described below for async iteration which you can stop as needed.
|
|
637
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
638
|
+
* for more details and examples.
|
|
639
|
+
*/
|
|
640
|
+
listTasksStream(request?: protos.maps.fleetengine.delivery.v1.IListTasksRequest, options?: CallOptions): Transform;
|
|
641
|
+
/**
|
|
642
|
+
* Equivalent to `listTasks`, but returns an iterable object.
|
|
643
|
+
*
|
|
644
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
645
|
+
* @param {Object} request
|
|
646
|
+
* The request object that will be sent.
|
|
647
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
648
|
+
* Optional. The standard Delivery API request header.
|
|
649
|
+
* @param {string} request.parent
|
|
650
|
+
* Required. Must be in the format `providers/{provider}`.
|
|
651
|
+
* The `provider` must be the Google Cloud Project ID. For example,
|
|
652
|
+
* `sample-cloud-project`.
|
|
653
|
+
* @param {number} [request.pageSize]
|
|
654
|
+
* Optional. The maximum number of Tasks to return. The service may return
|
|
655
|
+
* fewer than this value. If you don't specify this value, then the server
|
|
656
|
+
* determines the number of results to return.
|
|
657
|
+
* @param {string} [request.pageToken]
|
|
658
|
+
* Optional. A page token received from a previous `ListTasks` call.
|
|
659
|
+
* You can provide this to retrieve the subsequent page.
|
|
660
|
+
*
|
|
661
|
+
* When paginating, all other parameters provided to `ListTasks` must match
|
|
662
|
+
* the call that provided the page token.
|
|
663
|
+
* @param {string} [request.filter]
|
|
664
|
+
* Optional. A filter query to apply when listing Tasks. See
|
|
665
|
+
* http://aip.dev/160 for examples of filter syntax. If you don't specify a
|
|
666
|
+
* 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 [Task
|
|
668
|
+
* list](/maps/documentation/transportation-logistics/last-mile-fleet-solution/fleet-performance/fleet-engine/deliveries_api#list_tasks).
|
|
669
|
+
* @param {object} [options]
|
|
670
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
671
|
+
* @returns {Object}
|
|
672
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
673
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
674
|
+
* {@link protos.maps.fleetengine.delivery.v1.Task|Task}. The API will be called under the hood as needed, once per the page,
|
|
675
|
+
* so you can stop the iteration when you don't need more results.
|
|
676
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
677
|
+
* for more details and examples.
|
|
678
|
+
* @example <caption>include:samples/generated/v1/delivery_service.list_tasks.js</caption>
|
|
679
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_ListTasks_async
|
|
680
|
+
*/
|
|
681
|
+
listTasksAsync(request?: protos.maps.fleetengine.delivery.v1.IListTasksRequest, options?: CallOptions): AsyncIterable<protos.maps.fleetengine.delivery.v1.ITask>;
|
|
682
|
+
/**
|
|
683
|
+
* Gets all `DeliveryVehicle`s that meet the specified filtering criteria.
|
|
684
|
+
*
|
|
685
|
+
* @param {Object} request
|
|
686
|
+
* The request object that will be sent.
|
|
687
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
688
|
+
* Optional. The standard Delivery API request header.
|
|
689
|
+
* @param {string} request.parent
|
|
690
|
+
* Required. Must be in the format `providers/{provider}`.
|
|
691
|
+
* The `provider` must be the Google Cloud Project ID.
|
|
692
|
+
* For example, `sample-cloud-project`.
|
|
693
|
+
* @param {number} [request.pageSize]
|
|
694
|
+
* Optional. The maximum number of vehicles to return. The service may return
|
|
695
|
+
* fewer than this number. If you don't specify this number, then the server
|
|
696
|
+
* determines the number of results to return.
|
|
697
|
+
* @param {string} [request.pageToken]
|
|
698
|
+
* Optional. A page token, received from a previous `ListDeliveryVehicles`
|
|
699
|
+
* call. You must provide this in order to retrieve the subsequent page.
|
|
700
|
+
*
|
|
701
|
+
* When paginating, all other parameters provided to `ListDeliveryVehicles`
|
|
702
|
+
* must match the call that provided the page token.
|
|
703
|
+
* @param {string} [request.filter]
|
|
704
|
+
* Optional. A filter query to apply when listing delivery vehicles. See
|
|
705
|
+
* http://aip.dev/160 for examples of the filter syntax. If you don't specify
|
|
706
|
+
* a value, or if you specify an empty string for the filter, then all
|
|
707
|
+
* delivery vehicles are returned.
|
|
708
|
+
*
|
|
709
|
+
* Note that the only queries supported for `ListDeliveryVehicles` are
|
|
710
|
+
* on vehicle attributes (for example, `attributes.<key> = <value>` or
|
|
711
|
+
* `attributes.<key1> = <value1> AND attributes.<key2> = <value2>`). Also, all
|
|
712
|
+
* attributes are stored as strings, so the only supported comparisons against
|
|
713
|
+
* attributes are string comparisons. In order to compare against number or
|
|
714
|
+
* boolean values, the values must be explicitly quoted to be treated as
|
|
715
|
+
* strings (for example, `attributes.<key> = "10"` or
|
|
716
|
+
* `attributes.<key> = "true"`).
|
|
717
|
+
*
|
|
718
|
+
* The maximum number of restrictions allowed in a filter query is 50. A
|
|
719
|
+
* restriction is a part of the query of the form
|
|
720
|
+
* `attribute.<KEY> <COMPARATOR> <VALUE>`, for example `attributes.foo = bar`
|
|
721
|
+
* is 1 restriction.
|
|
722
|
+
* @param {google.geo.type.Viewport} [request.viewport]
|
|
723
|
+
* Optional. A filter that limits the vehicles returned to those whose last
|
|
724
|
+
* known location was in the rectangular area defined by the viewport.
|
|
725
|
+
* @param {object} [options]
|
|
726
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
727
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
728
|
+
* The first element of the array is Array of {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle}.
|
|
729
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
730
|
+
* times as needed and will merge results from all the pages into this array.
|
|
731
|
+
* Note that it can affect your quota.
|
|
732
|
+
* We recommend using `listDeliveryVehiclesAsync()`
|
|
733
|
+
* method described below for async iteration which you can stop as needed.
|
|
734
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
735
|
+
* for more details and examples.
|
|
736
|
+
*/
|
|
737
|
+
listDeliveryVehicles(request?: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, options?: CallOptions): Promise<[
|
|
738
|
+
protos.maps.fleetengine.delivery.v1.IDeliveryVehicle[],
|
|
739
|
+
protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest | null,
|
|
740
|
+
protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesResponse
|
|
741
|
+
]>;
|
|
742
|
+
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
|
+
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
|
+
/**
|
|
745
|
+
* Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
|
|
746
|
+
* @param {Object} request
|
|
747
|
+
* The request object that will be sent.
|
|
748
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
749
|
+
* Optional. The standard Delivery API request header.
|
|
750
|
+
* @param {string} request.parent
|
|
751
|
+
* Required. Must be in the format `providers/{provider}`.
|
|
752
|
+
* The `provider` must be the Google Cloud Project ID.
|
|
753
|
+
* For example, `sample-cloud-project`.
|
|
754
|
+
* @param {number} [request.pageSize]
|
|
755
|
+
* Optional. The maximum number of vehicles to return. The service may return
|
|
756
|
+
* fewer than this number. If you don't specify this number, then the server
|
|
757
|
+
* determines the number of results to return.
|
|
758
|
+
* @param {string} [request.pageToken]
|
|
759
|
+
* Optional. A page token, received from a previous `ListDeliveryVehicles`
|
|
760
|
+
* call. You must provide this in order to retrieve the subsequent page.
|
|
761
|
+
*
|
|
762
|
+
* When paginating, all other parameters provided to `ListDeliveryVehicles`
|
|
763
|
+
* must match the call that provided the page token.
|
|
764
|
+
* @param {string} [request.filter]
|
|
765
|
+
* Optional. A filter query to apply when listing delivery vehicles. See
|
|
766
|
+
* http://aip.dev/160 for examples of the filter syntax. If you don't specify
|
|
767
|
+
* a value, or if you specify an empty string for the filter, then all
|
|
768
|
+
* delivery vehicles are returned.
|
|
769
|
+
*
|
|
770
|
+
* Note that the only queries supported for `ListDeliveryVehicles` are
|
|
771
|
+
* on vehicle attributes (for example, `attributes.<key> = <value>` or
|
|
772
|
+
* `attributes.<key1> = <value1> AND attributes.<key2> = <value2>`). Also, all
|
|
773
|
+
* attributes are stored as strings, so the only supported comparisons against
|
|
774
|
+
* attributes are string comparisons. In order to compare against number or
|
|
775
|
+
* boolean values, the values must be explicitly quoted to be treated as
|
|
776
|
+
* strings (for example, `attributes.<key> = "10"` or
|
|
777
|
+
* `attributes.<key> = "true"`).
|
|
778
|
+
*
|
|
779
|
+
* The maximum number of restrictions allowed in a filter query is 50. A
|
|
780
|
+
* restriction is a part of the query of the form
|
|
781
|
+
* `attribute.<KEY> <COMPARATOR> <VALUE>`, for example `attributes.foo = bar`
|
|
782
|
+
* is 1 restriction.
|
|
783
|
+
* @param {google.geo.type.Viewport} [request.viewport]
|
|
784
|
+
* Optional. A filter that limits the vehicles returned to those whose last
|
|
785
|
+
* known location was in the rectangular area defined by the viewport.
|
|
786
|
+
* @param {object} [options]
|
|
787
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
788
|
+
* @returns {Stream}
|
|
789
|
+
* An object stream which emits an object representing {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle} on 'data' event.
|
|
790
|
+
* The client library will perform auto-pagination by default: it will call the API as many
|
|
791
|
+
* times as needed. Note that it can affect your quota.
|
|
792
|
+
* We recommend using `listDeliveryVehiclesAsync()`
|
|
793
|
+
* method described below for async iteration which you can stop as needed.
|
|
794
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
795
|
+
* for more details and examples.
|
|
796
|
+
*/
|
|
797
|
+
listDeliveryVehiclesStream(request?: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, options?: CallOptions): Transform;
|
|
798
|
+
/**
|
|
799
|
+
* Equivalent to `listDeliveryVehicles`, but returns an iterable object.
|
|
800
|
+
*
|
|
801
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
|
802
|
+
* @param {Object} request
|
|
803
|
+
* The request object that will be sent.
|
|
804
|
+
* @param {maps.fleetengine.delivery.v1.DeliveryRequestHeader} [request.header]
|
|
805
|
+
* Optional. The standard Delivery API request header.
|
|
806
|
+
* @param {string} request.parent
|
|
807
|
+
* Required. Must be in the format `providers/{provider}`.
|
|
808
|
+
* The `provider` must be the Google Cloud Project ID.
|
|
809
|
+
* For example, `sample-cloud-project`.
|
|
810
|
+
* @param {number} [request.pageSize]
|
|
811
|
+
* Optional. The maximum number of vehicles to return. The service may return
|
|
812
|
+
* fewer than this number. If you don't specify this number, then the server
|
|
813
|
+
* determines the number of results to return.
|
|
814
|
+
* @param {string} [request.pageToken]
|
|
815
|
+
* Optional. A page token, received from a previous `ListDeliveryVehicles`
|
|
816
|
+
* call. You must provide this in order to retrieve the subsequent page.
|
|
817
|
+
*
|
|
818
|
+
* When paginating, all other parameters provided to `ListDeliveryVehicles`
|
|
819
|
+
* must match the call that provided the page token.
|
|
820
|
+
* @param {string} [request.filter]
|
|
821
|
+
* Optional. A filter query to apply when listing delivery vehicles. See
|
|
822
|
+
* http://aip.dev/160 for examples of the filter syntax. If you don't specify
|
|
823
|
+
* a value, or if you specify an empty string for the filter, then all
|
|
824
|
+
* delivery vehicles are returned.
|
|
825
|
+
*
|
|
826
|
+
* Note that the only queries supported for `ListDeliveryVehicles` are
|
|
827
|
+
* on vehicle attributes (for example, `attributes.<key> = <value>` or
|
|
828
|
+
* `attributes.<key1> = <value1> AND attributes.<key2> = <value2>`). Also, all
|
|
829
|
+
* attributes are stored as strings, so the only supported comparisons against
|
|
830
|
+
* attributes are string comparisons. In order to compare against number or
|
|
831
|
+
* boolean values, the values must be explicitly quoted to be treated as
|
|
832
|
+
* strings (for example, `attributes.<key> = "10"` or
|
|
833
|
+
* `attributes.<key> = "true"`).
|
|
834
|
+
*
|
|
835
|
+
* The maximum number of restrictions allowed in a filter query is 50. A
|
|
836
|
+
* restriction is a part of the query of the form
|
|
837
|
+
* `attribute.<KEY> <COMPARATOR> <VALUE>`, for example `attributes.foo = bar`
|
|
838
|
+
* is 1 restriction.
|
|
839
|
+
* @param {google.geo.type.Viewport} [request.viewport]
|
|
840
|
+
* Optional. A filter that limits the vehicles returned to those whose last
|
|
841
|
+
* known location was in the rectangular area defined by the viewport.
|
|
842
|
+
* @param {object} [options]
|
|
843
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
844
|
+
* @returns {Object}
|
|
845
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
|
846
|
+
* When you iterate the returned iterable, each element will be an object representing
|
|
847
|
+
* {@link protos.maps.fleetengine.delivery.v1.DeliveryVehicle|DeliveryVehicle}. The API will be called under the hood as needed, once per the page,
|
|
848
|
+
* so you can stop the iteration when you don't need more results.
|
|
849
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
|
850
|
+
* for more details and examples.
|
|
851
|
+
* @example <caption>include:samples/generated/v1/delivery_service.list_delivery_vehicles.js</caption>
|
|
852
|
+
* region_tag:fleetengine_v1_generated_DeliveryService_ListDeliveryVehicles_async
|
|
853
|
+
*/
|
|
854
|
+
listDeliveryVehiclesAsync(request?: protos.maps.fleetengine.delivery.v1.IListDeliveryVehiclesRequest, options?: CallOptions): AsyncIterable<protos.maps.fleetengine.delivery.v1.IDeliveryVehicle>;
|
|
855
|
+
/**
|
|
856
|
+
* Return a fully-qualified deliveryVehicle resource name string.
|
|
857
|
+
*
|
|
858
|
+
* @param {string} provider
|
|
859
|
+
* @param {string} vehicle
|
|
860
|
+
* @returns {string} Resource name string.
|
|
861
|
+
*/
|
|
862
|
+
deliveryVehiclePath(provider: string, vehicle: string): string;
|
|
863
|
+
/**
|
|
864
|
+
* Parse the provider from DeliveryVehicle resource.
|
|
865
|
+
*
|
|
866
|
+
* @param {string} deliveryVehicleName
|
|
867
|
+
* A fully-qualified path representing DeliveryVehicle resource.
|
|
868
|
+
* @returns {string} A string representing the provider.
|
|
869
|
+
*/
|
|
870
|
+
matchProviderFromDeliveryVehicleName(deliveryVehicleName: string): string | number;
|
|
871
|
+
/**
|
|
872
|
+
* Parse the vehicle from DeliveryVehicle resource.
|
|
873
|
+
*
|
|
874
|
+
* @param {string} deliveryVehicleName
|
|
875
|
+
* A fully-qualified path representing DeliveryVehicle resource.
|
|
876
|
+
* @returns {string} A string representing the vehicle.
|
|
877
|
+
*/
|
|
878
|
+
matchVehicleFromDeliveryVehicleName(deliveryVehicleName: string): string | number;
|
|
879
|
+
/**
|
|
880
|
+
* Return a fully-qualified provider resource name string.
|
|
881
|
+
*
|
|
882
|
+
* @param {string} provider
|
|
883
|
+
* @returns {string} Resource name string.
|
|
884
|
+
*/
|
|
885
|
+
providerPath(provider: string): string;
|
|
886
|
+
/**
|
|
887
|
+
* Parse the provider from Provider resource.
|
|
888
|
+
*
|
|
889
|
+
* @param {string} providerName
|
|
890
|
+
* A fully-qualified path representing Provider resource.
|
|
891
|
+
* @returns {string} A string representing the provider.
|
|
892
|
+
*/
|
|
893
|
+
matchProviderFromProviderName(providerName: string): string | number;
|
|
894
|
+
/**
|
|
895
|
+
* Return a fully-qualified task resource name string.
|
|
896
|
+
*
|
|
897
|
+
* @param {string} provider
|
|
898
|
+
* @param {string} task
|
|
899
|
+
* @returns {string} Resource name string.
|
|
900
|
+
*/
|
|
901
|
+
taskPath(provider: string, task: string): string;
|
|
902
|
+
/**
|
|
903
|
+
* Parse the provider from Task resource.
|
|
904
|
+
*
|
|
905
|
+
* @param {string} taskName
|
|
906
|
+
* A fully-qualified path representing Task resource.
|
|
907
|
+
* @returns {string} A string representing the provider.
|
|
908
|
+
*/
|
|
909
|
+
matchProviderFromTaskName(taskName: string): string | number;
|
|
910
|
+
/**
|
|
911
|
+
* Parse the task from Task resource.
|
|
912
|
+
*
|
|
913
|
+
* @param {string} taskName
|
|
914
|
+
* A fully-qualified path representing Task resource.
|
|
915
|
+
* @returns {string} A string representing the task.
|
|
916
|
+
*/
|
|
917
|
+
matchTaskFromTaskName(taskName: string): string | number;
|
|
918
|
+
/**
|
|
919
|
+
* Return a fully-qualified taskTrackingInfo resource name string.
|
|
920
|
+
*
|
|
921
|
+
* @param {string} provider
|
|
922
|
+
* @param {string} tracking
|
|
923
|
+
* @returns {string} Resource name string.
|
|
924
|
+
*/
|
|
925
|
+
taskTrackingInfoPath(provider: string, tracking: string): string;
|
|
926
|
+
/**
|
|
927
|
+
* Parse the provider from TaskTrackingInfo resource.
|
|
928
|
+
*
|
|
929
|
+
* @param {string} taskTrackingInfoName
|
|
930
|
+
* A fully-qualified path representing TaskTrackingInfo resource.
|
|
931
|
+
* @returns {string} A string representing the provider.
|
|
932
|
+
*/
|
|
933
|
+
matchProviderFromTaskTrackingInfoName(taskTrackingInfoName: string): string | number;
|
|
934
|
+
/**
|
|
935
|
+
* Parse the tracking from TaskTrackingInfo resource.
|
|
936
|
+
*
|
|
937
|
+
* @param {string} taskTrackingInfoName
|
|
938
|
+
* A fully-qualified path representing TaskTrackingInfo resource.
|
|
939
|
+
* @returns {string} A string representing the tracking.
|
|
940
|
+
*/
|
|
941
|
+
matchTrackingFromTaskTrackingInfoName(taskTrackingInfoName: string): string | number;
|
|
942
|
+
/**
|
|
943
|
+
* Terminate the gRPC channel and close the client.
|
|
944
|
+
*
|
|
945
|
+
* The client will no longer be usable and all future behavior is undefined.
|
|
946
|
+
* @returns {Promise} A promise that resolves when the client is closed.
|
|
947
|
+
*/
|
|
948
|
+
close(): Promise<void>;
|
|
949
|
+
}
|