Skip to content

Latest commit

 

History

History
118 lines (89 loc) · 4.79 KB

README.md

File metadata and controls

118 lines (89 loc) · 4.79 KB
Raw

Google Cloud Java Client for Cloud KMS

Java idiomatic client for Cloud KMS.

Kokoro CI Maven Codacy Badge

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-kms</artifactId>
</dependency>

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

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-kms</artifactId>
  <version>1.34.0</version>
</dependency>

If you are using Gradle, add this to your dependencies

compile 'com.google.cloud:google-cloud-kms:1.34.0'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-kms" % "1.34.0"

Authentication

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

About Google Cloud Cloud KMS

Google Cloud KMS API lets you manage encryption for your cloud services the same way you do on-premises.

See the Cloud KMS client library docs to learn how to use this Cloud KMS API Client Library.

Getting Started

Prerequisites

You will need a Google Developers Console project with the Cloud KMS API enabled. 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-kms library. See the Quickstart section to add google-cloud-kms as a dependency in your code.

Examples

More information including Java getting started examples can be found in the KMS documentation.

Troubleshooting

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

Transport

Cloud KMS uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

Versioning

This library follows Semantic Versioning.

It is currently in major version one (1.y.z), which means that the public API is 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.