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

Latest commit

 

History

History
137 lines (89 loc) · 5.5 KB

README.md

File metadata and controls

137 lines (89 loc) · 5.5 KB
Raw

Google OS Config API Client for Java

Java idiomatic client for OS Config API.

Maven Stability

Quickstart

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

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-os-config</artifactId>
  <version>1.1.6</version>
</dependency>

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

compile 'com.google.cloud:google-cloud-os-config:1.1.6'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-os-config" % "1.1.6"

Authentication

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

Getting Started

Prerequisites

You will need a Google Cloud Platform Console project with the OS Config API 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-os-config library. See the Quickstart section to add google-cloud-os-config as a dependency in your code.

About OS Config API

OS Config API provides OS management tools that can be used for patch management, patch compliance, and configuration management on VM instances.

See the OS Config API client library docs to learn how to use this OS Config API Client Library.

Troubleshooting

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

Transport

OS Config API uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

Versioning

This library follows Semantic Versioning.

Contributing

Contributions to this library are always welcome and highly encouraged.

See 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 for more information.

License

Apache 2.0 - See LICENSE for more information.

CI Status

Java Version Status
Java 7 Kokoro CI
Java 8 Kokoro CI
Java 8 OSX Kokoro CI
Java 8 Windows Kokoro CI
Java 11 Kokoro CI

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