Package org.mandas.docker.client.messages

Interface HostConfig.Builder

Enclosing interface:

HostConfig

public static interface HostConfig.Builder

Method Summary

Modifier and Type	Method	Description
HostConfig.Builder	addSysctl(String key, String value)
HostConfig.Builder	autoRemove(Boolean autoRemove)	Only works for Docker API version >= 1.25.
HostConfig.Builder	binds(Iterable<String> binds)
HostConfig.Builder	binds(String... binds)
default HostConfig.Builder	binds(HostConfig.Bind... binds)
HostConfig.Builder	blkioDeviceReadBps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceReadBps)
HostConfig.Builder	blkioDeviceReadIOps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceReadIOps)
HostConfig.Builder	blkioDeviceWriteBps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceWriteBps)
HostConfig.Builder	blkioDeviceWriteIOps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceWriteIOps)
HostConfig.Builder	blkioWeight(Integer blkioWeight)
HostConfig.Builder	blkioWeightDevice(Iterable<? extends HostConfig.BlkioWeightDevice> blkioWeightDevice)
HostConfig	build()
HostConfig.Builder	capAdd(Iterable<String> capAdd)
HostConfig.Builder	capAdd(String... capAdd)
HostConfig.Builder	capDrop(Iterable<String> capDrop)
HostConfig.Builder	capDrop(String... capDrop)
HostConfig.Builder	cgroupParent(String cgroupParent)
HostConfig.Builder	containerIdFile(String containerIdFile)
default HostConfig.Builder	containerPidMode(String container)	Set the PID (Process) Namespace mode for the container.
HostConfig.Builder	cpuPeriod(Long cpuPeriod)
HostConfig.Builder	cpuQuota(Long cpuQuota)
HostConfig.Builder	cpusetCpus(String cpusetCpus)
HostConfig.Builder	cpusetMems(String cpusetMems)
HostConfig.Builder	cpuShares(Long cpuShares)
HostConfig.Builder	deviceRequests(Iterable<? extends HostConfig.DeviceRequest> deviceRequests)
HostConfig.Builder	devices(Iterable<? extends Device> devices)
HostConfig.Builder	devices(Device... devices)
HostConfig.Builder	dns(Iterable<String> dns)
HostConfig.Builder	dns(String... dns)
HostConfig.Builder	dnsOptions(Iterable<String> dnsOptions)
HostConfig.Builder	dnsOptions(String... dnsOptions)
HostConfig.Builder	dnsSearch(Iterable<String> dnsSearch)
HostConfig.Builder	dnsSearch(String... dnsSearch)
HostConfig.Builder	extraHosts(Iterable<String> extraHosts)
HostConfig.Builder	extraHosts(String... extraHosts)
HostConfig.Builder	groupAdd(Iterable<String> groupAdd)
HostConfig.Builder	groupAdd(String... groupAdd)
default HostConfig.Builder	hostPidMode()	Set the PID (Process) Namespace mode for the container.
HostConfig.Builder	init(Boolean init)
HostConfig.Builder	ipcMode(String ipcMode)
HostConfig.Builder	kernelMemory(Long kernelMemory)	Deprecated.
HostConfig.Builder	links(Iterable<String> links)
HostConfig.Builder	links(String... links)
HostConfig.Builder	logConfig(LogConfig logConfig)
HostConfig.Builder	lxcConf(Iterable<? extends HostConfig.LxcConfParameter> lxcConf)
HostConfig.Builder	lxcConf(HostConfig.LxcConfParameter... lxcConf)
HostConfig.Builder	memory(Long memory)
HostConfig.Builder	memoryReservation(Long memoryReservation)
HostConfig.Builder	memorySwap(Long memorySwap)
HostConfig.Builder	memorySwappiness(Integer memorySwappiness)
HostConfig.Builder	mounts(Iterable<? extends Mount> mounts)
HostConfig.Builder	mounts(Mount... mounts)
HostConfig.Builder	nanoCpus(Long nanoCpus)
HostConfig.Builder	networkMode(String networkMode)
HostConfig.Builder	oomKillDisable(Boolean oomKillDisable)
HostConfig.Builder	oomScoreAdj(Integer oomScoreAdj)
HostConfig.Builder	pidMode(String pidMode)
HostConfig.Builder	pidsLimit(Integer pidsLimit)
HostConfig.Builder	portBindings(Map<String,? extends List<PortBinding>> portBindings)
HostConfig.Builder	privileged(Boolean privileged)
HostConfig.Builder	publishAllPorts(Boolean publishAllPorts)
HostConfig.Builder	readonlyRootfs(Boolean readonlyRootfs)
HostConfig.Builder	restartPolicy(HostConfig.RestartPolicy restartPolicy)
HostConfig.Builder	runtime(String runtime)
HostConfig.Builder	securityOpt(Iterable<String> securityOpt)
HostConfig.Builder	securityOpt(String... securityOpt)
HostConfig.Builder	shmSize(Long shmSize)
HostConfig.Builder	storageOpt(Map<String,? extends String> tmpfs)
HostConfig.Builder	sysctls(Map<String,? extends String> sysctls)
HostConfig.Builder	tmpfs(Map<String,? extends String> tmpfs)
HostConfig.Builder	ulimits(Iterable<? extends HostConfig.Ulimit> ulimits)
HostConfig.Builder	volumesFrom(Iterable<String> volumesFrom)
HostConfig.Builder	volumesFrom(String... volumesFrom)

