Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.model/Volume

Volume

@Serializable

data class Volume(val name: String, val driver: String, val mountpoint: String, val scope: Volume.Scope = Scope.LOCAL, val options: Map<String, String>?, val createdAt: String? = null, val status: Map<String, JsonObject>? = null, val labels: Map<String, String>? = null, val clusterVolume: ClusterVolume? = null, val usageData: VolumeUsageData? = null)

Parameters

name

Name of the volume.

driver

Name of the volume driver used by the volume.

mountpoint

Mount path of the volume on the host.

scope

The level at which the volume exists. Either global for cluster-wide, or local for machine level.

options

The driver specific options used when creating the volume.

createdAt

Date/Time the volume was created.

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.

labels

User-defined key/value metadata.

clusterVolume

usageData

Constructors

Volume

constructor(name: String, driver: String, mountpoint: String, scope: Volume.Scope = Scope.LOCAL, options: Map<String, String>?, createdAt: String? = null, status: Map<String, JsonObject>? = null, labels: Map<String, String>? = null, clusterVolume: ClusterVolume? = null, usageData: VolumeUsageData? = null)