com.github.dockerjava.api.model

Class HostConfig

java.lang.Object

com.github.dockerjava.api.model.DockerObject

com.github.dockerjava.api.model.HostConfig

All Implemented Interfaces:

Serializable

public class HostConfig
extends DockerObject
implements Serializable

Used in `/containers/create`, and in inspect container. TODO exclude usage for 2 different models.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HostConfig()

Method Summary

Modifier and Type	Method and Description
Boolean	getAutoRemove()
Bind[]	getBinds()
List<BlkioRateDevice>	getBlkioDeviceReadBps()
List<BlkioRateDevice>	getBlkioDeviceReadIOps()
List<BlkioRateDevice>	getBlkioDeviceWriteBps()
List<BlkioRateDevice>	getBlkioDeviceWriteIOps()
Integer	getBlkioWeight()
List<BlkioWeightDevice>	getBlkioWeightDevice()
Capability[]	getCapAdd()
Capability[]	getCapDrop()
String	getCgroup()
String	getCgroupnsMode()
String	getCgroupParent()
List<Integer>	getConsoleSize()
String	getContainerIDFile()
Long	getCpuCount()
Long	getCpuPercent()
Long	getCpuPeriod()
Long	getCpuQuota()
Long	getCpuRealtimePeriod()
Long	getCpuRealtimeRuntime()
String	getCpusetCpus()
String	getCpusetMems()
Integer	getCpuShares()
List<String>	getDeviceCgroupRules()
List<DeviceRequest>	getDeviceRequests()
Device[]	getDevices()
Long	getDiskQuota()
String[]	getDns()
List<String>	getDnsOptions()
String[]	getDnsSearch()
String[]	getExtraHosts()
List<String>	getGroupAdd()
Boolean	getInit()
Long	getIoMaximumBandwidth()
Long	getIoMaximumIOps()
String	getIpcMode()
Isolation	getIsolation()
Long	getKernelMemory()
Link[]	getLinks()
LogConfig	getLogConfig()
LxcConf[]	getLxcConf()
Long	getMemory()
Long	getMemoryReservation()
Long	getMemorySwap()
Long	getMemorySwappiness()
List<Mount>	getMounts()
Long	getNanoCPUs()
String	getNetworkMode()
Boolean	getOomKillDisable()
Integer	getOomScoreAdj()
String	getPidMode()
Long	getPidsLimit()
Ports	getPortBindings()
Boolean	getPrivileged()
Boolean	getPublishAllPorts()
Boolean	getReadonlyRootfs()
RestartPolicy	getRestartPolicy()
String	getRuntime()
List<String>	getSecurityOpts()
Long	getShmSize()
Map<String,String>	getStorageOpt()
Map<String,String>	getSysctls()
Map<String,String>	getTmpFs()
Ulimit[]	getUlimits()
String	getUsernsMode()
String	getUtSMode()
String	getVolumeDriver()
VolumesFrom[]	getVolumesFrom()
boolean	isUserDefinedNetwork() Parse the network mode as specified at https://github.com/docker/engine-api/blob/master/types/container/hostconfig_unix.go
static HostConfig	newHostConfig()
void	setBinds(Bind... binds)
void	setLinks(Link... links)
HostConfig	withAutoRemove(Boolean autoRemove)
HostConfig	withBinds(Bind... binds)
HostConfig	withBinds(Binds binds)
HostConfig	withBinds(List<Bind> binds)
HostConfig	withBlkioDeviceReadBps(List<BlkioRateDevice> blkioDeviceReadBps)
HostConfig	withBlkioDeviceReadIOps(List<BlkioRateDevice> blkioDeviceReadIOps)
HostConfig	withBlkioDeviceWriteBps(List<BlkioRateDevice> blkioDeviceWriteBps)
HostConfig	withBlkioDeviceWriteIOps(List<BlkioRateDevice> blkioDeviceWriteIOps)
HostConfig	withBlkioWeight(Integer blkioWeight)
HostConfig	withBlkioWeightDevice(List<BlkioWeightDevice> blkioWeightDevice)
HostConfig	withCapAdd(Capability... capAdd)
HostConfig	withCapDrop(Capability... capDrop)
HostConfig	withCgroup(String cgroup)
HostConfig	withCgroupnsMode(String cgroupnsMode)
HostConfig	withCgroupParent(String cgroupParent)
HostConfig	withConsoleSize(List<Integer> consoleSize)
HostConfig	withContainerIDFile(String containerIDFile)
HostConfig	withCpuCount(Long cpuCount)
HostConfig	withCpuPercent(Long cpuPercent)
HostConfig	withCpuPeriod(Long cpuPeriod)
HostConfig	withCpuQuota(Long cpuQuota)
HostConfig	withCpuRealtimePeriod(Long cpuRealtimePeriod)
HostConfig	withCpuRealtimeRuntime(Long cpuRealtimeRuntime)
HostConfig	withCpusetCpus(String cpusetCpus)
HostConfig	withCpusetMems(String cpusetMems)
HostConfig	withCpuShares(Integer cpuShares)
HostConfig	withDeviceCgroupRules(List<String> deviceCgroupRules)
HostConfig	withDeviceRequests(List<DeviceRequest> deviceRequests)
HostConfig	withDevices(Device... devices)
HostConfig	withDevices(List<Device> devices)
HostConfig	withDiskQuota(Long diskQuota)
HostConfig	withDns(List<String> dns)
HostConfig	withDns(String... dns)
HostConfig	withDnsOptions(List<String> dnsOptions)
HostConfig	withDnsSearch(List<String> dnsSearch)
HostConfig	withDnsSearch(String... dnsSearch)
HostConfig	withExtraHosts(String... extraHosts)
HostConfig	withGroupAdd(List<String> groupAdd)
HostConfig	withInit(Boolean init)
HostConfig	withIoMaximumBandwidth(Long ioMaximumBandwidth)
HostConfig	withIoMaximumIOps(Long ioMaximumIOps)
HostConfig	withIpcMode(String ipcMode)
HostConfig	withIsolation(Isolation isolation)
HostConfig	withKernelMemory(Long kernelMemory)
HostConfig	withLinks(Link... links)
HostConfig	withLinks(Links links)
HostConfig	withLinks(List<Link> links)
HostConfig	withLogConfig(LogConfig logConfig)
HostConfig	withLxcConf(LxcConf[] lxcConf)
HostConfig	withMemory(Long memory)
HostConfig	withMemoryReservation(Long memoryReservation)
HostConfig	withMemorySwap(Long memorySwap)
HostConfig	withMemorySwappiness(Long memorySwappiness)
HostConfig	withMounts(List<Mount> mounts)
HostConfig	withNanoCPUs(Long nanoCPUs)
HostConfig	withNetworkMode(String networkMode) Set the Network mode for the container 'bridge': creates a new network stack for the container on the docker bridge 'none': no networking for this container 'container:': reuses another container network stack 'host': use the host network stack inside the container.
HostConfig	withOomKillDisable(Boolean oomKillDisable)
HostConfig	withOomScoreAdj(Integer oomScoreAdj)
HostConfig	withPidMode(String pidMode) Set the PID (Process) Namespace mode for the container, 'host': use the host's PID namespace inside the container
HostConfig	withPidsLimit(Long pidsLimit)
HostConfig	withPortBindings(List<PortBinding> portBindings)
HostConfig	withPortBindings(PortBinding... portBindings)
HostConfig	withPortBindings(Ports portBindings) Add one or more PortBindings.
HostConfig	withPrivileged(Boolean privileged)
HostConfig	withPublishAllPorts(Boolean publishAllPorts)
HostConfig	withReadonlyRootfs(Boolean readonlyRootfs)
HostConfig	withRestartPolicy(RestartPolicy restartPolicy) Set custom RestartPolicy for the container.
HostConfig	withRuntime(String runtime)
HostConfig	withSecurityOpts(List<String> securityOpts)
HostConfig	withShmSize(Long shmSize)
HostConfig	withStorageOpt(Map<String,String> storageOpt)
HostConfig	withSysctls(Map<String,String> sysctls)
HostConfig	withTmpFs(Map<String,String> tmpFs)
HostConfig	withUlimits(List<Ulimit> ulimits)
HostConfig	withUlimits(Ulimit[] ulimits)
HostConfig	withUsernsMode(String usernsMode)
HostConfig	withUtSMode(String utSMode)
HostConfig	withVolumeDriver(String volumeDriver)
HostConfig	withVolumesFrom(List<VolumesFrom> volumesFrom)
HostConfig	withVolumesFrom(VolumesFrom... volumesFrom)

