https://github.com/tomsiewert/hetznercloud-java

Java Library for the Hetzner Cloud API
https://github.com/tomsiewert/hetznercloud-java

automation hcloud hetzner hetzner-cloud java

Last synced: about 2 months ago
JSON representation

Java Library for the Hetzner Cloud API

• Host: GitHub
• URL: https://github.com/tomsiewert/hetznercloud-java
• Owner: tomsiewert
• License: mit
• Created: 2018-01-25T10:40:11.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-07-27T13:16:27.000Z (about 2 months ago)
• Last Synced: 2024-07-28T17:35:29.144Z (about 2 months ago)
• Topics: automation, hcloud, hetzner, hetzner-cloud, java
• Language: Java
• Homepage: https://tomsiewert.github.io/hetznercloud-java
• Size: 2.34 MB
• Stars: 40
• Watchers: 4
• Forks: 18
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-hcloud - hetznercloud-java

README

        
Hetzner Cloud API for Java

==========================

![Test Action Status](https://github.com/TomSDEVSN/hetznercloud-java/actions/workflows/test.yml/badge.svg)

![Build Action Status](https://github.com/TomSDEVSN/hetznercloud-java/actions/workflows/build.yml/badge.svg)

Simple Java client for the Hetzner Cloud API.

**Important message about this project [here](https://github.com/TomSDEVSN/hetznercloud-java/discussions/45)**

## Compile

This project uses Maven as build automation.

Just run ``mvn clean install`` to install it in the local Maven repository cache.

## How to use

##### Maven

Dependency:

```xml

    

        me.tomsdevsn

        hetznercloud-api

        3.2.6

    

```

##### Gradle

Put this in the ``build.gradle`` file of the project:

```groovy

repositories {

    mavenCentral()

}

dependencies {

    implementation "me.tomsdevsn:hetznercloud-api:3.2.6"

}

```

  kotlin-dsl

```kotlin

dependencies {

    implementation("me.tomsdevsn:hetznercloud-api:3.2.6")

}

```

## How to run tests

The tests need an API Token for the Hetzner Cloud. The API token has to be set as an environment variable called `HCLOUD_TOKEN`.

To obtain an API key, please see [the official API documentation](https://docs.hetzner.cloud/#getting-started).

```

HCLOUD_TOKEN="${api_key}" mvn test

```

## JavaDocs

The JavaDocs are available [here](https://tomsiewert.github.io/hetznercloud-java/)

## Dependencies

The following dependencies were used in this project:

* [jackson-databind](https://github.com/FasterXML/jackson-databind) under Apache2.0 License

* [Lombok](https://projectlombok.org) under MIT License