com.spotify.docker.client.messages

Class HostConfig.Builder

java.lang.Object

com.spotify.docker.client.messages.HostConfig.Builder

Enclosing class:

HostConfig

public abstract static class HostConfig.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
HostConfig.Builder	appendBinds(HostConfig.Bind... binds) Append binds to the existing list in this builder.
HostConfig.Builder	appendBinds(Iterable<String> newBinds) Append binds to the existing list in this builder.
HostConfig.Builder	appendBinds(String... binds) Append binds to the existing list in this builder.
abstract HostConfig.Builder	autoRemove(Boolean autoRemove) Only works for Docker API version >= 1.25.
HostConfig.Builder	binds(HostConfig.Bind... binds) Set the list of binds to the parameter, replacing any existing value.
abstract HostConfig.Builder	binds(List<String> binds) Set the list of binds to the parameter, replacing any existing value.
abstract HostConfig.Builder	binds(String... binds) Set the list of binds to the parameter, replacing any existing value.
abstract HostConfig.Builder	blkioDeviceReadBps(List<HostConfig.BlkioDeviceRate> blkioDeviceReadBps)
abstract HostConfig.Builder	blkioDeviceReadIOps(List<HostConfig.BlkioDeviceRate> blkioDeviceReadIOps)
abstract HostConfig.Builder	blkioDeviceWriteBps(List<HostConfig.BlkioDeviceRate> blkioDeviceWriteBps)
abstract HostConfig.Builder	blkioDeviceWriteIOps(List<HostConfig.BlkioDeviceRate> blkioDeviceWriteIOps)
abstract HostConfig.Builder	blkioWeight(Integer blkioWeight)
abstract HostConfig.Builder	blkioWeightDevice(List<HostConfig.BlkioWeightDevice> blkioWeightDevice)
HostConfig	build()
abstract HostConfig.Builder	capAdd(List<String> capAdd)
abstract HostConfig.Builder	capAdd(String... capAdd)
abstract HostConfig.Builder	capDrop(List<String> capDrop)
abstract HostConfig.Builder	capDrop(String... capDrop)
abstract HostConfig.Builder	cgroupParent(String cgroupParent)
abstract HostConfig.Builder	containerIdFile(String containerIdFile)
HostConfig.Builder	containerPidMode(String container) Set the PID (Process) Namespace mode for the container.
abstract HostConfig.Builder	cpuPeriod(Long cpuPeriod)
abstract HostConfig.Builder	cpuQuota(Long cpuQuota)
abstract HostConfig.Builder	cpusetCpus(String cpusetCpus)
abstract HostConfig.Builder	cpusetMems(String cpusetMems)
abstract HostConfig.Builder	cpuShares(Long cpuShares)
abstract HostConfig.Builder	devices(Device... devices)
abstract HostConfig.Builder	devices(List<Device> devices)
abstract HostConfig.Builder	dns(List<String> dns)
abstract HostConfig.Builder	dns(String... dns)
abstract HostConfig.Builder	dnsOptions(List<String> dnsOptions)
abstract HostConfig.Builder	dnsOptions(String... dnsOptions)
abstract HostConfig.Builder	dnsSearch(List<String> dnsSearch)
abstract HostConfig.Builder	dnsSearch(String... dnsSearch)
abstract HostConfig.Builder	extraHosts(List<String> extraHosts)
abstract HostConfig.Builder	extraHosts(String... extraHosts)
abstract HostConfig.Builder	groupAdd(List<String> groupAdd)
abstract HostConfig.Builder	groupAdd(String... groupAdd)
HostConfig.Builder	hostPidMode() Set the PID (Process) Namespace mode for the container.
abstract HostConfig.Builder	ipcMode(String ipcMode)
abstract HostConfig.Builder	kernelMemory(Long kernelMemory)
abstract HostConfig.Builder	links(List<String> links)
abstract HostConfig.Builder	links(String... links)
abstract HostConfig.Builder	logConfig(LogConfig logConfig)
abstract HostConfig.Builder	lxcConf(HostConfig.LxcConfParameter... lxcConf)
abstract HostConfig.Builder	lxcConf(List<HostConfig.LxcConfParameter> lxcConf)
abstract HostConfig.Builder	memory(Long memory)
abstract HostConfig.Builder	memoryReservation(Long memoryReservation)
abstract HostConfig.Builder	memorySwap(Long memorySwap)
abstract HostConfig.Builder	memorySwappiness(Integer memorySwappiness)
abstract HostConfig.Builder	nanoCpus(Long nanoCpus)
abstract HostConfig.Builder	networkMode(String networkMode)
abstract HostConfig.Builder	oomKillDisable(Boolean oomKillDisable)
abstract HostConfig.Builder	oomScoreAdj(Integer oomScoreAdj)
abstract HostConfig.Builder	pidMode(String pidMode)
abstract HostConfig.Builder	pidsLimit(Integer pidsLimit)
abstract HostConfig.Builder	portBindings(Map<String,List<PortBinding>> portBindings)
abstract HostConfig.Builder	privileged(Boolean privileged)
abstract HostConfig.Builder	publishAllPorts(Boolean publishAllPorts)
abstract HostConfig.Builder	readonlyRootfs(Boolean readonlyRootfs)
abstract HostConfig.Builder	restartPolicy(HostConfig.RestartPolicy restartPolicy)
abstract HostConfig.Builder	runtime(String runtime)
abstract HostConfig.Builder	securityOpt(List<String> securityOpt)
abstract HostConfig.Builder	securityOpt(String... securityOpt)
abstract HostConfig.Builder	shmSize(Long shmSize)
abstract HostConfig.Builder	storageOpt(Map<String,String> tmpfs)
abstract HostConfig.Builder	tmpfs(Map<String,String> tmpfs)
abstract HostConfig.Builder	ulimits(List<HostConfig.Ulimit> ulimits)
abstract HostConfig.Builder	volumesFrom(List<String> volumesFrom)
abstract HostConfig.Builder	volumesFrom(String... volumesFrom)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

