Header menu logo BioFSharp

ContainerParams Type

Namespace: BioFSharp.BioContainers
Assembly: BioFSharp.BioContainers.dll
Parent Module: Container
Base Type: obj

Provides a set of static methods for creating Image parameter.

Static members

Static member Description

ContainerParams.InitBindOptions(?Propagation)

Full Usage: ContainerParams.InitBindOptions(?Propagation)

Parameters:
    ?Propagation : string

Returns: BindOptions

Creates BindOptions

?Propagation : string
Returns: BindOptions

ContainerParams.InitContainerAttachParameters(?DetachKeys, ?Logs, ?Stderr, ?Stdin, ?Stdout, ?Stream)

Full Usage: ContainerParams.InitContainerAttachParameters(?DetachKeys, ?Logs, ?Stderr, ?Stdin, ?Stdout, ?Stream)

Parameters:
    ?DetachKeys : string
    ?Logs : string
    ?Stderr : bool
    ?Stdin : bool
    ?Stdout : bool
    ?Stream : bool

Returns: ContainerAttachParameters

Creates ContainerAttachParameters

?DetachKeys : string
?Logs : string
?Stderr : bool
?Stdin : bool
?Stdout : bool
?Stream : bool
Returns: ContainerAttachParameters

ContainerParams.InitContainerExecCreateParameters(?AttachStderr, ?AttachStdin, ?AttachStdout, ?Cmd, ?Detach, ?DetachKeys, ?Env, ?Privileged, ?Tty, ?User)

Full Usage: ContainerParams.InitContainerExecCreateParameters(?AttachStderr, ?AttachStdin, ?AttachStdout, ?Cmd, ?Detach, ?DetachKeys, ?Env, ?Privileged, ?Tty, ?User)

Parameters:
    ?AttachStderr : bool
    ?AttachStdin : bool
    ?AttachStdout : bool
    ?Cmd : string seq
    ?Detach : bool
    ?DetachKeys : string
    ?Env : string seq
    ?Privileged : bool
    ?Tty : bool
    ?User : string

Returns: ContainerExecCreateParameters

Creates ContainerExecStartParameters

?AttachStderr : bool
?AttachStdin : bool
?AttachStdout : bool
?Cmd : string seq
?Detach : bool
?DetachKeys : string
?Env : string seq
?Privileged : bool
?Tty : bool
?User : string
Returns: ContainerExecCreateParameters

ContainerParams.InitContainerExecStartParameters(?AttachStderr, ?AttachStdin, ?AttachStdout, ?Cmd, ?Detach, ?DetachKeys, ?Env, ?Privileged, ?Tty, ?User)

Full Usage: ContainerParams.InitContainerExecStartParameters(?AttachStderr, ?AttachStdin, ?AttachStdout, ?Cmd, ?Detach, ?DetachKeys, ?Env, ?Privileged, ?Tty, ?User)

Parameters:
    ?AttachStderr : bool
    ?AttachStdin : bool
    ?AttachStdout : bool
    ?Cmd : string seq
    ?Detach : bool
    ?DetachKeys : string
    ?Env : string seq
    ?Privileged : bool
    ?Tty : bool
    ?User : string

Returns: ContainerExecStartParameters

Creates ContainerExecStartParameters

?AttachStderr : bool
?AttachStdin : bool
?AttachStdout : bool
?Cmd : string seq
?Detach : bool
?DetachKeys : string
?Env : string seq
?Privileged : bool
?Tty : bool
?User : string
Returns: ContainerExecStartParameters

ContainerParams.InitContainerListParameters(?WaitBeforeKillSeconds)

Full Usage: ContainerParams.InitContainerListParameters(?WaitBeforeKillSeconds)

Parameters:
    ?WaitBeforeKillSeconds : uint32

Returns: ContainerStopParameters

Creates ContainersListParameters for pre-filtering list function

?WaitBeforeKillSeconds : uint32
Returns: ContainerStopParameters

ContainerParams.InitContainerListParameters(?All, ?Before, ?Filters, ?Limit, ?Since, ?Size)

Full Usage: ContainerParams.InitContainerListParameters(?All, ?Before, ?Filters, ?Limit, ?Since, ?Size)

Parameters:
    ?All : bool
    ?Before : string
    ?Filters : 'a
    ?Limit : int64
    ?Since : string
    ?Size : bool

Returns: ContainersListParameters

Creates ContainersListParameters for pre-filtering list function

?All : bool
?Before : string
?Filters : 'a
?Limit : int64
?Since : string
?Size : bool
Returns: ContainersListParameters

ContainerParams.InitContainerLogsParameters(?Follow, ?ShowStderr, ?ShowStdout, ?Since, ?Tail, ?Timestamps)

