Skip to content

Commit

Permalink
feat: [maps-routiting] new module for maps-routiting (#8724)
Browse files Browse the repository at this point in the history
* feat: [maps-routiting] new module for maps-routiting

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* remove bash_history

* bom script

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
suztomo and gcf-owl-bot[bot] authored Nov 3, 2022
1 parent 5473bee commit 4e67caa
Show file tree
Hide file tree
Showing 120 changed files with 49,269 additions and 0 deletions.
1 change: 1 addition & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,7 @@
"java-language": "2.6.0",
"java-life-sciences": "0.7.0",
"java-managed-identities": "1.3.0",
"java-maps-routiting": "0.0.0",
"java-mediatranslation": "0.11.0",
"java-memcache": "2.5.0",
"java-monitoring-dashboards": "2.7.0",
Expand Down
5 changes: 5 additions & 0 deletions generation/generate_gapic_bom.sh
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ for bom_directory in $(find . -maxdepth 3 -name 'google-*-bom' | sort --dictiona
artifactId_line=$(grep --max-count=1 'artifactId' "${pom_file}")
version_line=$(grep --max-count=1 'x-version-update' "${pom_file}")

if [[ "$groupId_line" == *"com.google.maps"* ]]; then
# The gapic bom includes cloud libraries
continue
fi

bom_lines+=" <dependency>\n\
${groupId_line}\n\
${artifactId_line}\n\
Expand Down
33 changes: 33 additions & 0 deletions java-maps-routiting/.OwlBot.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Copyright 2022 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


deep-remove-regex:
- "/java-maps-routiting/grpc-google-.*/src"
- "/java-maps-routiting/proto-google-.*/src"
- "/java-maps-routiting/google-.*/src"

deep-preserve-regex:
- "/java-maps-routiting/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java"

deep-copy-regex:
- source: "/google/maps/routing/(v.*)/.*-java/proto-google-.*/src"
dest: "/owl-bot-staging/java-maps-routiting/$1/proto-google-maps-routes-$1/src"
- source: "/google/maps/routing/(v.*)/.*-java/grpc-google-.*/src"
dest: "/owl-bot-staging/java-maps-routiting/$1/grpc-google-maps-routes-$1/src"
- source: "/google/maps/routing/(v.*)/.*-java/gapic-google-.*/src"
dest: "/owl-bot-staging/java-maps-routiting/$1/google-maps-routes/src"


api-name: java-maps-routiting
15 changes: 15 additions & 0 deletions java-maps-routiting/.repo-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"api_shortname": "maps-routiting",
"name_pretty": "Routes API",
"product_documentation": "https://developers.google.com/maps/documentation/routes",
"api_description": "Routes API is the next generation, performance optimized version of the existing Directions API and Distance Matrix API. It helps you find the ideal route from A to Z, calculates ETAs and distances for matrices of origin and destination locations, and also offers new features.",
"client_documentation": "https://cloud.google.com/java/docs/reference/google-maps-routes/latest/overview",
"release_level": "preview",
"transport": "grpc",
"language": "java",
"repo": "googleapis/java-maps-routiting",
"repo_short": "java-maps-routiting",
"distribution_name": "com.google.maps:google-maps-routes",
"api_id": "routes.googleapis.com",
"library_type": "GAPIC_AUTO"
}
201 changes: 201 additions & 0 deletions java-maps-routiting/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
# Google Routes API Client for Java

Java idiomatic client for [Routes API][product-docs].

[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.

## Quickstart


If you are using Maven, add this to your pom.xml file:


```xml
<dependency>
<groupId>com.google.maps</groupId>
<artifactId>google-maps-routes</artifactId>
<version>0.0.0</version>
</dependency>
```

If you are using Gradle without BOM, add this to your dependencies:

```Groovy
implementation 'com.google.maps:google-maps-routes:0.0.0'
```

If you are using SBT, add this to your dependencies:

```Scala
libraryDependencies += "com.google.maps" % "google-maps-routes" % "0.0.0"
```

## Authentication

See the [Authentication][authentication] section in the base directory's README.

## Authorization

The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Routes API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Routes API API calls.

## Getting Started

### Prerequisites

You will need a [Google Cloud Platform Console][developer-console] project with the Routes API [API enabled][enable-api].

[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

### Installation and setup

You'll need to obtain the `google-maps-routes` library. See the [Quickstart](#quickstart) section
to add `google-maps-routes` as a dependency in your code.

## About Routes API


[Routes API][product-docs] Routes API is the next generation, performance optimized version of the existing Directions API and Distance Matrix API. It helps you find the ideal route from A to Z, calculates ETAs and distances for matrices of origin and destination locations, and also offers new features.

See the [Routes API client library docs][javadocs] to learn how to
use this Routes API Client Library.






## Troubleshooting

To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

## Transport

Routes API uses gRPC for the transport layer.

## Supported Java Versions

Java 8 or above is required for using this client.

Google's Java client libraries,
[Google Cloud Client Libraries][cloudlibs]
and
[Google Cloud API Libraries][apilibs],
follow the
[Oracle Java SE support roadmap][oracle]
(see the Oracle Java SE Product Releases section).

### For new development

In general, new feature development occurs with support for the lowest Java
LTS version covered by Oracle's Premier Support (which typically lasts 5 years
from initial General Availability). If the minimum required JVM for a given
library is changed, it is accompanied by a [semver][semver] major release.

Java 11 and (in September 2021) Java 17 are the best choices for new
development.

### Keeping production systems current

Google tests its client libraries with all current LTS versions covered by
Oracle's Extended Support (which typically lasts 8 years from initial
General Availability).

#### Legacy support

Google's client libraries support legacy versions of Java runtimes with long
term stable libraries that don't receive feature updates on a best efforts basis
as it may not be possible to backport all patches.

Google provides updates on a best efforts basis to apps that continue to use
Java 7, though apps might need to upgrade to current versions of the library
that supports their JVM.

#### Where to find specific information

The latest versions and the supported Java versions are identified on
the individual GitHub repository `github.com/GoogleAPIs/java-SERVICENAME`
and on [google-cloud-java][g-c-j].

## Versioning


This library follows [Semantic Versioning](http://semver.org/).


It is currently in major version zero (``0.y.z``), which means that anything may change at any time
and the public API should not be considered stable.


## Contributing


Contributions to this library are always welcome and highly encouraged.

See [CONTRIBUTING][contributing] for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
information.


## License

Apache 2.0 - See [LICENSE][license] for more information.

## CI Status

Java Version | Status
------------ | ------
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]

Java is a registered trademark of Oracle and/or its affiliates.

[product-docs]: https://developers.google.com/maps/documentation/routes
[javadocs]: https://cloud.google.com/java/docs/reference/google-maps-routes/latest/overview
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-maps-routiting/java11.html
[stability-image]: https://img.shields.io/badge/stability-preview-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.maps/google-maps-routes.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.maps%20AND%20a:google-maps-routes&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/main/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-maps-routiting/blob/main/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-maps-routiting/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-maps-routiting/blob/main/LICENSE

[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=routes.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

[semver]: https://semver.org/
[cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained
[apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries
[oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html
[g-c-j]: http://github.com/googleapis/google-cloud-java
44 changes: 44 additions & 0 deletions java-maps-routiting/google-maps-routes-bom/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?xml version='1.0' encoding='UTF-8'?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.google.maps</groupId>
<artifactId>google-maps-routes-bom</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:google-maps-routes:current} -->
<packaging>pom</packaging>

<parent>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-pom-parent</artifactId>
<version>0.2.1-SNAPSHOT</version><!-- {x-version-update:google-cloud-pom-parent:current} -->
<relativePath>../../google-cloud-pom-parent/pom.xml</relativePath>
</parent>

<name>Google Routes API BOM</name>
<description>
BOM for Routes API
</description>

<properties>
<maven.antrun.skip>true</maven.antrun.skip>
</properties>

<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.maps</groupId>
<artifactId>google-maps-routes</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:google-maps-routes:current} -->
</dependency>
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>grpc-google-maps-routes-v2</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:grpc-google-maps-routes-v2:current} -->
</dependency>
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>proto-google-maps-routes-v2</artifactId>
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:proto-google-maps-routes-v2:current} -->
</dependency>
</dependencies>
</dependencyManagement>
</project>
Loading

0 comments on commit 4e67caa

Please sign in to comment.