binds

public abstract HostConfig.Builder binds(List<String> binds)

Set the list of binds to the parameter, replacing any existing value.

To append to the list instead, use one of the appendBinds() methods.

Parameters:

binds - A list of volume bindings for this container. Each volume binding is a string.

Returns:

HostConfig.Builder

binds

public abstract HostConfig.Builder binds(String... binds)

Set the list of binds to the parameter, replacing any existing value.

To append to the list instead, use one of the appendBinds() methods.

Parameters:

binds - An array of volume bindings for this container. Each volume binding is a string.

Returns:

HostConfig.Builder

binds

public HostConfig.Builder binds(HostConfig.Bind... binds)

Set the list of binds to the parameter, replacing any existing value.

To append to the list instead, use one of the appendBinds() methods.

Parameters:

binds - An array of volume bindings for this container. Each volume binding is a HostConfig.Bind object.

Returns:

HostConfig.Builder

appendBinds

public HostConfig.Builder appendBinds(Iterable<String> newBinds)

Append binds to the existing list in this builder. Duplicates are discarded.

Parameters:

newBinds - An iterable of volume bindings for this container. Each volume binding is a String.

Returns:

HostConfig.Builder

appendBinds

public HostConfig.Builder appendBinds(HostConfig.Bind... binds)

Append binds to the existing list in this builder.

Parameters:

binds - An array of volume bindings for this container. Each volume binding is a HostConfig.Bind object.

Returns:

HostConfig.Builder

appendBinds

public HostConfig.Builder appendBinds(String... binds)

Append binds to the existing list in this builder.

Parameters:

binds - An array of volume bindings for this container. Each volume binding is a String.

Returns:

HostConfig.Builder

blkioWeight

public abstract HostConfig.Builder blkioWeight(Integer blkioWeight)

blkioWeightDevice

public abstract HostConfig.Builder blkioWeightDevice(List<HostConfig.BlkioWeightDevice> blkioWeightDevice)

blkioDeviceReadBps

public abstract HostConfig.Builder blkioDeviceReadBps(List<HostConfig.BlkioDeviceRate> blkioDeviceReadBps)

blkioDeviceWriteBps

public abstract HostConfig.Builder blkioDeviceWriteBps(List<HostConfig.BlkioDeviceRate> blkioDeviceWriteBps)

blkioDeviceReadIOps

public abstract HostConfig.Builder blkioDeviceReadIOps(List<HostConfig.BlkioDeviceRate> blkioDeviceReadIOps)

blkioDeviceWriteIOps

public abstract HostConfig.Builder blkioDeviceWriteIOps(List<HostConfig.BlkioDeviceRate> blkioDeviceWriteIOps)

containerIdFile

public abstract HostConfig.Builder containerIdFile(String containerIdFile)

lxcConf

public abstract HostConfig.Builder lxcConf(List<HostConfig.LxcConfParameter> lxcConf)

lxcConf

public abstract HostConfig.Builder lxcConf(HostConfig.LxcConfParameter... lxcConf)

privileged

