HostConfig.Builder (docker-client 6.1.1 API)

java.lang.Object
- com.spotify.docker.client.messages.HostConfig.Builder

Enclosing class:: HostConfig

public static class HostConfig.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
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.
`Boolean`	`autoRemove()`
`HostConfig.Builder`	`autoRemove(Boolean autoRemove)` Only works for Docker API version >= 1.25.
`List<String>`	`binds()`
`HostConfig.Builder`	`binds(HostConfig.Bind... binds)` Set the list of binds to the parameter, replacing any existing value.
`HostConfig.Builder`	`binds(List<String> binds)` Set the list of binds to the parameter, replacing any existing value.
`HostConfig.Builder`	`binds(String... binds)` Set the list of binds to the parameter, replacing any existing value.
`HostConfig`	`build()`
`List<String>`	`capAdd()`
`HostConfig.Builder`	`capAdd(List<String> capAdd)`
`HostConfig.Builder`	`capAdd(String... capAdd)`
`List<String>`	`capDrop()`
`HostConfig.Builder`	`capDrop(List<String> capDrop)`
`HostConfig.Builder`	`capDrop(String... capDrop)`
`String`	`cgroupParent()`
`HostConfig.Builder`	`cgroupParent(String cgroupParent)`
`String`	`containerIDFile()`
`HostConfig.Builder`	`containerIDFile(String containerIDFile)`
`HostConfig.Builder`	`containerPidMode(String container)` Set the PID (Process) Namespace mode for the container.
`Long`	`cpuQuota()`
`HostConfig.Builder`	`cpuQuota(Long cpuQuota)`
`String`	`cpusetCpus()`
`HostConfig.Builder`	`cpusetCpus(String cpusetCpus)`
`Long`	`cpuShares()`
`HostConfig.Builder`	`cpuShares(Long cpuShares)`
`List<Device>`	`devices()`
`HostConfig.Builder`	`devices(Device... devices)`
`HostConfig.Builder`	`devices(List<Device> devices)`
`List<String>`	`dns()`
`HostConfig.Builder`	`dns(List<String> dns)`
`HostConfig.Builder`	`dns(String... dns)`
`List<String>`	`dnsSearch()`
`HostConfig.Builder`	`dnsSearch(List<String> dnsSearch)`
`HostConfig.Builder`	`dnsSearch(String... dnsSearch)`
`List<String>`	`extraHosts()`
`HostConfig.Builder`	`extraHosts(List<String> extraHosts)`
`HostConfig.Builder`	`extraHosts(String... extraHosts)`
`HostConfig.Builder`	`hostPidMode()` Set the PID (Process) Namespace mode for the container.
`String`	`ipcMode()`
`HostConfig.Builder`	`ipcMode(String ipcMode)`
`List<String>`	`links()`
`HostConfig.Builder`	`links(List<String> links)`
`HostConfig.Builder`	`links(String... links)`
`LogConfig`	`logConfig()`
`HostConfig.Builder`	`logConfig(LogConfig logConfig)`
`List<HostConfig.LxcConfParameter>`	`lxcConf()`
`HostConfig.Builder`	`lxcConf(HostConfig.LxcConfParameter... lxcConf)`
`HostConfig.Builder`	`lxcConf(List<HostConfig.LxcConfParameter> lxcConf)`
`Long`	`memory()`
`HostConfig.Builder`	`memory(Long memory)`
`Long`	`memoryReservation()`
`HostConfig.Builder`	`memoryReservation(Long memoryReservation)`
`Long`	`memorySwap()`
`HostConfig.Builder`	`memorySwap(Long memorySwap)`
`String`	`networkMode()`
`HostConfig.Builder`	`networkMode(String networkMode)`
`Boolean`	`oomKillDisable()`
`HostConfig.Builder`	`oomKillDisable(Boolean oomKillDisable)`
`Integer`	`oomScoreAdj()`
`HostConfig.Builder`	`oomScoreAdj(Integer oomScoreAdj)`
`Integer`	`pidsLimit()`
`HostConfig.Builder`	`pidsLimit(Integer pidsLimit)`
`Map<String,List<PortBinding>>`	`portBindings()`
`HostConfig.Builder`	`portBindings(Map<String,List<PortBinding>> portBindings)`
`Boolean`	`privileged()`
`HostConfig.Builder`	`privileged(Boolean privileged)`
`Boolean`	`publishAllPorts()`
`HostConfig.Builder`	`publishAllPorts(Boolean publishAllPorts)`
`Boolean`	`readonlyRootfs()`
`HostConfig.Builder`	`readonlyRootfs(Boolean readonlyRootfs)`
`HostConfig.RestartPolicy`	`restartPolicy()`
`HostConfig.Builder`	`restartPolicy(HostConfig.RestartPolicy restartPolicy)`
`List<String>`	`securityOpt()`
`HostConfig.Builder`	`securityOpt(List<String> securityOpt)`
`HostConfig.Builder`	`securityOpt(String... securityOpt)`
`Long`	`shmSize()`
`HostConfig.Builder`	`shmSize(Long shmSize)`
`com.google.common.collect.ImmutableMap<String,String>`	`tmpfs()`
`HostConfig.Builder`	`tmpfs(com.google.common.collect.ImmutableMap<String,String> tmpfs)`
`HostConfig.Builder`	`ulimits(List<HostConfig.Ulimit> ulimits)`
`List<String>`	`volumesFrom()`
`HostConfig.Builder`	`volumesFrom(List<String> volumesFrom)`
`HostConfig.Builder`	`volumesFrom(String... volumesFrom)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

binds
```
public 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:

