de.gesellix.docker.remote.api.Reachability.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docker-remote-api-model-1-45 Show documentation

API model for the Docker remote api v1.45

There is a newer version: 2024-09-15T19-05-00

Show newest version

/**
 *
 * Please note:
 * This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit this file manually.
 *
 */

@file:Suppress(
    "ArrayInDataClass",
    "EnumEntryName",
    "RemoveRedundantQualifierName",
    "UnusedImport",
)

package de.gesellix.docker.remote.api

import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass

/**
 * Reachability represents the reachability of a node.
 *
 * Values: Unknown,Unreachable,Reachable
 */

@JsonClass(generateAdapter = false)
enum class Reachability(val value: kotlin.String) {
    @Json(name = "unknown")
    Unknown("unknown"),

    @Json(name = "unreachable")
    Unreachable("unreachable"),

    @Json(name = "reachable")
    Reachable("reachable"),
    ;

    /**
     * Override [toString()] to avoid using the enum variable name as the value, and instead use
     * the actual value defined in the API spec file.
     *
     * This solves a problem when the variable name and its value are different, and ensures that
     * the client sends the correct enum values to the server always.
     */
    override fun toString(): kotlin.String = value

    companion object {
        /**
         * Converts the provided [data] to a [String] on success, null otherwise.
         */
        fun encode(data: kotlin.Any?): kotlin.String? = if (data is Reachability) "$data" else null

        /**
         * Returns a valid [Reachability] for [data], null otherwise.
         */
        fun decode(data: kotlin.Any?): Reachability? =
            data?.let {
                val normalizedData = "$it".lowercase()
                values().firstOrNull { value ->
                    it == value || normalizedData == "$value".lowercase()
                }
            }
    }
}