public abstract HostConfig.Builder privileged(Boolean privileged)

portBindings

public abstract HostConfig.Builder portBindings(Map<String,List<PortBinding>> portBindings)

links

public abstract HostConfig.Builder links(List<String> links)

links

public abstract HostConfig.Builder links(String... links)

publishAllPorts

public abstract HostConfig.Builder publishAllPorts(Boolean publishAllPorts)

dns

public abstract HostConfig.Builder dns(List<String> dns)

dns

public abstract HostConfig.Builder dns(String... dns)

dnsOptions

public abstract HostConfig.Builder dnsOptions(List<String> dnsOptions)

dnsOptions

public abstract HostConfig.Builder dnsOptions(String... dnsOptions)

dnsSearch

public abstract HostConfig.Builder dnsSearch(List<String> dnsSearch)

dnsSearch

public abstract HostConfig.Builder dnsSearch(String... dnsSearch)

extraHosts

public abstract HostConfig.Builder extraHosts(List<String> extraHosts)

extraHosts

public abstract HostConfig.Builder extraHosts(String... extraHosts)

groupAdd

public abstract HostConfig.Builder groupAdd(List<String> groupAdd)

groupAdd

public abstract HostConfig.Builder groupAdd(String... groupAdd)

volumesFrom

public abstract HostConfig.Builder volumesFrom(List<String> volumesFrom)

volumesFrom

public abstract HostConfig.Builder volumesFrom(String... volumesFrom)

capAdd

public abstract HostConfig.Builder capAdd(List<String> capAdd)

capAdd

public abstract HostConfig.Builder capAdd(String... capAdd)

capDrop

public abstract HostConfig.Builder capDrop(List<String> capDrop)

capDrop

public abstract HostConfig.Builder capDrop(String... capDrop)

networkMode

public abstract HostConfig.Builder networkMode(String networkMode)

securityOpt

public abstract HostConfig.Builder securityOpt(List<String> securityOpt)

securityOpt

public abstract HostConfig.Builder securityOpt(String... securityOpt)

devices

public abstract HostConfig.Builder devices(List<Device> devices)

devices

public abstract HostConfig.Builder devices(Device... devices)

memory

public abstract HostConfig.Builder memory(Long memory)

memorySwap

public abstract HostConfig.Builder memorySwap(Long memorySwap)

memorySwappiness

public abstract HostConfig.Builder memorySwappiness(Integer memorySwappiness)

kernelMemory

public abstract HostConfig.Builder kernelMemory(Long kernelMemory)

memoryReservation

public abstract HostConfig.Builder memoryReservation(Long memoryReservation)

nanoCpus

public abstract HostConfig.Builder nanoCpus(Long nanoCpus)

cpuPeriod

public abstract HostConfig.Builder cpuPeriod(Long cpuPeriod)

cpuShares

public abstract HostConfig.Builder cpuShares(Long cpuShares)

cpusetCpus

public abstract HostConfig.Builder cpusetCpus(String cpusetCpus)

cpusetMems

public abstract HostConfig.Builder cpusetMems(String cpusetMems)

cpuQuota

public abstract HostConfig.Builder cpuQuota(Long cpuQuota)

cgroupParent

public abstract HostConfig.Builder cgroupParent(String cgroupParent)

restartPolicy

public abstract HostConfig.Builder restartPolicy(HostConfig.RestartPolicy restartPolicy)

logConfig

public abstract HostConfig.Builder logConfig(LogConfig logConfig)

ipcMode

public abstract HostConfig.Builder ipcMode(String ipcMode)

ulimits

public abstract HostConfig.Builder ulimits(List<HostConfig.Ulimit> ulimits)

pidMode

public abstract HostConfig.Builder pidMode(String pidMode)

containerPidMode

public 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

public 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

public abstract HostConfig.Builder shmSize(Long shmSize)

oomKillDisable

public abstract HostConfig.Builder oomKillDisable(Boolean oomKillDisable)

oomScoreAdj

public abstract HostConfig.Builder oomScoreAdj(Integer oomScoreAdj)

autoRemove

public abstract 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

public abstract HostConfig.Builder pidsLimit(Integer pidsLimit)

tmpfs

public abstract HostConfig.Builder tmpfs(Map<String,String> tmpfs)

readonlyRootfs

public abstract HostConfig.Builder readonlyRootfs(Boolean readonlyRootfs)

storageOpt

public abstract HostConfig.Builder storageOpt(Map<String,String> tmpfs)

runtime

public abstract HostConfig.Builder runtime(String runtime)

build

public HostConfig build()