Method Details

binds

HostConfig.Builder binds(Iterable<String> binds)

binds

HostConfig.Builder binds(String... binds)

binds

default HostConfig.Builder binds(HostConfig.Bind... binds)

blkioWeight

HostConfig.Builder blkioWeight(Integer blkioWeight)

blkioWeightDevice

HostConfig.Builder blkioWeightDevice(Iterable<? extends HostConfig.BlkioWeightDevice> blkioWeightDevice)

blkioDeviceReadBps

HostConfig.Builder blkioDeviceReadBps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceReadBps)

blkioDeviceWriteBps

HostConfig.Builder blkioDeviceWriteBps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceWriteBps)

blkioDeviceReadIOps

HostConfig.Builder blkioDeviceReadIOps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceReadIOps)

blkioDeviceWriteIOps

HostConfig.Builder blkioDeviceWriteIOps(Iterable<? extends HostConfig.BlkioDeviceRate> blkioDeviceWriteIOps)

containerIdFile

HostConfig.Builder containerIdFile(String containerIdFile)

lxcConf

HostConfig.Builder lxcConf(Iterable<? extends HostConfig.LxcConfParameter> lxcConf)

lxcConf

HostConfig.Builder lxcConf(HostConfig.LxcConfParameter... lxcConf)

privileged

HostConfig.Builder privileged(Boolean privileged)

portBindings

HostConfig.Builder portBindings(Map<String,? extends List<PortBinding>> portBindings)

links

HostConfig.Builder links(Iterable<String> links)

links

HostConfig.Builder links(String... links)

publishAllPorts

HostConfig.Builder publishAllPorts(Boolean publishAllPorts)

dns

HostConfig.Builder dns(Iterable<String> dns)

dns

HostConfig.Builder dns(String... dns)

dnsOptions

HostConfig.Builder dnsOptions(Iterable<String> dnsOptions)

dnsOptions

HostConfig.Builder dnsOptions(String... dnsOptions)

dnsSearch

HostConfig.Builder dnsSearch(Iterable<String> dnsSearch)

dnsSearch

HostConfig.Builder dnsSearch(String... dnsSearch)

extraHosts

HostConfig.Builder extraHosts(Iterable<String> extraHosts)

extraHosts

HostConfig.Builder extraHosts(String... extraHosts)

groupAdd

HostConfig.Builder groupAdd(Iterable<String> groupAdd)

groupAdd

HostConfig.Builder groupAdd(String... groupAdd)

volumesFrom

HostConfig.Builder volumesFrom(Iterable<String> volumesFrom)

volumesFrom

HostConfig.Builder volumesFrom(String... volumesFrom)

capAdd

