All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

There is a newer version: 2024-11-04T20-53-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

/**
 *
 *
 * @param name Name of the volume.
 * @param driver Name of the volume driver used by the volume.
 * @param mountpoint Mount path of the volume on the host.
 * @param options The driver specific options used when creating the volume.
 * @param createdAt Date/Time the volume was created.
 * @param status Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`.  The `Status` field is optional, and is omitted if the volume driver does not support this feature.
 * @param labels User-defined key/value metadata.
 * @param scope The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.
 * @param clusterVolume
 * @param usageData
 */
@JsonClass(generateAdapter = true)
data class Volume(
    // Name of the volume.
    @Json(name = "Name")
    var name: kotlin.String,
    // Name of the volume driver used by the volume.
    @Json(name = "Driver")
    var driver: kotlin.String,
    // Mount path of the volume on the host.
    @Json(name = "Mountpoint")
    var mountpoint: kotlin.String,
    // The driver specific options used when creating the volume.
    @Json(name = "Options")
    var options: kotlin.collections.MutableMap?,
    // Date/Time the volume was created.
    @Json(name = "CreatedAt")
    var createdAt: kotlin.String? = null,
    // Low-level details about the volume, provided by the volume driver. Details are returned as a map with key/value pairs: `{\"key\":\"value\",\"key2\":\"value2\"}`.  The `Status` field is optional, and is omitted if the volume driver does not support this feature.
    @Json(name = "Status")
    var status: kotlin.collections.MutableMap? = null,
    // User-defined key/value metadata.
    @Json(name = "Labels")
    var labels: kotlin.collections.MutableMap? = null,
    // The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.
    @Json(name = "Scope")
    var scope: Volume.Scope? = Scope.Local,
    @Json(name = "ClusterVolume")
    var clusterVolume: ClusterVolume? = null,
    @Json(name = "UsageData")
    var usageData: VolumeUsageData? = null,
) {
    /**
     * The level at which the volume exists. Either `global` for cluster-wide, or `local` for machine level.
     *
     * Values: Local,Global
     */
    @JsonClass(generateAdapter = false)
    enum class Scope(val value: kotlin.String) {
        @Json(name = "local")
        Local("local"),

        @Json(name = "global")
        Global("global"),
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy