Container (BioFSharp)

Container Module

Namespace: BioFSharp.BioContainers
Assembly: BioFSharp.BioContainers.dll
Parent Module: Docker

Types

Type	Description
ContainerParams	Provides a set of static methods for creating Image parameter.

Functions and values

Function or value	Description
`createContainerByImage connection imageName` Full Usage: `createContainerByImage connection imageName` Parameters: connection : `DockerClient` imageName : `string` Returns: `CreateContainerResponse`	Creates docker container of an image given by image name (async) connection : `DockerClient` imageName : `string` Returns: `CreateContainerResponse`
`createContainerByImageAsync connection imageName` Full Usage: `createContainerByImageAsync connection imageName` Parameters: connection : `DockerClient` imageName : `string` Returns: `Async<CreateContainerResponse>`	Creates docker container of an image given by image name (async) connection : `DockerClient` imageName : `string` Returns: `Async<CreateContainerResponse>`
`createContainerWithAsync connection param` Full Usage: `createContainerWithAsync connection param` Parameters: connection : `DockerClient` param : `CreateContainerParameters` Returns: `Async<CreateContainerResponse>`	Creates docker container with CreateContainerParameters for config (async) connection : `DockerClient` param : `CreateContainerParameters` Returns: `Async<CreateContainerResponse>`
`createContainerWithExecConfigAsync connection param id` Full Usage: `createContainerWithExecConfigAsync connection param id` Parameters: connection : `DockerClient` param : `ContainerExecCreateParameters` id : `string` Returns: `Async<ContainerExecCreateResponse>`	Creates docker container with ContainerExecStartParameters for config (async) connection : `DockerClient` param : `ContainerExecCreateParameters` id : `string` Returns: `Async<ContainerExecCreateResponse>`
`execCreateContainerAsync connection param id` Full Usage: `execCreateContainerAsync connection param id` Parameters: connection : `DockerClient` param : `ContainerExecCreateParameters` id : `string` Returns: `Async<ContainerExecCreateResponse>`	Creates an container that will perform the execution (async). IMPORTANT: Start exec-container using StartContainerExecAsync connection : `DockerClient` param : `ContainerExecCreateParameters` id : `string` Returns: `Async<ContainerExecCreateResponse>`
`existsByAsync connection dockerid` Full Usage: `existsByAsync connection dockerid` Parameters: connection : `DockerClient` dockerid : `DockerId` Returns: `Async<bool>`	Returns true if acontainer matches the dockerid (async) connection : `DockerClient` dockerid : `DockerId` Returns: `Async<bool>`
`existsByImage connection dockerid` Full Usage: `existsByImage connection dockerid` Parameters: connection : `DockerClient` dockerid : `DockerId` Returns: `bool`	Returns true if acontainer matches the dockerid connection : `DockerClient` dockerid : `DockerId` Returns: `bool`
`extractArchiveToContainerAsync connection param id stream` Full Usage: `extractArchiveToContainerAsync connection param id stream` Parameters: connection : `DockerClient` param : `ContainerPathStatParameters` id : `string` stream : `Stream` Returns: `Async<unit>`	Writes stream into docker container connection : `DockerClient` param : `ContainerPathStatParameters` id : `string` stream : `Stream` Returns: `Async<unit>`
`getArchiveFromContainerAsync connection param statOnly id` Full Usage: `getArchiveFromContainerAsync connection param statOnly id` Parameters: connection : `DockerClient` param : `GetArchiveFromContainerParameters` statOnly : `bool` id : `string` Returns: `Async<GetArchiveFromContainerResponse>`	connection : `DockerClient` param : `GetArchiveFromContainerParameters` statOnly : `bool` id : `string` Returns: `Async<GetArchiveFromContainerResponse>`
`getContainerLogs connection id` Full Usage: `getContainerLogs connection id` Parameters: connection : `DockerClient` id : `string` Returns: `Stream`	Get logs from container and show StdOut connection : `DockerClient` id : `string` Returns: `Stream`
`getContainerLogsAsync connection param id` Full Usage: `getContainerLogsAsync connection param id` Parameters: connection : `DockerClient` param : `ContainerLogsParameters` id : `string` Returns: `Async<Stream>`	Get logs from container (async) connection : `DockerClient` param : `ContainerLogsParameters` id : `string` Returns: `Async<Stream>`
`listAllContainersAsync connection` Full Usage: `listAllContainersAsync connection` Parameters: connection : `DockerClient` Returns: `Async<ContainerListResponse seq>`	Lists all available containers (async) connection : `DockerClient` Returns: `Async<ContainerListResponse seq>`
`listContainersWithAsync connection param` Full Usage: `listContainersWithAsync connection param` Parameters: connection : `DockerClient` param : `ContainersListParameters` Returns: `Async<ContainerListResponse seq>`	Lists available containers with ContainersListParameters for filtering (async) connection : `DockerClient` param : `ContainersListParameters` Returns: `Async<ContainerListResponse seq>`
`removeContainerAsync connection dockerid` Full Usage: `removeContainerAsync connection dockerid` Parameters: connection : `DockerClient` dockerid : `DockerId` Returns: `Async<unit>`	Removes container connection : `DockerClient` dockerid : `DockerId` Returns: `Async<unit>`
`removeContainerWithAsync connection param dockerid` Full Usage: `removeContainerWithAsync connection param dockerid` Parameters: connection : `DockerClient` param : `ContainerRemoveParameters` dockerid : `DockerId` Returns: `Async<unit>`	Removes container connection : `DockerClient` param : `ContainerRemoveParameters` dockerid : `DockerId` Returns: `Async<unit>`
`startContainer connection id` Full Usage: `startContainer connection id` Parameters: connection : `DockerClient` id : `string` Returns: `bool`	Start container by a given ID connection : `DockerClient` id : `string` Returns: `bool`
`startContainerAsync connection id` Full Usage: `startContainerAsync connection id` Parameters: connection : `DockerClient` id : `string` Returns: `Async<bool>`	Start container by a given ID (async) connection : `DockerClient` id : `string` Returns: `Async<bool>`
`startContainerExecAsync connection id` Full Usage: `startContainerExecAsync connection id` Parameters: connection : `DockerClient` id : `string` Returns: `Async<unit>`	Starts connection : `DockerClient` id : `string` Returns: `Async<unit>`
`startContainerWithAsync connection param id` Full Usage: `startContainerWithAsync connection param id` Parameters: connection : `DockerClient` param : `ContainerStartParameters` id : `string` Returns: `Async<bool>`	Start container with CreateContainerParameters for config (async) connection : `DockerClient` param : `ContainerStartParameters` id : `string` Returns: `Async<bool>`
`startContainerWithExecConfigAsync connection param id` Full Usage: `startContainerWithExecConfigAsync connection param id` Parameters: connection : `DockerClient` param : `ContainerExecStartParameters` id : `string` Returns: `Async<MultiplexedStream>`	Start container with ContainerExecStartParameters for config (async) connection : `DockerClient` param : `ContainerExecStartParameters` id : `string` Returns: `Async<MultiplexedStream>`
`stopContainerAsync connection param id` Full Usage: `stopContainerAsync connection param id` Parameters: connection : `DockerClient` param : `ContainerStopParameters` id : `string` Returns: `Async<bool>`	Stops connection : `DockerClient` param : `ContainerStopParameters` id : `string` Returns: `Async<bool>`
`waitContainer connection id` Full Usage: `waitContainer connection id` Parameters: connection : `DockerClient` id : `string` Returns: `ContainerWaitResponse`	Wait for container connection : `DockerClient` id : `string` Returns: `ContainerWaitResponse`
`waitContainerAsync connection id` Full Usage: `waitContainerAsync connection id` Parameters: connection : `DockerClient` id : `string` Returns: `Async<ContainerWaitResponse>`	Wait for container (async) connection : `DockerClient` id : `string` Returns: `Async<ContainerWaitResponse>`