Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.api/Volumes

Volumes

class Volumes(dockerClient: DockerClient)

Docker volumes operations using the owning DockerClient.

Result-returning methods report daemon HTTP errors as ErrorResponse. Transport/decoding failures and cancellation can throw. Live flows report request failures during collection.

Constructors

Volumes

constructor(dockerClient: DockerClient)

Functions

create

suspend fun create(config: VolumeCreateOptions = VolumeCreateOptions()): Result<Volume, ErrorResponse>

Create a volume

getInfo

suspend fun getInfo(name: String): Result<Volume, ErrorResponse>

Inspect a volume

getList

suspend fun getList(filters: Map<String, List<String>>? = null): Result<VolumeListResponse, ErrorResponse>

List volumes

prune

suspend fun prune(filters: Map<String, List<String>>? = null): Result<VolumePruneResponse, ErrorResponse>

Deletes unused volumes selected by Docker and the supplied filters. This can destroy persistent data.

remove

suspend fun remove(name: String, force: Boolean = false): Result<Unit, ErrorResponse>

Deletes a volume and its persistent data. Invoke only for an explicit data-deletion action. Container removal does not require deleting its named volumes.