@googlemaps/fleetengine 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 +319 -0
- package/build/protos/google/geo/type/viewport.proto +69 -0
- package/build/protos/google/maps/fleetengine/v1/fleetengine.proto +331 -0
- package/build/protos/google/maps/fleetengine/v1/header.proto +108 -0
- package/build/protos/google/maps/fleetengine/v1/traffic.proto +68 -0
- package/build/protos/google/maps/fleetengine/v1/trip_api.proto +377 -0
- package/build/protos/google/maps/fleetengine/v1/trips.proto +311 -0
- package/build/protos/google/maps/fleetengine/v1/vehicle_api.proto +842 -0
- package/build/protos/google/maps/fleetengine/v1/vehicles.proto +348 -0
- package/build/protos/protos.d.ts +13292 -0
- package/build/protos/protos.js +36937 -0
- package/build/protos/protos.json +3997 -0
- package/build/src/index.d.ts +14 -0
- package/build/src/index.js +30 -0
- package/build/src/index.js.map +1 -0
- package/build/src/v1/index.d.ts +2 -0
- package/build/src/v1/index.js +25 -0
- package/build/src/v1/index.js.map +1 -0
- package/build/src/v1/trip_service_client.d.ts +555 -0
- package/build/src/v1/trip_service_client.js +631 -0
- package/build/src/v1/trip_service_client.js.map +1 -0
- package/build/src/v1/trip_service_client_config.json +62 -0
- package/build/src/v1/vehicle_service_client.d.ts +1165 -0
- package/build/src/v1/vehicle_service_client.js +904 -0
- package/build/src/v1/vehicle_service_client.js.map +1 -0
- package/build/src/v1/vehicle_service_client_config.json +75 -0
- package/package.json +70 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 0.1.0 (2024-06-03)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* [Many APIs] update Nodejs generator to send API versions in headers for GAPICs ([#5351](https://github.com/googleapis/google-cloud-node/issues/5351)) ([01f48fc](https://github.com/googleapis/google-cloud-node/commit/01f48fce63ec4ddf801d59ee2b8c0db9f6fb8372))
|
|
9
|
+
* [Many APIs] update Nodejs generator to send API versions in headers for GAPICs ([#5354](https://github.com/googleapis/google-cloud-node/issues/5354)) ([a9784ed](https://github.com/googleapis/google-cloud-node/commit/a9784ed3db6ee96d171762308bbbcd57390b6866))
|
|
10
|
+
* Add initial files for google.maps.fleetengine.v1 ([#5251](https://github.com/googleapis/google-cloud-node/issues/5251)) ([50cd4b8](https://github.com/googleapis/google-cloud-node/commit/50cd4b851c9a14788a292cd27d4abb8b317091ec))
|
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,319 @@
|
|
|
1
|
+
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
|
2
|
+
[//]: # "To regenerate it, use `python -m synthtool`."
|
|
3
|
+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
|
4
|
+
|
|
5
|
+
# [Local Rides and Deliveries API: Node.js Client](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine)
|
|
6
|
+
|
|
7
|
+
[](https://cloud.google.com/terms/launch-stages)
|
|
8
|
+
[](https://www.npmjs.org/package/@googlemaps/fleetengine)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
Local Rides and Deliveries API client for Node.js
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
A comprehensive list of changes in each version may be found in
|
|
17
|
+
[the CHANGELOG](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine/CHANGELOG.md).
|
|
18
|
+
|
|
19
|
+
* [Local Rides and Deliveries API Node.js Client API Reference][client-docs]
|
|
20
|
+
* [Local Rides and Deliveries API Documentation][product-docs]
|
|
21
|
+
* [github.com/googleapis/google-cloud-node/packages/google-maps-fleetengine](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine)
|
|
22
|
+
|
|
23
|
+
Read more about the client libraries for Cloud APIs, including the older
|
|
24
|
+
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
25
|
+
|
|
26
|
+
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
|
|
27
|
+
|
|
28
|
+
**Table of contents:**
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
* [Quickstart](#quickstart)
|
|
32
|
+
* [Before you begin](#before-you-begin)
|
|
33
|
+
* [Installing the client library](#installing-the-client-library)
|
|
34
|
+
* [Using the client library](#using-the-client-library)
|
|
35
|
+
* [Samples](#samples)
|
|
36
|
+
* [Versioning](#versioning)
|
|
37
|
+
* [Contributing](#contributing)
|
|
38
|
+
* [License](#license)
|
|
39
|
+
|
|
40
|
+
## Quickstart
|
|
41
|
+
|
|
42
|
+
### Before you begin
|
|
43
|
+
|
|
44
|
+
1. [Select or create a Cloud Platform project][projects].
|
|
45
|
+
1. [Enable billing for your project][billing].
|
|
46
|
+
1. [Enable the Local Rides and Deliveries API API][enable_api].
|
|
47
|
+
1. [Set up authentication with a service account][auth] so you can access the
|
|
48
|
+
API from your local workstation.
|
|
49
|
+
|
|
50
|
+
### Installing the client library
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
npm install @googlemaps/fleetengine
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Using the client library
|
|
58
|
+
|
|
59
|
+
```javascript
|
|
60
|
+
/**
|
|
61
|
+
* This snippet has been automatically generated and should be regarded as a code template only.
|
|
62
|
+
* It will require modifications to work.
|
|
63
|
+
* It may require correct/in-range values for request initialization.
|
|
64
|
+
* TODO(developer): Uncomment these variables before running the sample.
|
|
65
|
+
*/
|
|
66
|
+
/**
|
|
67
|
+
* The standard Fleet Engine request header.
|
|
68
|
+
*/
|
|
69
|
+
// const header = {}
|
|
70
|
+
/**
|
|
71
|
+
* Required. Must be in the format `providers/{provider}`.
|
|
72
|
+
* The provider must be the Project ID (for example, `sample-cloud-project`)
|
|
73
|
+
* of the Google Cloud Project of which the service account making
|
|
74
|
+
* this call is a member.
|
|
75
|
+
*/
|
|
76
|
+
// const parent = 'abc123'
|
|
77
|
+
/**
|
|
78
|
+
* The maximum number of vehicles to return.
|
|
79
|
+
* Default value: 100.
|
|
80
|
+
*/
|
|
81
|
+
// const pageSize = 1234
|
|
82
|
+
/**
|
|
83
|
+
* The value of the `next_page_token` provided by a previous call to
|
|
84
|
+
* `ListVehicles` so that you can paginate through groups of vehicles. The
|
|
85
|
+
* value is undefined if the filter criteria of the request is not the same as
|
|
86
|
+
* the filter criteria for the previous call to `ListVehicles`.
|
|
87
|
+
*/
|
|
88
|
+
// const pageToken = 'abc123'
|
|
89
|
+
/**
|
|
90
|
+
* Specifies the required minimum capacity of the vehicle. All vehicles
|
|
91
|
+
* returned will have a `maximum_capacity` greater than or equal to this
|
|
92
|
+
* value. If set, must be greater or equal to 0.
|
|
93
|
+
*/
|
|
94
|
+
// const minimumCapacity = {}
|
|
95
|
+
/**
|
|
96
|
+
* Restricts the response to vehicles that support at least one of the
|
|
97
|
+
* specified trip types.
|
|
98
|
+
*/
|
|
99
|
+
// const tripTypes = [1,2,3,4]
|
|
100
|
+
/**
|
|
101
|
+
* Restricts the response to vehicles that have sent location updates to Fleet
|
|
102
|
+
* Engine within the specified duration. Stationary vehicles still
|
|
103
|
+
* transmitting their locations are not considered stale. If present, must be
|
|
104
|
+
* a valid positive duration.
|
|
105
|
+
*/
|
|
106
|
+
// const maximumStaleness = {}
|
|
107
|
+
/**
|
|
108
|
+
* Required. Restricts the response to vehicles with one of the specified type
|
|
109
|
+
* categories. `UNKNOWN` is not allowed.
|
|
110
|
+
*/
|
|
111
|
+
// const vehicleTypeCategories = [1,2,3,4]
|
|
112
|
+
/**
|
|
113
|
+
* Callers can form complex logical operations using any combination of the
|
|
114
|
+
* `required_attributes`, `required_one_of_attributes`, and
|
|
115
|
+
* `required_one_of_attribute_sets` fields.
|
|
116
|
+
* `required_attributes` is a list; `required_one_of_attributes` uses a
|
|
117
|
+
* message which allows a list of lists. In combination, the two fields allow
|
|
118
|
+
* the composition of this expression:
|
|
119
|
+
* ```
|
|
120
|
+
* (required_attributes0 AND required_attributes1 AND ...)
|
|
121
|
+
* AND
|
|
122
|
+
* (required_one_of_attributes0 0 OR required_one_of_attributes0 1 OR
|
|
123
|
+
* ...)
|
|
124
|
+
* AND
|
|
125
|
+
* (required_one_of_attributes1 0 OR required_one_of_attributes1 1 OR
|
|
126
|
+
* ...)
|
|
127
|
+
* ```
|
|
128
|
+
* Restricts the response to vehicles with the specified attributes. This
|
|
129
|
+
* field is a conjunction/AND operation. A max of 50 required_attributes is
|
|
130
|
+
* allowed. This matches the maximum number of attributes allowed on a
|
|
131
|
+
* vehicle. Each repeated string should be of the format "key:value".
|
|
132
|
+
*/
|
|
133
|
+
// const requiredAttributes = ['abc','def']
|
|
134
|
+
/**
|
|
135
|
+
* Restricts the response to vehicles with at least one of the specified
|
|
136
|
+
* attributes in each `VehicleAttributeList`. Within each list, a vehicle must
|
|
137
|
+
* match at least one of the attributes. This field is an inclusive
|
|
138
|
+
* disjunction/OR operation in each `VehicleAttributeList` and a
|
|
139
|
+
* conjunction/AND operation across the collection of `VehicleAttributeList`.
|
|
140
|
+
* Each repeated string should be of the format
|
|
141
|
+
* "key1:value1|key2:value2|key3:value3".
|
|
142
|
+
*/
|
|
143
|
+
// const requiredOneOfAttributes = ['abc','def']
|
|
144
|
+
/**
|
|
145
|
+
* `required_one_of_attribute_sets` provides additional functionality.
|
|
146
|
+
* Similar to `required_one_of_attributes`, `required_one_of_attribute_sets`
|
|
147
|
+
* uses a message which allows a list of lists, allowing expressions such as
|
|
148
|
+
* this one:
|
|
149
|
+
* ```
|
|
150
|
+
* (required_attributes0 AND required_attributes1 AND ...)
|
|
151
|
+
* AND
|
|
152
|
+
* (
|
|
153
|
+
* (required_one_of_attribute_sets0 0 AND
|
|
154
|
+
* required_one_of_attribute_sets0 1 AND
|
|
155
|
+
* ...)
|
|
156
|
+
* OR
|
|
157
|
+
* (required_one_of_attribute_sets1 0 AND
|
|
158
|
+
* required_one_of_attribute_sets1 1 AND
|
|
159
|
+
* ...)
|
|
160
|
+
* )
|
|
161
|
+
* ```
|
|
162
|
+
* Restricts the response to vehicles that match all the attributes in a
|
|
163
|
+
* `VehicleAttributeList`. Within each list, a vehicle must match all of the
|
|
164
|
+
* attributes. This field is a conjunction/AND operation in each
|
|
165
|
+
* `VehicleAttributeList` and inclusive disjunction/OR operation across the
|
|
166
|
+
* collection of `VehicleAttributeList`. Each repeated string should be of the
|
|
167
|
+
* format "key1:value1|key2:value2|key3:value3".
|
|
168
|
+
*/
|
|
169
|
+
// const requiredOneOfAttributeSets = ['abc','def']
|
|
170
|
+
/**
|
|
171
|
+
* Restricts the response to vehicles that have this vehicle state.
|
|
172
|
+
*/
|
|
173
|
+
// const vehicleState = {}
|
|
174
|
+
/**
|
|
175
|
+
* Only return the vehicles with current trip(s).
|
|
176
|
+
*/
|
|
177
|
+
// const onTripOnly = true
|
|
178
|
+
/**
|
|
179
|
+
* Optional. A filter query to apply when listing vehicles. See
|
|
180
|
+
* http://aip.dev/160 for examples of the filter syntax.
|
|
181
|
+
* This field is designed to replace the `required_attributes`,
|
|
182
|
+
* `required_one_of_attributes`, and `required_one_of_attributes_sets` fields.
|
|
183
|
+
* If a non-empty value is specified here, the following fields must be empty:
|
|
184
|
+
* `required_attributes`, `required_one_of_attributes`, and
|
|
185
|
+
* `required_one_of_attributes_sets`.
|
|
186
|
+
* This filter functions as an AND clause with other constraints,
|
|
187
|
+
* such as `vehicle_state` or `on_trip_only`.
|
|
188
|
+
* Note that the only queries supported are on vehicle attributes (for
|
|
189
|
+
* example, `attributes.<key> = <value>` or `attributes.<key1> = <value1> AND
|
|
190
|
+
* attributes.<key2> = <value2>`). The maximum number of restrictions allowed
|
|
191
|
+
* in a filter query is 50.
|
|
192
|
+
* Also, all attributes are stored as strings, so the only supported
|
|
193
|
+
* comparisons against attributes are string comparisons. In order to compare
|
|
194
|
+
* against number or boolean values, the values must be explicitly quoted to
|
|
195
|
+
* be treated as strings (for example, `attributes.<key> = "10"` or
|
|
196
|
+
* `attributes.<key> = "true"`).
|
|
197
|
+
*/
|
|
198
|
+
// const filter = 'abc123'
|
|
199
|
+
/**
|
|
200
|
+
* Optional. A filter that limits the vehicles returned to those whose last
|
|
201
|
+
* known location was in the rectangular area defined by the viewport.
|
|
202
|
+
*/
|
|
203
|
+
// const viewport = {}
|
|
204
|
+
|
|
205
|
+
// Imports the Fleetengine library
|
|
206
|
+
const {VehicleServiceClient} = require('@googlemaps/fleetengine').v1;
|
|
207
|
+
|
|
208
|
+
// Instantiates a client
|
|
209
|
+
const fleetengineClient = new VehicleServiceClient();
|
|
210
|
+
|
|
211
|
+
async function callListVehicles() {
|
|
212
|
+
// Construct request
|
|
213
|
+
const request = {
|
|
214
|
+
parent,
|
|
215
|
+
vehicleTypeCategories,
|
|
216
|
+
};
|
|
217
|
+
|
|
218
|
+
// Run request
|
|
219
|
+
const iterable = fleetengineClient.listVehiclesAsync(request);
|
|
220
|
+
for await (const response of iterable) {
|
|
221
|
+
console.log(response);
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
callListVehicles();
|
|
226
|
+
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
## Samples
|
|
232
|
+
|
|
233
|
+
Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-maps-fleetengine/samples) directory. Each sample's `README.md` has instructions for running its sample.
|
|
234
|
+
|
|
235
|
+
| Sample | Source Code | Try it |
|
|
236
|
+
| --------------------------- | --------------------------------- | ------ |
|
|
237
|
+
| Trip_service.create_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.create_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.create_trip.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
238
|
+
| Trip_service.get_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.get_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.get_trip.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
239
|
+
| Trip_service.report_billable_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.report_billable_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.report_billable_trip.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
240
|
+
| Trip_service.search_trips | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.search_trips.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.search_trips.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
241
|
+
| Trip_service.update_trip | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/trip_service.update_trip.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/trip_service.update_trip.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
242
|
+
| Vehicle_service.create_vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.create_vehicle.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.create_vehicle.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
243
|
+
| Vehicle_service.get_vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.get_vehicle.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.get_vehicle.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
244
|
+
| Vehicle_service.list_vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.list_vehicles.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.list_vehicles.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
245
|
+
| Vehicle_service.search_fuzzed_vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_fuzzed_vehicles.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_fuzzed_vehicles.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
246
|
+
| Vehicle_service.search_vehicles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_vehicles.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.search_vehicles.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
247
|
+
| Vehicle_service.update_vehicle | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
248
|
+
| Vehicle_service.update_vehicle_attributes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_attributes.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_attributes.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
249
|
+
| Vehicle_service.update_vehicle_location | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_location.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/generated/v1/vehicle_service.update_vehicle_location.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
250
|
+
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-maps-fleetengine/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-maps-fleetengine/samples/quickstart.js,packages/google-maps-fleetengine/samples/README.md) |
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
The [Local Rides and Deliveries API Node.js Client API Reference][client-docs] documentation
|
|
255
|
+
also contains samples.
|
|
256
|
+
|
|
257
|
+
## Supported Node.js Versions
|
|
258
|
+
|
|
259
|
+
Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
|
|
260
|
+
Libraries are compatible with all current _active_ and _maintenance_ versions of
|
|
261
|
+
Node.js.
|
|
262
|
+
If you are using an end-of-life version of Node.js, we recommend that you update
|
|
263
|
+
as soon as possible to an actively supported LTS version.
|
|
264
|
+
|
|
265
|
+
Google's client libraries support legacy versions of Node.js runtimes on a
|
|
266
|
+
best-efforts basis with the following warnings:
|
|
267
|
+
|
|
268
|
+
* Legacy versions are not tested in continuous integration.
|
|
269
|
+
* Some security patches and features cannot be backported.
|
|
270
|
+
* Dependencies cannot be kept up-to-date.
|
|
271
|
+
|
|
272
|
+
Client libraries targeting some end-of-life versions of Node.js are available, and
|
|
273
|
+
can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
|
|
274
|
+
The dist-tags follow the naming convention `legacy-(version)`.
|
|
275
|
+
For example, `npm install @googlemaps/fleetengine@legacy-8` installs client libraries
|
|
276
|
+
for versions compatible with Node.js 8.
|
|
277
|
+
|
|
278
|
+
## Versioning
|
|
279
|
+
|
|
280
|
+
This library follows [Semantic Versioning](http://semver.org/).
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
This library is considered to be in **preview**. This means it is still a
|
|
289
|
+
work-in-progress and under active development. Any release is subject to
|
|
290
|
+
backwards-incompatible changes at any time.
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
|
294
|
+
|
|
295
|
+
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
|
296
|
+
|
|
297
|
+
## Contributing
|
|
298
|
+
|
|
299
|
+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
|
|
300
|
+
|
|
301
|
+
Please note that this `README.md`, the `samples/README.md`,
|
|
302
|
+
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
|
303
|
+
are generated from a central template. To edit one of these files, make an edit
|
|
304
|
+
to its templates in
|
|
305
|
+
[directory](https://github.com/googleapis/synthtool).
|
|
306
|
+
|
|
307
|
+
## License
|
|
308
|
+
|
|
309
|
+
Apache Version 2.0
|
|
310
|
+
|
|
311
|
+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
|
|
312
|
+
|
|
313
|
+
[client-docs]: https://cloud.google.com/nodejs/docs/reference/fleetengine/latest
|
|
314
|
+
[product-docs]: https://developers.google.com/maps/documentation/transportation-logistics/mobility
|
|
315
|
+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
|
316
|
+
[projects]: https://console.cloud.google.com/project
|
|
317
|
+
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
|
318
|
+
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=fleetengine.googleapis.com
|
|
319
|
+
[auth]: https://cloud.google.com/docs/authentication/getting-started
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
// Copyright 2019 Google LLC.
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
//
|
|
15
|
+
|
|
16
|
+
syntax = "proto3";
|
|
17
|
+
|
|
18
|
+
package google.geo.type;
|
|
19
|
+
|
|
20
|
+
import "google/type/latlng.proto";
|
|
21
|
+
|
|
22
|
+
option go_package = "google.golang.org/genproto/googleapis/geo/type/viewport;viewport";
|
|
23
|
+
option java_multiple_files = true;
|
|
24
|
+
option java_outer_classname = "ViewportProto";
|
|
25
|
+
option java_package = "com.google.geo.type";
|
|
26
|
+
option objc_class_prefix = "GGTP";
|
|
27
|
+
|
|
28
|
+
// A latitude-longitude viewport, represented as two diagonally opposite `low`
|
|
29
|
+
// and `high` points. A viewport is considered a closed region, i.e. it includes
|
|
30
|
+
// its boundary. The latitude bounds must range between -90 to 90 degrees
|
|
31
|
+
// inclusive, and the longitude bounds must range between -180 to 180 degrees
|
|
32
|
+
// inclusive. Various cases include:
|
|
33
|
+
//
|
|
34
|
+
// - If `low` = `high`, the viewport consists of that single point.
|
|
35
|
+
//
|
|
36
|
+
// - If `low.longitude` > `high.longitude`, the longitude range is inverted
|
|
37
|
+
// (the viewport crosses the 180 degree longitude line).
|
|
38
|
+
//
|
|
39
|
+
// - If `low.longitude` = -180 degrees and `high.longitude` = 180 degrees,
|
|
40
|
+
// the viewport includes all longitudes.
|
|
41
|
+
//
|
|
42
|
+
// - If `low.longitude` = 180 degrees and `high.longitude` = -180 degrees,
|
|
43
|
+
// the longitude range is empty.
|
|
44
|
+
//
|
|
45
|
+
// - If `low.latitude` > `high.latitude`, the latitude range is empty.
|
|
46
|
+
//
|
|
47
|
+
// Both `low` and `high` must be populated, and the represented box cannot be
|
|
48
|
+
// empty (as specified by the definitions above). An empty viewport will result
|
|
49
|
+
// in an error.
|
|
50
|
+
//
|
|
51
|
+
// For example, this viewport fully encloses New York City:
|
|
52
|
+
//
|
|
53
|
+
// {
|
|
54
|
+
// "low": {
|
|
55
|
+
// "latitude": 40.477398,
|
|
56
|
+
// "longitude": -74.259087
|
|
57
|
+
// },
|
|
58
|
+
// "high": {
|
|
59
|
+
// "latitude": 40.91618,
|
|
60
|
+
// "longitude": -73.70018
|
|
61
|
+
// }
|
|
62
|
+
// }
|
|
63
|
+
message Viewport {
|
|
64
|
+
// Required. The low point of the viewport.
|
|
65
|
+
google.type.LatLng low = 1;
|
|
66
|
+
|
|
67
|
+
// Required. The high point of the viewport.
|
|
68
|
+
google.type.LatLng high = 2;
|
|
69
|
+
}
|