Methods inherited from class com.github.dockerjava.api.model.DockerObject

getRawValues

Methods inherited from class java.lang.Object

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

Constructor Detail

HostConfig

public HostConfig()

Method Detail

newHostConfig

public static HostConfig newHostConfig()

getBinds

public Bind[] getBinds()

getBlkioWeight

public Integer getBlkioWeight()

getCapAdd

public Capability[] getCapAdd()

getCapDrop

public Capability[] getCapDrop()

getContainerIDFile

public String getContainerIDFile()

getCpuPeriod

public Long getCpuPeriod()

getCpuShares

public Integer getCpuShares()

getCpusetCpus

public String getCpusetCpus()

getCpusetMems

public String getCpusetMems()

getDevices

public Device[] getDevices()

getDiskQuota

public Long getDiskQuota()

getDns

public String[] getDns()

getDnsSearch

public String[] getDnsSearch()

getExtraHosts

public String[] getExtraHosts()

getLinks

public Link[] getLinks()

getLogConfig

public LogConfig getLogConfig()

getLxcConf

public LxcConf[] getLxcConf()

getMemory

public Long getMemory()

getMemorySwap

public Long getMemorySwap()

getNetworkMode

public String getNetworkMode()

getPortBindings

public Ports getPortBindings()

getRestartPolicy