HostConfig.Builder capAdd(Iterable<String> capAdd)

capAdd

HostConfig.Builder capAdd(String... capAdd)

capDrop

HostConfig.Builder capDrop(Iterable<String> capDrop)

capDrop

HostConfig.Builder capDrop(String... capDrop)

networkMode

HostConfig.Builder networkMode(String networkMode)

securityOpt

HostConfig.Builder securityOpt(Iterable<String> securityOpt)

securityOpt

HostConfig.Builder securityOpt(String... securityOpt)

devices

HostConfig.Builder devices(Iterable<? extends Device> devices)

devices

HostConfig.Builder devices(Device... devices)

memory

HostConfig.Builder memory(Long memory)

memorySwap

HostConfig.Builder memorySwap(Long memorySwap)

memorySwappiness

HostConfig.Builder memorySwappiness(Integer memorySwappiness)

kernelMemory

@Deprecated
HostConfig.Builder kernelMemory(Long kernelMemory)

Deprecated.

memoryReservation

HostConfig.Builder memoryReservation(Long memoryReservation)

nanoCpus

HostConfig.Builder nanoCpus(Long nanoCpus)

cpuPeriod

HostConfig.Builder cpuPeriod(Long cpuPeriod)

cpuShares

HostConfig.Builder cpuShares(Long cpuShares)

cpusetCpus

HostConfig.Builder cpusetCpus(String cpusetCpus)

cpusetMems

HostConfig.Builder cpusetMems(String cpusetMems)

cpuQuota

HostConfig.Builder cpuQuota(Long cpuQuota)

cgroupParent

HostConfig.Builder cgroupParent(String cgroupParent)

restartPolicy

HostConfig.Builder restartPolicy(HostConfig.RestartPolicy restartPolicy)

logConfig

HostConfig.Builder logConfig(LogConfig logConfig)

ipcMode

HostConfig.Builder ipcMode(String ipcMode)

ulimits

HostConfig.Builder ulimits(Iterable<? extends HostConfig.Ulimit> ulimits)

pidMode

HostConfig.Builder pidMode(String pidMode)

containerPidMode

default HostConfig.Builder containerPidMode(String container)

Set the PID (Process) Namespace mode for the container. Use this method to join another container's PID namespace. To use the host PID namespace, use hostPidMode().

Parameters:

container - Join the namespace of this container (Name or ID)

Returns:

Builder

hostPidMode

default HostConfig.Builder hostPidMode()

Set the PID (Process) Namespace mode for the container. Use this method to use the host's PID namespace. To use another container's PID namespace, use containerPidMode(String).

Returns:

HostConfig.Builder

shmSize

HostConfig.Builder shmSize(Long shmSize)

oomKillDisable

HostConfig.Builder oomKillDisable(Boolean oomKillDisable)

oomScoreAdj

HostConfig.Builder oomScoreAdj(Integer oomScoreAdj)

autoRemove

HostConfig.Builder autoRemove(Boolean autoRemove)

Only works for Docker API version >= 1.25.

Parameters:

autoRemove - Whether to automatically remove the container when it exits

Returns:

HostConfig.Builder

pidsLimit

HostConfig.Builder pidsLimit(Integer pidsLimit)

tmpfs

HostConfig.Builder tmpfs(Map<String,? extends String> tmpfs)

readonlyRootfs

HostConfig.Builder readonlyRootfs(Boolean readonlyRootfs)

storageOpt

HostConfig.Builder storageOpt(Map<String,? extends String> tmpfs)

runtime

HostConfig.Builder runtime(String runtime)

mounts

HostConfig.Builder mounts(Iterable<? extends Mount> mounts)

mounts

HostConfig.Builder mounts(Mount... mounts)

init

HostConfig.Builder init(Boolean init)

sysctls

HostConfig.Builder sysctls(Map<String,? extends String> sysctls)

addSysctl

HostConfig.Builder addSysctl(String key,
 String value)

deviceRequests

HostConfig.Builder deviceRequests(Iterable<? extends HostConfig.DeviceRequest> deviceRequests)

build

HostConfig build()