Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

Latest commit

 

History

History
133 lines (102 loc) · 5.09 KB

README.md

File metadata and controls

133 lines (102 loc) · 5.09 KB
Raw

Google Cloud Java Client for Redis

Java idiomatic client for Cloud Memorystore for Redis.

Kokoro CI Maven Codacy Badge

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

Quickstart

If you are using Maven with a BOM, add this to your pom.xml file.

<dependencyManagement>
 <dependencies>
  <dependency>
    <groupId>com.google.cloud</groupId>
    <artifactId>libraries-bom</artifactId>
    <version>2.8.0</version>
    <type>pom</type>
    <scope>import</scope>
   </dependency>
 </dependencies>
</dependencyManagement>

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-redis</artifactId>
</dependency>

If you are using Maven without a BOM, add this to your dependencies.

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-redis</artifactId>
  <version>0.116.0-alpha</version>
</dependency>

If you are using Gradle, add this to your dependencies

compile 'com.google.cloud:google-cloud-redis:0.116.0-alpha'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-redis" % "0.116.0-alpha"

Authentication

See the Authentication section in the base directory's README.

About Cloud Memorystore for Redis

Cloud Memorystore for Redis API transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.

See the Cloud Memorystore for Redis client library docs to learn how to interact with the Cloud Redis using this Client Library.

Getting Started

Prerequisites

For this tutorial, you will need a Google Developers Console project with the Cloud Memorystore for Redis API enabled. You will need to enable billing to use Google Cloud Redis. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google 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-redis library. See the Quickstart section to add google-cloud-redis as a dependency in your code.

Transport

Cloud Memorystore for Redis uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

Testing

This library has tools to help make tests for code using Cloud Memorystore for Redis.

See TESTING to read more about testing.

Versioning

This library follows Semantic Versioning.

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 google-cloud's CONTRIBUTING documentation and the shared documentation for more information on 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 for more information.

License

Apache 2.0 - See LICENSE for more information.