public RestartPolicy getRestartPolicy()

getUlimits

public Ulimit[] getUlimits()

getVolumesFrom

public VolumesFrom[] getVolumesFrom()

getPidMode

@CheckForNull
public String getPidMode()

getBlkioDeviceReadBps

@CheckForNull
public List<BlkioRateDevice> getBlkioDeviceReadBps()

See Also:

blkioDeviceReadBps

getBlkioDeviceReadIOps

@CheckForNull
public List<BlkioRateDevice> getBlkioDeviceReadIOps()

See Also:

blkioDeviceReadIOps

getBlkioDeviceWriteBps

@CheckForNull
public List<BlkioRateDevice> getBlkioDeviceWriteBps()

See Also:

blkioDeviceWriteBps

getBlkioDeviceWriteIOps

@CheckForNull
public List<BlkioRateDevice> getBlkioDeviceWriteIOps()

See Also:

blkioDeviceWriteIOps

getBlkioWeightDevice

@CheckForNull
public List<BlkioWeightDevice> getBlkioWeightDevice()

See Also:

blkioWeightDevice

getOomScoreAdj

@CheckForNull
public Integer getOomScoreAdj()

See Also:

oomScoreAdj

getCpuQuota

@CheckForNull
public Long getCpuQuota()

See Also:

cpuQuota

getKernelMemory

@CheckForNull
public Long getKernelMemory()

See Also:

kernelMemory

getMemoryReservation

@CheckForNull
public Long getMemoryReservation()

See Also:

memoryReservation

getMemorySwappiness

@CheckForNull
public Long getMemorySwappiness()

See Also:

memorySwappiness

getOomKillDisable

@CheckForNull
public Boolean getOomKillDisable()

See Also:

oomKillDisable

