https://github.com/sasa-b/hetznerkloud

Hetzner Cloud API Kotlin library
https://github.com/sasa-b/hetznerkloud

hcloud hetzner hetzner-api hetzner-cloud kotlin library

Last synced: 16 days ago
JSON representation

Hetzner Cloud API Kotlin library

• Host: GitHub
• URL: https://github.com/sasa-b/hetznerkloud
• Owner: sasa-b
• License: apache-2.0
• Created: 2024-11-01T15:48:22.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-12-18T11:44:05.000Z (about 1 month ago)
• Last Synced: 2024-12-18T12:37:12.291Z (about 1 month ago)
• Topics: hcloud, hetzner, hetzner-api, hetzner-cloud, kotlin, library
• Language: Kotlin
• Homepage:
• Size: 470 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-hcloud - hetznerkloud

README

        
# Getting Started

## Installing the package

Add to `build.gradle.kt` dependencies block.

```Kotlin

dependencies {

    implementation("tech.s-co.hetznerkloud:0.1.+")

    // or if you always want the latest version

    implementation("tech.s-co.hetznerkloud:latest.release")

}

```

## Usage

```kotlin

import tech.sco.hetznerkloud.CloudApiClient

import tech.sco.hetznerkloud.ApiToken

import tech.sco.hetznerkloud.request.FilterFields

import tech.sco.hetznerkloud.request.SortingFields

import tech.sco.hetznerkloud.request.SortingDirection

fun main() {

    

    runBlocking {

        val apiToken = ApiToken.load(Path("/some/path/token.txt"))

        val client = CloudApiClient(apiToken)

        

        client.servers.all(

            filter = setOf(Pair(FilterFields.Server.STATUS, "running")), 

            sorting = setOf(Pair(SortingFields.Server.CREATED, SortingDirection.DESC))

        ).map {

            println("Id: ${it.id}")

            println("Name: ${it.name}")

        }

    }

}

```

## Error handling

You can find all the various errors in the `src/kotlin/tech/sco/hetznerkloud/model/Error.kt` file.

All errors are wrapped in the `Failure` throwable object which will also hold the request object that caused the error, that should help you in debugging potential issues.

```Kotlin

import tech.sco.hetznerkloud.CloudApiClient

import tech.sco.hetznerkloud.ApiToken

import tech.sco.hetznerkloud.request.CreateSSHKey

fun main() {

    

    runBlocking {

        val apiToken = ApiToken.load(Path("/some/path/token.txt"))

        val client = CloudApiClient(apiToken)

        try {

            client.sshKeys.create(CreateSSHKey(name = "login key", labels = emptyMap()))

        } catch (f: Failure) {

            when {

                f.error is UnauthorizedError -> println(f.request!!.headers)

            }

        }

        

    }

}

```

## Ktor client plugins

You can extend the behaviour of the Ktor client used under the hood by adding official or custom plugins.

By default, the following ones are installed and used by this library:

* Auth

* Content Negotiation

* Kotlinx Serialization

For example let's add retry behaviour with a plugin:

```kotlin

val client = CloudApiClient(ApiToken("xxx-xxx-xxx")) {

    install(HttpRequestRetry) {

        retryOnServerErrors(maxRetries = 5)

    }

}

```