Full Usage: ContainerParams.InitContainerLogsParameters(?Follow, ?ShowStderr, ?ShowStdout, ?Since, ?Tail, ?Timestamps)

Parameters:
    ?Follow : bool
    ?ShowStderr : bool
    ?ShowStdout : bool
    ?Since : string
    ?Tail : string
    ?Timestamps : bool

Returns: ContainerLogsParameters

Creates ContainerLogsParameters

?Follow : bool
?ShowStderr : bool
?ShowStdout : bool
?Since : string
?Tail : string
?Timestamps : bool
Returns: ContainerLogsParameters

ContainerParams.InitContainerPathStatParameters(?AllowOverwriteDirWithFile, ?Path)

Full Usage: ContainerParams.InitContainerPathStatParameters(?AllowOverwriteDirWithFile, ?Path)

Parameters:
    ?AllowOverwriteDirWithFile : bool
    ?Path : string

Returns: ContainerPathStatParameters

Creates ContainerPathStatParameters

?AllowOverwriteDirWithFile : bool
?Path : string
Returns: ContainerPathStatParameters

ContainerParams.InitContainerRemoveParameters(?Force, ?RemoveLinks, ?RemoveVolumes)

Full Usage: ContainerParams.InitContainerRemoveParameters(?Force, ?RemoveLinks, ?RemoveVolumes)

Parameters:
    ?Force : bool
    ?RemoveLinks : bool
    ?RemoveVolumes : bool

Returns: ContainerRemoveParameters

Creates ContainerRemoveParameters

?Force : bool
?RemoveLinks : bool
?RemoveVolumes : bool
Returns: ContainerRemoveParameters

ContainerParams.InitContainerStartParameters(?DetachKeys)

Full Usage: ContainerParams.InitContainerStartParameters(?DetachKeys)

Parameters:
    ?DetachKeys : string

Returns: ContainerStartParameters

Creates ContainerStartParameters

?DetachKeys : string
Returns: ContainerStartParameters

ContainerParams.InitCreateContainerParameters(?Hostname, ?HostConfig, ?Domainname, ?User, ?AttachStdin, ?AttachStdout, ?AttachStderr, ?ExposedPorts, ?Tty, ?OpenStdin, ?StdinOnce, ?Env, ?Cmd, ?Healthcheck, ?ArgsEscaped, ?Image, ?Volumes, ?WorkingDir, ?Entrypoint, ?NetworkDisabled, ?MacAddress, ?OnBuild, ?Labels, ?StopSignal, ?StopTimeout, ?Shell)

Full Usage: ContainerParams.InitCreateContainerParameters(?Hostname, ?HostConfig, ?Domainname, ?User, ?AttachStdin, ?AttachStdout, ?AttachStderr, ?ExposedPorts, ?Tty, ?OpenStdin, ?StdinOnce, ?Env, ?Cmd, ?Healthcheck, ?ArgsEscaped, ?Image, ?Volumes, ?WorkingDir, ?Entrypoint, ?NetworkDisabled, ?MacAddress, ?OnBuild, ?Labels, ?StopSignal, ?StopTimeout, ?Shell)

Parameters:
    ?Hostname : string
    ?HostConfig : 'a
    ?Domainname : string
    ?User : string
    ?AttachStdin : bool
    ?AttachStdout : bool
    ?AttachStderr : bool
    ?ExposedPorts : 'b
    ?Tty : bool
    ?OpenStdin : bool
    ?StdinOnce : bool
    ?Env : string seq
    ?Cmd : string seq
    ?Healthcheck : 'c
    ?ArgsEscaped : bool
    ?Image : string
    ?Volumes : 'd
    ?WorkingDir : string
    ?Entrypoint : string seq
    ?NetworkDisabled : bool
    ?MacAddress : string
    ?OnBuild : string seq
    ?Labels : 'e
    ?StopSignal : string
    ?StopTimeout : TimeSpan
    ?Shell : string seq

Returns: CreateContainerParameters

Creates CreateContainerParameters

?Hostname : string
?HostConfig : 'a
?Domainname : string
?User : string
?AttachStdin : bool
?AttachStdout : bool
?AttachStderr : bool
?ExposedPorts : 'b
?Tty : bool
?OpenStdin : bool
?StdinOnce : bool
?Env : string seq
?Cmd : string seq
?Healthcheck : 'c
?ArgsEscaped : bool
?Image : string
?Volumes : 'd
?WorkingDir : string
?Entrypoint : string seq
?NetworkDisabled : bool
?MacAddress : string
?OnBuild : string seq
?Labels : 'e
?StopSignal : string
?StopTimeout : TimeSpan
?Shell : string seq
Returns: CreateContainerParameters

ContainerParams.InitGetArchiveFromContainerParameters(?Path)

Full Usage: ContainerParams.InitGetArchiveFromContainerParameters(?Path)