getAutoRemove

@CheckForNull
public Boolean getAutoRemove()

See Also:

autoRemove

getSecurityOpts

@CheckForNull
public List<String> getSecurityOpts()

See Also:

securityOpts

getCgroupParent

@CheckForNull
public String getCgroupParent()

See Also:

cgroupParent

getShmSize

@CheckForNull
public Long getShmSize()

See Also:

shmSize

getVolumeDriver

@CheckForNull
public String getVolumeDriver()

See Also:

volumeDriver

getPidsLimit

@CheckForNull
public Long getPidsLimit()

See Also:

pidsLimit

getTmpFs

@CheckForNull
public Map<String,String> getTmpFs()

See Also:

tmpFs

isUserDefinedNetwork

public boolean isUserDefinedNetwork()

Parse the network mode as specified at https://github.com/docker/engine-api/blob/master/types/container/hostconfig_unix.go

getRuntime

public String getRuntime()

setBinds

public void setBinds(Bind... binds)

setLinks

public void setLinks(Link... links)

withBinds

public HostConfig withBinds(Binds binds)

See Also:

binds

withBinds

public HostConfig withBinds(Bind... binds)

withBinds

public HostConfig withBinds(List<Bind> binds)

withBlkioDeviceReadBps

public HostConfig withBlkioDeviceReadBps(List<BlkioRateDevice> blkioDeviceReadBps)

See Also:

blkioDeviceReadBps

withBlkioDeviceReadIOps

public HostConfig withBlkioDeviceReadIOps(List<BlkioRateDevice> blkioDeviceReadIOps)

See Also:

blkioDeviceReadIOps

withBlkioDeviceWriteBps

public HostConfig withBlkioDeviceWriteBps(List<BlkioRateDevice> blkioDeviceWriteBps)

See Also:

blkioDeviceWriteBps

withBlkioDeviceWriteIOps

public HostConfig withBlkioDeviceWriteIOps(List<BlkioRateDevice> blkioDeviceWriteIOps)

See Also:

blkioDeviceWriteIOps

withBlkioWeight

public HostConfig withBlkioWeight(Integer blkioWeight)

See Also:

blkioWeight

withBlkioWeightDevice

public HostConfig withBlkioWeightDevice(List<BlkioWeightDevice> blkioWeightDevice)

See Also:

blkioWeightDevice

withCapAdd

public HostConfig withCapAdd(Capability... capAdd)

See Also:

capAdd

withCapDrop

public HostConfig withCapDrop(Capability... capDrop)

See Also:

capDrop

withCgroupParent

public HostConfig withCgroupParent(String cgroupParent)

See Also:

cgroupParent

withContainerIDFile

public HostConfig withContainerIDFile(String containerIDFile)

See Also:

containerIDFile

withCpuPeriod

public HostConfig withCpuPeriod(Long cpuPeriod)

See Also:

cpuPeriod

withCpuQuota

public HostConfig withCpuQuota(Long cpuQuota)

See Also:

cpuQuota

withCpusetCpus

public HostConfig withCpusetCpus(String cpusetCpus)

See Also:

cpusetCpus

withCpusetMems

public HostConfig withCpusetMems(String cpusetMems)

See Also:

cpusetMems

withCpuShares

public HostConfig withCpuShares(Integer cpuShares)

See Also:

cpuShares

withDevices

public HostConfig withDevices(Device... devices)

See Also:

devices

withDevices

public HostConfig withDevices(List<Device> devices)

withDiskQuota

public HostConfig withDiskQuota(Long diskQuota)

See Also:

diskQuota

withDns

public HostConfig withDns(String... dns)

See Also:

dns

withDns

public HostConfig withDns(List<String> dns)

withDnsSearch

public HostConfig withDnsSearch(String... dnsSearch)

See Also:

dnsSearch

withDnsSearch

public HostConfig withDnsSearch(List<String> dnsSearch)

withExtraHosts

