-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: [apikeys] new module for apikeys (#8550)
* feat: initial generation of apikeys * build: add the apikeys module to monorepo
- Loading branch information
Showing
74 changed files
with
30,210 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# 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-apikeys/grpc-google-.*/src" | ||
- "/java-apikeys/proto-google-.*/src" | ||
- "/java-apikeys/google-.*/src" | ||
|
||
deep-preserve-regex: | ||
- "/java-apikeys/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java" | ||
|
||
deep-copy-regex: | ||
- source: "/google/api/apikeys/(v.*)/.*-java/proto-google-.*/src" | ||
dest: "/owl-bot-staging/java-apikeys/$1/proto-google-cloud-apikeys-$1/src" | ||
- source: "/google/api/apikeys/(v.*)/.*-java/grpc-google-.*/src" | ||
dest: "/owl-bot-staging/java-apikeys/$1/grpc-google-cloud-apikeys-$1/src" | ||
- source: "/google/api/apikeys/(v.*)/.*-java/gapic-google-.*/src" | ||
dest: "/owl-bot-staging/java-apikeys/$1/google-cloud-apikeys/src" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
{ | ||
"api_shortname": "apikeys", | ||
"name_pretty": "API Keys API", | ||
"product_documentation": "https://cloud.google.com/api-keys/", | ||
"api_description": "API Keys lets you create and manage your API keys for your projects.", | ||
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-apikeys/latest/overview", | ||
"release_level": "preview", | ||
"transport": "grpc", | ||
"language": "java", | ||
"repo": "googleapis/java-apikeys", | ||
"repo_short": "java-apikeys", | ||
"distribution_name": "com.google.cloud:google-cloud-apikeys", | ||
"api_id": "apikeys.googleapis.com", | ||
"library_type": "GAPIC_AUTO", | ||
"requires_billing": true | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,201 @@ | ||
# Google API Keys API Client for Java | ||
|
||
Java idiomatic client for [API Keys 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.cloud</groupId> | ||
<artifactId>google-cloud-apikeys</artifactId> | ||
<version>0.1.2</version> | ||
</dependency> | ||
``` | ||
|
||
If you are using Gradle without BOM, add this to your dependencies: | ||
|
||
```Groovy | ||
implementation 'com.google.cloud:google-cloud-apikeys:0.1.2' | ||
``` | ||
|
||
If you are using SBT, add this to your dependencies: | ||
|
||
```Scala | ||
libraryDependencies += "com.google.cloud" % "google-cloud-apikeys" % "0.1.2" | ||
``` | ||
|
||
## 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 API Keys API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the API Keys API API calls. | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
You will need a [Google Cloud Platform Console][developer-console] project with the API Keys API [API enabled][enable-api]. | ||
You will need to [enable billing][enable-billing] to use Google API Keys 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-cloud-apikeys` library. See the [Quickstart](#quickstart) section | ||
to add `google-cloud-apikeys` as a dependency in your code. | ||
|
||
## About API Keys API | ||
|
||
|
||
[API Keys API][product-docs] API Keys lets you create and manage your API keys for your projects. | ||
|
||
See the [API Keys API client library docs][javadocs] to learn how to | ||
use this API Keys API Client Library. | ||
|
||
|
||
|
||
|
||
|
||
|
||
## Troubleshooting | ||
|
||
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. | ||
|
||
## Transport | ||
|
||
API Keys 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://cloud.google.com/api-keys/ | ||
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-apikeys/latest/overview | ||
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java7.svg | ||
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java7.html | ||
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java8.svg | ||
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java8.html | ||
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java8-osx.svg | ||
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java8-osx.html | ||
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java8-win.svg | ||
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java8-win.html | ||
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java11.svg | ||
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-apikeys/java11.html | ||
[stability-image]: https://img.shields.io/badge/stability-preview-yellow | ||
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-apikeys.svg | ||
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-apikeys&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-apikeys/blob/main/CONTRIBUTING.md | ||
[code-of-conduct]: https://github.com/googleapis/java-apikeys/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct | ||
[license]: https://github.com/googleapis/java-apikeys/blob/main/LICENSE | ||
[enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing | ||
[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=apikeys.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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
<?xml version="1.0"?> | ||
<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.cloud</groupId> | ||
<artifactId>google-cloud-apikeys-bom</artifactId> | ||
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:google-cloud-apikeys:current} --> | ||
<packaging>pom</packaging> | ||
<parent> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-shared-config</artifactId> | ||
<version>1.5.3</version> | ||
</parent> | ||
|
||
<name>Google API Keys API BOM</name> | ||
<url>https://github.com/googleapis/java-apikeys</url> | ||
<description> | ||
BOM for API Keys API | ||
</description> | ||
|
||
<organization> | ||
<name>Google LLC</name> | ||
</organization> | ||
|
||
<developers> | ||
<developer> | ||
<id>chingor13</id> | ||
<name>Jeff Ching</name> | ||
<email>chingor@google.com</email> | ||
<organization>Google LLC</organization> | ||
<roles> | ||
<role>Developer</role> | ||
</roles> | ||
</developer> | ||
<developer> | ||
<id>neenushaji</id> | ||
<name>Neenu Shaji</name> | ||
<email>neenushaji@google.com</email> | ||
<organization>Google LLC</organization> | ||
<roles> | ||
<role>Developer</role> | ||
</roles> | ||
</developer> | ||
</developers> | ||
|
||
<scm> | ||
<connection>scm:git:https://github.com/googleapis/java-apikeys.git</connection> | ||
<developerConnection>scm:git:git@github.com:googleapis/java-apikeys.git</developerConnection> | ||
<url>https://github.com/googleapis/java-apikeys</url> | ||
</scm> | ||
|
||
<properties> | ||
<maven.antrun.skip>true</maven.antrun.skip> | ||
</properties> | ||
|
||
<licenses> | ||
<license> | ||
<name>The Apache Software License, Version 2.0</name> | ||
<url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> | ||
<distribution>repo</distribution> | ||
</license> | ||
</licenses> | ||
|
||
<dependencyManagement> | ||
<dependencies> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-apikeys</artifactId> | ||
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:google-cloud-apikeys:current} --> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.api.grpc</groupId> | ||
<artifactId>grpc-google-cloud-apikeys-v2</artifactId> | ||
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:grpc-google-cloud-apikeys-v2:current} --> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.google.api.grpc</groupId> | ||
<artifactId>proto-google-cloud-apikeys-v2</artifactId> | ||
<version>0.0.1-SNAPSHOT</version><!-- {x-version-update:proto-google-cloud-apikeys-v2:current} --> | ||
</dependency> | ||
</dependencies> | ||
</dependencyManagement> | ||
|
||
<build> | ||
<plugins> | ||
<plugin> | ||
<groupId>org.apache.maven.plugins</groupId> | ||
<artifactId>maven-checkstyle-plugin</artifactId> | ||
<configuration> | ||
<skip>true</skip> | ||
</configuration> | ||
</plugin> | ||
</plugins> | ||
</build> | ||
</project> |
Oops, something went wrong.