Parameters:
    ?Path : string

Returns: GetArchiveFromContainerParameters

Creates ContainerPathStatParameters

?Path : string
Returns: GetArchiveFromContainerParameters

ContainerParams.InitHostConfig(?ContainerIDFile, ?LogConfig, ?NetworkMode, ?PortBindings, ?RestartPolicy, ?AutoRemove, ?VolumeDriver, ?VolumesFrom, ?CapAdd, ?CapDrop, ?DNS, ?DNSOptions, ?DNSSearch, ?ExtraHosts, ?GroupAdd, ?IpcMode, ?Cgroup, ?Links, ?OomScoreAdj, ?PidMode, ?Privileged, ?PublishAllPorts, ?ReadonlyRootfs, ?SecurityOpt, ?StorageOpt, ?Tmpfs, ?UTSMode, ?UsernsMode, ?ShmSize, ?Sysctls, ?Runtime, ?ConsoleSize, ?Isolation, ?CPUShares, ?Memory, ?NanoCPUs, ?CgroupParent, ?BlkioWeight, ?BlkioWeightDevice, ?BlkioDeviceReadBps, ?BlkioDeviceWriteBps, ?BlkioDeviceReadIOps, ?BlkioDeviceWriteIOps, ?CPUPeriod, ?CPUQuota, ?CPURealtimePeriod, ?CPURealtimeRuntime, ?CpusetCpus, ?CpusetMems, ?Devices, ?DiskQuota, ?KernelMemory, ?MemoryReservation, ?MemorySwap, ?MemorySwappiness, ?OomKillDisable, ?PidsLimit, ?Ulimits, ?CPUCount, ?CPUPercent, ?IOMaximumIOps, ?IOMaximumBandwidth, ?Mounts, ?Init, ?InitPath)

Full Usage: ContainerParams.InitHostConfig(?ContainerIDFile, ?LogConfig, ?NetworkMode, ?PortBindings, ?RestartPolicy, ?AutoRemove, ?VolumeDriver, ?VolumesFrom, ?CapAdd, ?CapDrop, ?DNS, ?DNSOptions, ?DNSSearch, ?ExtraHosts, ?GroupAdd, ?IpcMode, ?Cgroup, ?Links, ?OomScoreAdj, ?PidMode, ?Privileged, ?PublishAllPorts, ?ReadonlyRootfs, ?SecurityOpt, ?StorageOpt, ?Tmpfs, ?UTSMode, ?UsernsMode, ?ShmSize, ?Sysctls, ?Runtime, ?ConsoleSize, ?Isolation, ?CPUShares, ?Memory, ?NanoCPUs, ?CgroupParent, ?BlkioWeight, ?BlkioWeightDevice, ?BlkioDeviceReadBps, ?BlkioDeviceWriteBps, ?BlkioDeviceReadIOps, ?BlkioDeviceWriteIOps, ?CPUPeriod, ?CPUQuota, ?CPURealtimePeriod, ?CPURealtimeRuntime, ?CpusetCpus, ?CpusetMems, ?Devices, ?DiskQuota, ?KernelMemory, ?MemoryReservation, ?MemorySwap, ?MemorySwappiness, ?OomKillDisable, ?PidsLimit, ?Ulimits, ?CPUCount, ?CPUPercent, ?IOMaximumIOps, ?IOMaximumBandwidth, ?Mounts, ?Init, ?InitPath)

Parameters:
    ?ContainerIDFile : string
    ?LogConfig : 'a
    ?NetworkMode : string
    ?PortBindings : 'b
    ?RestartPolicy : 'c
    ?AutoRemove : bool
    ?VolumeDriver : string
    ?VolumesFrom : string seq
    ?CapAdd : 'd
    ?CapDrop : string seq
    ?DNS : string seq
    ?DNSOptions : string seq
    ?DNSSearch : string seq
    ?ExtraHosts : string seq
    ?GroupAdd : string seq
    ?IpcMode : string
    ?Cgroup : string
    ?Links : string seq
    ?OomScoreAdj : int64
    ?PidMode : string
    ?Privileged : bool
    ?PublishAllPorts : bool
    ?ReadonlyRootfs : bool
    ?SecurityOpt : string seq
    ?StorageOpt : 'e
    ?Tmpfs : 'f
    ?UTSMode : string
    ?UsernsMode : string
    ?ShmSize : int64
    ?Sysctls : 'g
    ?Runtime : string
    ?ConsoleSize : uint64[]
    ?Isolation : string
    ?CPUShares : int64
    ?Memory : int64
    ?NanoCPUs : int64
    ?CgroupParent : string
    ?BlkioWeight : uint16
    ?BlkioWeightDevice : WeightDevice seq
    ?BlkioDeviceReadBps : ThrottleDevice seq
    ?BlkioDeviceWriteBps : ThrottleDevice seq
    ?BlkioDeviceReadIOps : ThrottleDevice seq
    ?BlkioDeviceWriteIOps : ThrottleDevice seq
    ?CPUPeriod : int64
    ?CPUQuota : int64
    ?CPURealtimePeriod : int64
    ?CPURealtimeRuntime : int64
    ?CpusetCpus : string
    ?CpusetMems : string
    ?Devices : DeviceMapping seq
    ?DiskQuota : int64
    ?KernelMemory : int64
    ?MemoryReservation : int64
    ?MemorySwap : int64
    ?MemorySwappiness : int64
    ?OomKillDisable : bool
    ?PidsLimit : int64
    ?Ulimits : Ulimit seq
    ?CPUCount : int64
    ?CPUPercent : int64
    ?IOMaximumIOps : uint64
    ?IOMaximumBandwidth : uint64
    ?Mounts : Mount seq
    ?Init : bool
    ?InitPath : string