public HostConfig withExtraHosts(String... extraHosts)

See Also:

extraHosts

withKernelMemory

public HostConfig withKernelMemory(Long kernelMemory)

See Also:

kernelMemory

withLinks

public HostConfig withLinks(Links links)

See Also:

links

withLinks

public HostConfig withLinks(Link... links)

withLinks

public HostConfig withLinks(List<Link> links)

withLogConfig

public HostConfig withLogConfig(LogConfig logConfig)

See Also:

logConfig

withLxcConf

public HostConfig withLxcConf(LxcConf[] lxcConf)

See Also:

lxcConf

withMemory

public HostConfig withMemory(Long memory)

See Also:

memory

withMemoryReservation

public HostConfig withMemoryReservation(Long memoryReservation)

See Also:

memoryReservation

withMemorySwap

public HostConfig withMemorySwap(Long memorySwap)

See Also:

memorySwap

withMemorySwappiness

public HostConfig withMemorySwappiness(Long memorySwappiness)

See Also:

memorySwappiness

withNetworkMode

public HostConfig withNetworkMode(String networkMode)

Set the Network mode for the container

• 'bridge': creates a new network stack for the container on the docker bridge
• 'none': no networking for this container
• 'container:': reuses another container network stack
• 'host': use the host network stack inside the container. Note: the host mode gives the container full access to local system services such as D-bus and is therefore considered insecure.

Any other value is interpreted as a custom network's name for this container to connect to.

withOomKillDisable

public HostConfig withOomKillDisable(Boolean oomKillDisable)

Since:

1.19

See Also:

oomKillDisable

withAutoRemove

public HostConfig withAutoRemove(Boolean autoRemove)

See Also:

autoRemove

withOomScoreAdj

public HostConfig withOomScoreAdj(Integer oomScoreAdj)

See Also:

oomScoreAdj

withPidMode

public HostConfig withPidMode(String pidMode)

Set the PID (Process) Namespace mode for the container, 'host': use the host's PID namespace inside the container

See Also:

pidMode

withPortBindings

public HostConfig withPortBindings(Ports portBindings)

Add one or more PortBindings. This corresponds to the --publish (-p) option of the docker run CLI command.

withPortBindings

public HostConfig withPortBindings(PortBinding... portBindings)

withPortBindings

public HostConfig withPortBindings(List<PortBinding> portBindings)

getPrivileged

@CheckForNull
public Boolean getPrivileged()

See Also:

privileged

withPrivileged

public HostConfig withPrivileged(Boolean privileged)

See Also:

privileged

getPublishAllPorts

@CheckForNull
public Boolean getPublishAllPorts()

See Also:

publishAllPorts

withPublishAllPorts

public HostConfig withPublishAllPorts(Boolean publishAllPorts)

See Also:

publishAllPorts

getReadonlyRootfs

@CheckForNull
public Boolean getReadonlyRootfs()

See Also:

readonlyRootfs

withReadonlyRootfs

public HostConfig withReadonlyRootfs(Boolean readonlyRootfs)

See Also:

readonlyRootfs

withRestartPolicy

public HostConfig withRestartPolicy(RestartPolicy restartPolicy)

Set custom RestartPolicy for the container. Defaults to RestartPolicy.noRestart()

withSecurityOpts

public HostConfig withSecurityOpts(List<String> securityOpts)

See Also:

securityOpts

withShmSize

public HostConfig withShmSize(Long shmSize)

See Also:

shmSize

withUlimits

public HostConfig withUlimits(Ulimit[] ulimits)

See Also:

ulimits

withUlimits

public HostConfig withUlimits(List<Ulimit> ulimits)

withVolumeDriver

public HostConfig withVolumeDriver(String volumeDriver)

See Also:

volumeDriver

withVolumesFrom

public HostConfig withVolumesFrom(VolumesFrom... volumesFrom)

See Also:

volumesFrom

withVolumesFrom

public HostConfig withVolumesFrom(List<VolumesFrom> volumesFrom)

