-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: [memorystore] new module for memorystore #11356
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
8ba40e4
feat: [memorystore] new module for memorystore
cloud-java-bot cd41845
chore: generate libraries at Mon Dec 16 14:46:47 UTC 2024
cloud-java-bot 2009929
add v1
JoeWang1127 72896fe
Merge branch 'new-library/memorystore-0Jhea' of github.com:googleapis…
JoeWang1127 e6fcb41
chore: generate libraries at Mon Dec 16 14:51:36 UTC 2024
cloud-java-bot 4e6facd
change to valkey
JoeWang1127 7fd6228
Merge branch 'new-library/memorystore-0Jhea' of github.com:googleapis…
JoeWang1127 a64ae7b
chore: generate libraries at Mon Dec 16 15:59:04 UTC 2024
cloud-java-bot cc75350
chore: generate libraries at Mon Dec 16 16:02:22 UTC 2024
cloud-java-bot d2c6f4b
remove generated module
JoeWang1127 e48f56e
Merge branch 'new-library/memorystore-0Jhea' of github.com:googleapis…
JoeWang1127 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,35 @@ | ||
# Copyright 2024 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-valkey/grpc-google-.*/src" | ||
- "/java-valkey/proto-google-.*/src" | ||
- "/java-valkey/google-.*/src" | ||
- "/java-valkey/samples/snippets/generated" | ||
|
||
deep-preserve-regex: | ||
- "/java-valkey/google-.*/src/test/java/com/google/cloud/.*/v.*/it/IT.*Test.java" | ||
|
||
deep-copy-regex: | ||
- source: "/google/cloud/memorystore/(v.*)/.*-java/proto-google-.*/src" | ||
dest: "/owl-bot-staging/java-valkey/$1/proto-google-cloud-valkey-$1/src" | ||
- source: "/google/cloud/memorystore/(v.*)/.*-java/grpc-google-.*/src" | ||
dest: "/owl-bot-staging/java-valkey/$1/grpc-google-cloud-valkey-$1/src" | ||
- source: "/google/cloud/memorystore/(v.*)/.*-java/gapic-google-.*/src" | ||
dest: "/owl-bot-staging/java-valkey/$1/google-cloud-valkey/src" | ||
- source: "/google/cloud/memorystore/(v.*)/.*-java/samples/snippets/generated" | ||
dest: "/owl-bot-staging/java-valkey/$1/samples/snippets/generated" | ||
|
||
api-name: memorystore |
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,17 @@ | ||
{ | ||
"api_shortname": "memorystore", | ||
"name_pretty": "Memorystore API", | ||
"product_documentation": "https://cloud.google.com/memorystore/docs/valkey", | ||
"api_description": "Memorystore for Valkey is a fully managed Valkey Cluster service for Google Cloud.", | ||
"client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-memorystore/latest/overview", | ||
"release_level": "stable", | ||
"transport": "http", | ||
"language": "java", | ||
"repo": "googleapis/google-cloud-java", | ||
"repo_short": "java-valkey", | ||
"distribution_name": "com.google.cloud:google-cloud-valkey", | ||
"api_id": "memorystore.googleapis.com", | ||
"library_type": "GAPIC_AUTO", | ||
"requires_billing": true, | ||
"rest_documentation": "https://cloud.google.com/memorystore/docs/valkey/reference/rest" | ||
} |
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,218 @@ | ||
# Google Memorystore API Client for Java | ||
|
||
Java idiomatic client for [Memorystore API][product-docs]. | ||
|
||
[![Maven][maven-version-image]][maven-version-link] | ||
![Stability][stability-image] | ||
|
||
- [Product Documentation][product-docs] | ||
- [Client Library Documentation][javadocs] | ||
|
||
|
||
## Quickstart | ||
|
||
|
||
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file: | ||
|
||
```xml | ||
<dependencyManagement> | ||
<dependencies> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>libraries-bom</artifactId> | ||
<version>26.51.0</version> | ||
<type>pom</type> | ||
<scope>import</scope> | ||
</dependency> | ||
</dependencies> | ||
</dependencyManagement> | ||
|
||
<dependencies> | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-valkey</artifactId> | ||
</dependency> | ||
</dependencies> | ||
``` | ||
|
||
If you are using Maven without the BOM, add this to your dependencies: | ||
|
||
|
||
```xml | ||
<dependency> | ||
<groupId>com.google.cloud</groupId> | ||
<artifactId>google-cloud-valkey</artifactId> | ||
<version>0.0.0</version> | ||
</dependency> | ||
``` | ||
|
||
If you are using Gradle without BOM, add this to your dependencies: | ||
|
||
```Groovy | ||
implementation 'com.google.cloud:google-cloud-valkey:0.0.0' | ||
``` | ||
|
||
If you are using SBT, add this to your dependencies: | ||
|
||
```Scala | ||
libraryDependencies += "com.google.cloud" % "google-cloud-valkey" % "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 Memorystore API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Memorystore API API calls. | ||
|
||
## Getting Started | ||
|
||
### Prerequisites | ||
|
||
You will need a [Google Cloud Platform Console][developer-console] project with the Memorystore API [API enabled][enable-api]. | ||
You will need to [enable billing][enable-billing] to use Google Memorystore 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 Command Line Interface][cloud-cli] 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-valkey` library. See the [Quickstart](#quickstart) section | ||
to add `google-cloud-valkey` as a dependency in your code. | ||
|
||
## About Memorystore API | ||
|
||
|
||
[Memorystore API][product-docs] Memorystore for Valkey is a fully managed Valkey Cluster service for Google Cloud. | ||
|
||
See the [Memorystore API client library docs][javadocs] to learn how to | ||
use this Memorystore API Client Library. | ||
|
||
|
||
|
||
|
||
|
||
|
||
## Troubleshooting | ||
|
||
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. | ||
|
||
## Transport | ||
|
||
Memorystore API uses HTTP/JSON 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/). | ||
|
||
|
||
|
||
## 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/memorystore/docs/valkey | ||
[javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-memorystore/latest/overview | ||
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.svg | ||
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java7.html | ||
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.svg | ||
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8.html | ||
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.svg | ||
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-osx.html | ||
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.svg | ||
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java8-win.html | ||
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.svg | ||
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html | ||
[stability-image]: https://img.shields.io/badge/stability-stable-green | ||
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-valkey.svg | ||
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-valkey/0.0.0 | ||
[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-cli]: https://cloud.google.com/cli | ||
[troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md | ||
[contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md | ||
[code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct | ||
[license]: https://github.com/googleapis/google-cloud-java/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=memorystore.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 |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Product documentation is specific to valkey, but client documentation is generic.
Are we going to have collision issues with any of these other Memorystore variants? https://cloud.google.com/memorystore/docs/
(Redis, Redis Cluster, Memcached)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The client doc is unique if the artifact is unique,
google-cloud-memorystore
, in this case.If you think memorystore is too generic, how about we change the artifact id to
google-cloud-valkey
? Redis, Redis Cluster, Memcached are all followed this pattern.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes - following the existing pattern would be great -- thank you.