Returns: HostConfig

Creates HostConfig

?ContainerIDFile : string
?LogConfig : 'a
?NetworkMode : string
?PortBindings : 'b
?RestartPolicy : 'c
?AutoRemove : bool
?VolumeDriver : string
?VolumesFrom : string seq
?CapAdd : 'd
?CapDrop : string seq
?DNS : string seq
?DNSOptions : string seq
?DNSSearch : string seq
?ExtraHosts : string seq
?GroupAdd : string seq
?IpcMode : string
?Cgroup : string
?Links : string seq
?OomScoreAdj : int64
?PidMode : string
?Privileged : bool
?PublishAllPorts : bool
?ReadonlyRootfs : bool
?SecurityOpt : string seq
?StorageOpt : 'e
?Tmpfs : 'f
?UTSMode : string
?UsernsMode : string
?ShmSize : int64
?Sysctls : 'g
?Runtime : string
?ConsoleSize : uint64[]
?Isolation : string
?CPUShares : int64
?Memory : int64
?NanoCPUs : int64
?CgroupParent : string
?BlkioWeight : uint16
?BlkioWeightDevice : WeightDevice seq
?BlkioDeviceReadBps : ThrottleDevice seq
?BlkioDeviceWriteBps : ThrottleDevice seq
?BlkioDeviceReadIOps : ThrottleDevice seq
?BlkioDeviceWriteIOps : ThrottleDevice seq
?CPUPeriod : int64
?CPUQuota : int64
?CPURealtimePeriod : int64
?CPURealtimeRuntime : int64
?CpusetCpus : string
?CpusetMems : string
?Devices : DeviceMapping seq
?DiskQuota : int64
?KernelMemory : int64
?MemoryReservation : int64
?MemorySwap : int64
?MemorySwappiness : int64
?OomKillDisable : bool
?PidsLimit : int64
?Ulimits : Ulimit seq
?CPUCount : int64
?CPUPercent : int64
?IOMaximumIOps : uint64
?IOMaximumBandwidth : uint64
?Mounts : Mount seq
?Init : bool
?InitPath : string
Returns: HostConfig

ContainerParams.InitMount(?Type, ?Source, ?Target, ?ReadOnly, ?BindOptions, ?VolumeOptions, ?TmpfsOptions)

Full Usage: ContainerParams.InitMount(?Type, ?Source, ?Target, ?ReadOnly, ?BindOptions, ?VolumeOptions, ?TmpfsOptions)

Parameters:
    ?Type : string
    ?Source : string
    ?Target : string
    ?ReadOnly : bool
    ?BindOptions : 'a
    ?VolumeOptions : 'b
    ?TmpfsOptions : 'c

Returns: Mount

Creates Mount

?Type : string
?Source : string
?Target : string
?ReadOnly : bool
?BindOptions : 'a
?VolumeOptions : 'b
?TmpfsOptions : 'c
Returns: Mount

ContainerParams.InitTmpfsOptions(?Mode, ?SizeBytes)

Full Usage: ContainerParams.InitTmpfsOptions(?Mode, ?SizeBytes)

Parameters:
    ?Mode : uint32
    ?SizeBytes : int64

Returns: TmpfsOptions

Creates TmpfsOptions

?Mode : uint32
?SizeBytes : int64
Returns: TmpfsOptions

ContainerParams.InitVolumeOptions(?DriverConfig, ?Labels, ?NoCopy)

Full Usage: ContainerParams.InitVolumeOptions(?DriverConfig, ?Labels, ?NoCopy)

Parameters:
    ?DriverConfig : 'a
    ?Labels : 'b
    ?NoCopy : bool

Returns: VolumeOptions

Creates VolumeOptions

?DriverConfig : 'a
?Labels : 'b
?NoCopy : bool
Returns: VolumeOptions

Type something to start searching.