withPidsLimit

public HostConfig withPidsLimit(Long pidsLimit)

See Also:

pidsLimit

withRuntime

public HostConfig withRuntime(String runtime)

withTmpFs

public HostConfig withTmpFs(Map<String,String> tmpFs)

See Also:

tmpFs

getDeviceCgroupRules

@CheckForNull
public List<String> getDeviceCgroupRules()

withDeviceCgroupRules

public HostConfig withDeviceCgroupRules(List<String> deviceCgroupRules)

getDeviceRequests

@CheckForNull
public List<DeviceRequest> getDeviceRequests()

withDeviceRequests

public HostConfig withDeviceRequests(List<DeviceRequest> deviceRequests)

getNanoCPUs

@CheckForNull
public Long getNanoCPUs()

withNanoCPUs

public HostConfig withNanoCPUs(Long nanoCPUs)

getInit

@CheckForNull
public Boolean getInit()

withInit

public HostConfig withInit(Boolean init)

getCpuCount

@CheckForNull
public Long getCpuCount()

withCpuCount

public HostConfig withCpuCount(Long cpuCount)

getCpuPercent

@CheckForNull
public Long getCpuPercent()

withCpuPercent

public HostConfig withCpuPercent(Long cpuPercent)

getIoMaximumIOps

@CheckForNull
public Long getIoMaximumIOps()

withIoMaximumIOps

public HostConfig withIoMaximumIOps(Long ioMaximumIOps)

getIoMaximumBandwidth

@CheckForNull
public Long getIoMaximumBandwidth()

withIoMaximumBandwidth

public HostConfig withIoMaximumBandwidth(Long ioMaximumBandwidth)

getMounts

@CheckForNull
public List<Mount> getMounts()

withMounts

public HostConfig withMounts(List<Mount> mounts)

getDnsOptions

@CheckForNull
public List<String> getDnsOptions()

withDnsOptions

public HostConfig withDnsOptions(List<String> dnsOptions)

getGroupAdd

@CheckForNull
public List<String> getGroupAdd()

withGroupAdd

public HostConfig withGroupAdd(List<String> groupAdd)

getIpcMode

@CheckForNull
public String getIpcMode()

withIpcMode

public HostConfig withIpcMode(String ipcMode)

getCgroup

@CheckForNull
public String getCgroup()

withCgroup

public HostConfig withCgroup(String cgroup)

getStorageOpt

@CheckForNull
public Map<String,String> getStorageOpt()

withStorageOpt

public HostConfig withStorageOpt(Map<String,String> storageOpt)

getUtSMode

@CheckForNull
public String getUtSMode()

withUtSMode

public HostConfig withUtSMode(String utSMode)

getUsernsMode

@CheckForNull
public String getUsernsMode()

withUsernsMode

public HostConfig withUsernsMode(String usernsMode)

getCgroupnsMode

@CheckForNull
public String getCgroupnsMode()

withCgroupnsMode

public HostConfig withCgroupnsMode(String cgroupnsMode)

getSysctls

@CheckForNull
public Map<String,String> getSysctls()

withSysctls

public HostConfig withSysctls(Map<String,String> sysctls)

getConsoleSize

@CheckForNull
public List<Integer> getConsoleSize()

withConsoleSize

public HostConfig withConsoleSize(List<Integer> consoleSize)

getIsolation

@CheckForNull
public Isolation getIsolation()

withIsolation

public HostConfig withIsolation(Isolation isolation)

getCpuRealtimePeriod

@CheckForNull
public Long getCpuRealtimePeriod()

withCpuRealtimePeriod

public HostConfig withCpuRealtimePeriod(Long cpuRealtimePeriod)

getCpuRealtimeRuntime

@CheckForNull
public Long getCpuRealtimeRuntime()

withCpuRealtimeRuntime

public HostConfig withCpuRealtimeRuntime(Long cpuRealtimeRuntime)