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

Containers

class Containers(dockerClient: DockerClient)

Constructors

constructor(dockerClient: DockerClient)

Functions

suspend fun attach(id: String, detachKeys: String? = null, logs: Boolean = false, stream: Boolean = false, stdin: Boolean = false, stdout: Boolean = false, stderr: Boolean = false): Result<ExecSession, ErrorResponse>

Attach to a container

create

suspend fun create(name: String? = null, config: ContainerConfig = ContainerConfig()): Result<ContainerCreateResponse, ErrorResponse>

Create a container

execCreate

suspend fun execCreate(id: String, config: ExecConfig): Result<IDResponse, ErrorResponse>

Create an exec instance

export

suspend fun export(id: String): Result<ByteReadChannel, ErrorResponse>

Export a container

getArchive

suspend fun getArchive(id: String, path: String): Result<ByteReadChannel, ErrorResponse>

Get an archive of a filesystem resource in a container

getArchiveInfo

suspend fun getArchiveInfo(id: String, path: String): Result<String, ErrorResponse>

Get information about files in a container

getChanges

suspend fun getChanges(id: String): Result<List<FilesystemChange>, ErrorResponse>

Get changes on a container's filesystem

getInfo

suspend fun getInfo(id: String): Result<ContainerInspectResponse, ErrorResponse>

Inspect a container

getList

suspend fun getList(all: Boolean = false, limit: Int? = null, size: Boolean = false, filters: Map<String, List<String>>? = null): Result<List<ContainerSummary>, ErrorResponse>

List containers

getLogs

suspend fun getLogs(id: String, parameters: ContainerLogsParameters = ContainerLogsParameters()): Result<Flow<LogLine>, ErrorResponse>

Get container logs

getStats

suspend fun getStats(id: String, stream: Boolean = true, oneShot: Boolean = false): Result<Flow<ContainerStatsResponse>, ErrorResponse>

Get container stats based on resource usage

getTop

suspend fun getTop(id: String, psArgs: String? = null): Result<ContainerTopResponse, ErrorResponse>

List processes running inside a container

kill

suspend fun kill(id: String, signal: String? = null): Result<Unit, ErrorResponse>

Kill a container

pause

suspend fun pause(id: String): Result<Unit, ErrorResponse>

Pause a container

prune

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

Delete unused containers

putArchive

suspend fun putArchive(id: String, path: String, body: ByteReadChannel, noOverwriteDirNonDir: Boolean? = null, copyUIDGID: Boolean? = null): Result<Unit, ErrorResponse>

Extract an archive of files or folders into a directory in a container

remove