de.gesellix.docker.remote.api.ClusterVolumeInfo.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-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

/**
 * Information about the global status of the volume.
 *
 * @param capacityBytes The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown.
 * @param volumeContext A map of strings to strings returned from the storage plugin when the volume is created.
 * @param volumeID The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet.
 * @param accessibleTopology The topology this volume is actually accessible from.
 */
@JsonClass(generateAdapter = true)
data class ClusterVolumeInfo(
    // The capacity of the volume in bytes. A value of 0 indicates that the capacity is unknown.
    @Json(name = "CapacityBytes")
    var capacityBytes: kotlin.Long? = null,
    // A map of strings to strings returned from the storage plugin when the volume is created.
    @Json(name = "VolumeContext")
    var volumeContext: kotlin.collections.MutableMap? = null,
    // The ID of the volume as returned by the CSI storage plugin. This is distinct from the volume's ID as provided by Docker. This ID is never used by the user when communicating with Docker to refer to this volume. If the ID is blank, then the Volume has not been successfully created in the plugin yet.
    @Json(name = "VolumeID")
    var volumeID: kotlin.String? = null,
    // The topology this volume is actually accessible from.
    @Json(name = "AccessibleTopology")
    var accessibleTopology: kotlin.collections.MutableList>? = null,
)