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

Images

class Images(dockerClient: DockerClient)

Docker images 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

Images

constructor(dockerClient: DockerClient)

Functions

create

suspend fun create(fromImage: String, fromSrc: String? = null, repo: String? = null, tag: String? = null, message: String? = null, changes: List<String>? = null, platform: String? = null): Result<Unit, ErrorResponse>

Pulls/imports an image and consumes the complete progress response. HTTP 200 or a completed layer is not final success: Docker stream errors become an error Result. Callbacks are sequential and apply backpressure; callback exceptions and cancellation propagate. There is no implicit request/idle deadline. Cancelling closes the request without rolling back daemon work.

export

suspend fun export(name: String, platform: String? = null): Result<ByteReadChannel, ErrorResponse>

Export an image

exportAll

suspend fun exportAll(names: List<String>? = null, platform: String? = null): Result<ByteReadChannel, ErrorResponse>

Export several images

history

suspend fun history(name: String): Result<List<HistoryResponseItem>, ErrorResponse>

Get the history of an image

inspect

suspend fun inspect(name: String, manifests: Boolean = false): Result<ImageInspect, ErrorResponse>

Inspect an image

list

suspend fun list(all: Boolean = false, filters: Map<String, List<String>>? = null, sharedSize: Boolean = false, digests: Boolean = false, manifests: Boolean = false): Result<List<ImageSummary>, ErrorResponse>

List Images

load

suspend fun load(quiet: Boolean = false, body: ByteReadChannel): Result<Unit, ErrorResponse>

suspend fun load(quiet: Boolean = false, body: ByteReadChannel, onProgress: suspend (ImageProgress<Unit>) -> Unit): Result<Unit, ErrorResponse>

Loads images from a tar archive and consumes the complete progress response. HTTP 200 or a completed layer is not final success: Docker stream errors become an error Result. Callbacks are sequential and apply backpressure; callback exceptions and cancellation propagate. There is no implicit request/idle deadline. Cancelling closes the request without rolling back daemon work.

prune

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

Delete unused images

push

suspend fun push(name: String, tag: String? = null, platform: String? = null): Result<Unit, ErrorResponse>

suspend fun push(name: String, tag: String? = null, platform: String? = null, onProgress: suspend (ImageProgress<ImagePushResult>) -> Unit): Result<Unit, ErrorResponse>

Pushes a tagged image to its registry and consumes the complete progress response. HTTP 200 or a completed layer is not final success: Docker stream errors become an error Result. Callbacks are sequential and apply backpressure; callback exceptions and cancellation propagate. There is no implicit request/idle deadline. Cancelling closes the request without rolling back daemon work.

remove

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

Remove an image

suspend fun search(term: String, limit: Int? = null, filters: Map<String, List<String>>? = null): Result<List<ImageSearchResponseItem>, ErrorResponse>

Search images

tag

suspend fun tag(name: String, repo: String? = null, tag: String? = null): Result<Unit, ErrorResponse>

Tag an image