|
| 1 | +# Google Last Mile Fleet Solution Delivery API Client for Java |
| 2 | + |
| 3 | +Java idiomatic client for [Last Mile Fleet Solution Delivery API][product-docs]. |
| 4 | + |
| 5 | +[![Maven][maven-version-image]][maven-version-link] |
| 6 | +![Stability][stability-image] |
| 7 | + |
| 8 | +- [Product Documentation][product-docs] |
| 9 | +- [Client Library Documentation][javadocs] |
| 10 | + |
| 11 | +> Note: This client is a work-in-progress, and may occasionally |
| 12 | +> make backwards-incompatible changes. |
| 13 | +
|
| 14 | + |
| 15 | +## Quickstart |
| 16 | + |
| 17 | + |
| 18 | +If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file: |
| 19 | + |
| 20 | +```xml |
| 21 | +<dependencyManagement> |
| 22 | + <dependencies> |
| 23 | + <dependency> |
| 24 | + <groupId>com.google.cloud</groupId> |
| 25 | + <artifactId>libraries-bom</artifactId> |
| 26 | + <version>26.50.0</version> |
| 27 | + <type>pom</type> |
| 28 | + <scope>import</scope> |
| 29 | + </dependency> |
| 30 | + </dependencies> |
| 31 | +</dependencyManagement> |
| 32 | + |
| 33 | +<dependencies> |
| 34 | + <dependency> |
| 35 | + <groupId>com.google.maps</groupId> |
| 36 | + <artifactId>google-maps-fleetengine-delivery</artifactId> |
| 37 | + </dependency> |
| 38 | +</dependencies> |
| 39 | +``` |
| 40 | + |
| 41 | +If you are using Maven without the BOM, add this to your dependencies: |
| 42 | + |
| 43 | + |
| 44 | +```xml |
| 45 | +<dependency> |
| 46 | + <groupId>com.google.maps</groupId> |
| 47 | + <artifactId>google-maps-fleetengine-delivery</artifactId> |
| 48 | + <version>0.0.0</version> |
| 49 | +</dependency> |
| 50 | +``` |
| 51 | + |
| 52 | +If you are using Gradle without BOM, add this to your dependencies: |
| 53 | + |
| 54 | +```Groovy |
| 55 | +implementation 'com.google.maps:google-maps-fleetengine-delivery:0.0.0' |
| 56 | +``` |
| 57 | + |
| 58 | +If you are using SBT, add this to your dependencies: |
| 59 | + |
| 60 | +```Scala |
| 61 | +libraryDependencies += "com.google.maps" % "google-maps-fleetengine-delivery" % "0.0.0" |
| 62 | +``` |
| 63 | + |
| 64 | +## Authentication |
| 65 | + |
| 66 | +See the [Authentication][authentication] section in the base directory's README. |
| 67 | + |
| 68 | +## Authorization |
| 69 | + |
| 70 | +The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Last Mile Fleet Solution Delivery API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Last Mile Fleet Solution Delivery API API calls. |
| 71 | + |
| 72 | +## Getting Started |
| 73 | + |
| 74 | +### Prerequisites |
| 75 | + |
| 76 | +You will need a [Google Cloud Platform Console][developer-console] project with the Last Mile Fleet Solution Delivery API [API enabled][enable-api]. |
| 77 | +You will need to [enable billing][enable-billing] to use Google Last Mile Fleet Solution Delivery API. |
| 78 | +[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by |
| 79 | +[installing the Google Cloud Command Line Interface][cloud-cli] and running the following commands in command line: |
| 80 | +`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`. |
| 81 | + |
| 82 | +### Installation and setup |
| 83 | + |
| 84 | +You'll need to obtain the `google-maps-fleetengine-delivery` library. See the [Quickstart](#quickstart) section |
| 85 | +to add `google-maps-fleetengine-delivery` as a dependency in your code. |
| 86 | + |
| 87 | +## About Last Mile Fleet Solution Delivery API |
| 88 | + |
| 89 | + |
| 90 | +[Last Mile Fleet Solution Delivery API][product-docs] Enables Fleet Engine for access to the On Demand Rides and Deliveries and Last Mile Fleet Solution APIs. Customer's use of Google Maps Content in the Cloud Logging Services is subject to the Google Maps Platform Terms of Service located at https://cloud.google.com/maps-platform/terms. |
| 91 | + |
| 92 | +See the [Last Mile Fleet Solution Delivery API client library docs][javadocs] to learn how to |
| 93 | +use this Last Mile Fleet Solution Delivery API Client Library. |
| 94 | + |
| 95 | + |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | +## Troubleshooting |
| 101 | + |
| 102 | +To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. |
| 103 | + |
| 104 | +## Transport |
| 105 | + |
| 106 | +Last Mile Fleet Solution Delivery API uses both gRPC and HTTP/JSON for the transport layer. |
| 107 | + |
| 108 | +## Supported Java Versions |
| 109 | + |
| 110 | +Java 8 or above is required for using this client. |
| 111 | + |
| 112 | +Google's Java client libraries, |
| 113 | +[Google Cloud Client Libraries][cloudlibs] |
| 114 | +and |
| 115 | +[Google Cloud API Libraries][apilibs], |
| 116 | +follow the |
| 117 | +[Oracle Java SE support roadmap][oracle] |
| 118 | +(see the Oracle Java SE Product Releases section). |
| 119 | + |
| 120 | +### For new development |
| 121 | + |
| 122 | +In general, new feature development occurs with support for the lowest Java |
| 123 | +LTS version covered by Oracle's Premier Support (which typically lasts 5 years |
| 124 | +from initial General Availability). If the minimum required JVM for a given |
| 125 | +library is changed, it is accompanied by a [semver][semver] major release. |
| 126 | + |
| 127 | +Java 11 and (in September 2021) Java 17 are the best choices for new |
| 128 | +development. |
| 129 | + |
| 130 | +### Keeping production systems current |
| 131 | + |
| 132 | +Google tests its client libraries with all current LTS versions covered by |
| 133 | +Oracle's Extended Support (which typically lasts 8 years from initial |
| 134 | +General Availability). |
| 135 | + |
| 136 | +#### Legacy support |
| 137 | + |
| 138 | +Google's client libraries support legacy versions of Java runtimes with long |
| 139 | +term stable libraries that don't receive feature updates on a best efforts basis |
| 140 | +as it may not be possible to backport all patches. |
| 141 | + |
| 142 | +Google provides updates on a best efforts basis to apps that continue to use |
| 143 | +Java 7, though apps might need to upgrade to current versions of the library |
| 144 | +that supports their JVM. |
| 145 | + |
| 146 | +#### Where to find specific information |
| 147 | + |
| 148 | +The latest versions and the supported Java versions are identified on |
| 149 | +the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME` |
| 150 | +and on [google-cloud-java][g-c-j]. |
| 151 | + |
| 152 | +## Versioning |
| 153 | + |
| 154 | + |
| 155 | +This library follows [Semantic Versioning](http://semver.org/). |
| 156 | + |
| 157 | + |
| 158 | +It is currently in major version zero (``0.y.z``), which means that anything may change at any time |
| 159 | +and the public API should not be considered stable. |
| 160 | + |
| 161 | + |
| 162 | +## Contributing |
| 163 | + |
| 164 | + |
| 165 | +Contributions to this library are always welcome and highly encouraged. |
| 166 | + |
| 167 | +See [CONTRIBUTING][contributing] for more information how to get started. |
| 168 | + |
| 169 | +Please note that this project is released with a Contributor Code of Conduct. By participating in |
| 170 | +this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more |
| 171 | +information. |
| 172 | + |
| 173 | + |
| 174 | +## License |
| 175 | + |
| 176 | +Apache 2.0 - See [LICENSE][license] for more information. |
| 177 | + |
| 178 | +## CI Status |
| 179 | + |
| 180 | +Java Version | Status |
| 181 | +------------ | ------ |
| 182 | +Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2] |
| 183 | +Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3] |
| 184 | +Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4] |
| 185 | +Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5] |
| 186 | + |
| 187 | +Java is a registered trademark of Oracle and/or its affiliates. |
| 188 | + |
| 189 | +[product-docs]: https://developers.google.com/maps/documentation/transportation-logistics/mobility |
| 190 | +[javadocs]: https://cloud.google.com/java/docs/reference/google-maps-fleetengine-delivery/latest/overview |
| 191 | +[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg |
| 192 | +[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html |
| 193 | +[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg |
| 194 | +[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html |
| 195 | +[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg |
| 196 | +[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html |
| 197 | +[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg |
| 198 | +[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html |
| 199 | +[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg |
| 200 | +[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html |
| 201 | +[stability-image]: https://img.shields.io/badge/stability-preview-yellow |
| 202 | +[maven-version-image]: https://img.shields.io/maven-central/v/com.google.maps/google-maps-fleetengine-delivery.svg |
| 203 | +[maven-version-link]: https://central.sonatype.com/artifact/com.google.maps/google-maps-fleetengine-delivery/0.0.0 |
| 204 | +[authentication]: https://github.com/googleapis/google-cloud-java#authentication |
| 205 | +[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes |
| 206 | +[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles |
| 207 | +[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy |
| 208 | +[developer-console]: https://console.developers.google.com/ |
| 209 | +[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects |
| 210 | +[cloud-cli]: https://cloud.google.com/cli |
| 211 | +[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md |
| 212 | +[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md |
| 213 | +[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct |
| 214 | +[license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE |
| 215 | +[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing |
| 216 | +[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=maps-fleetengine-delivery.googleapis.com |
| 217 | +[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM |
| 218 | +[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png |
| 219 | + |
| 220 | +[semver]: https://semver.org/ |
| 221 | +[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained |
| 222 | +[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries |
| 223 | +[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html |
| 224 | +[g-c-j]: http://github.com/googleapis/google-cloud-java |
0 commit comments