The builder

binds
```
public 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:

The 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:

The builder

appendBinds
```
public HostConfig.Builder appendBinds(Iterable<String> newBinds)
```
Append binds to the existing list in this builder.

Parameters:

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

Returns:

The 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:

The 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:

The builder

binds
```
public List<String> binds()
```

containerIDFile

public HostConfig.Builder containerIDFile(String containerIDFile)

containerIDFile
```
public String containerIDFile()
```

lxcConf

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

lxcConf

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

lxcConf

public List<HostConfig.LxcConfParameter> lxcConf()

privileged

public HostConfig.Builder privileged(Boolean privileged)

privileged
```
public Boolean privileged()
```

portBindings

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

portBindings

public Map<String,List<PortBinding>> portBindings()

links

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

links

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

links
```
public List<String> links()
```

publishAllPorts

public HostConfig.Builder publishAllPorts(Boolean publishAllPorts)

publishAllPorts
```
public Boolean publishAllPorts()
```

dns

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

dns

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

dns
```
public List<String> dns()
```

dnsSearch

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

dnsSearch

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

dnsSearch
```
public List<String> dnsSearch()
```

extraHosts

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

extraHosts

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

extraHosts
```
public List<String> extraHosts()
```

volumesFrom

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

volumesFrom

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

volumesFrom
```
public List<String> volumesFrom()
```

capAdd

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

capAdd

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

capAdd
```
public List<String> capAdd()
```

capDrop

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

capDrop

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

capDrop
```
public List<String> capDrop()
```

networkMode

public HostConfig.Builder networkMode(String networkMode)

networkMode
```
public String networkMode()
```

securityOpt

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

securityOpt

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

securityOpt
```
public List<String> securityOpt()
```

devices

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

devices

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

devices
```
public List<Device> devices()
```

memory

public HostConfig.Builder memory(Long memory)

memory
```
public Long memory()
```

memorySwap

public HostConfig.Builder memorySwap(Long memorySwap)

memorySwap
```
public Long memorySwap()
```

memoryReservation

public HostConfig.Builder memoryReservation(Long memoryReservation)

memoryReservation
```
public Long memoryReservation()
```

cpuShares

public HostConfig.Builder cpuShares(Long cpuShares)

cpuShares
```
public Long cpuShares()
```

cpusetCpus

public HostConfig.Builder cpusetCpus(String cpusetCpus)

cpusetCpus
```
public String cpusetCpus()
```

cpuQuota

public HostConfig.Builder cpuQuota(Long cpuQuota)

cpuQuota
```
public Long cpuQuota()
```

cgroupParent

public HostConfig.Builder cgroupParent(String cgroupParent)

cgroupParent
```
public String cgroupParent()
```

restartPolicy

public HostConfig.Builder restartPolicy(HostConfig.RestartPolicy restartPolicy)

logConfig

public HostConfig.Builder logConfig(LogConfig logConfig)

restartPolicy

public HostConfig.RestartPolicy restartPolicy()

logConfig
```
public LogConfig logConfig()
```

ipcMode

public HostConfig.Builder ipcMode(String ipcMode)

ipcMode
```
public String ipcMode()
```

ulimits

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

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:

Builder

shmSize

public HostConfig.Builder shmSize(Long shmSize)

shmSize
```
public Long shmSize()
```

oomKillDisable

public HostConfig.Builder oomKillDisable(Boolean oomKillDisable)

oomKillDisable
```
public Boolean oomKillDisable()
```

oomScoreAdj

public HostConfig.Builder oomScoreAdj(Integer oomScoreAdj)

oomScoreAdj
```
public Integer oomScoreAdj()
```

autoRemove
```
public Boolean autoRemove()
```

autoRemove

public HostConfig.Builder autoRemove(Boolean autoRemove)

Only works for Docker API version >= 1.25.

pidsLimit

public HostConfig.Builder pidsLimit(Integer pidsLimit)

pidsLimit
```
public Integer pidsLimit()
```

readonlyRootfs

public HostConfig.Builder readonlyRootfs(Boolean readonlyRootfs)

tmpfs

public HostConfig.Builder tmpfs(com.google.common.collect.ImmutableMap<String,String> tmpfs)

tmpfs

public com.google.common.collect.ImmutableMap<String,String> tmpfs()

readonlyRootfs
```
public Boolean readonlyRootfs()
```

build
```
public HostConfig build()
```

Class HostConfig.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

binds

binds

binds

appendBinds

appendBinds

appendBinds

binds

containerIDFile

containerIDFile

lxcConf

lxcConf

lxcConf

privileged

privileged

portBindings

portBindings

links

links

links

publishAllPorts

publishAllPorts

dns

dns

dns

dnsSearch

dnsSearch

dnsSearch

extraHosts

extraHosts

extraHosts

volumesFrom

volumesFrom

volumesFrom

capAdd

capAdd

capAdd

capDrop

capDrop

capDrop

networkMode

networkMode

securityOpt

securityOpt

securityOpt

devices

devices

devices

memory

memory

memorySwap

memorySwap

memoryReservation

memoryReservation

cpuShares

cpuShares

cpusetCpus

cpusetCpus

cpuQuota

cpuQuota

cgroupParent

cgroupParent

restartPolicy

logConfig

restartPolicy

logConfig

ipcMode

ipcMode

ulimits

containerPidMode

hostPidMode

shmSize

shmSize

oomKillDisable

oomKillDisable

oomScoreAdj

oomScoreAdj