com.github.dockerjava.api.model

Class HostConfig

java.lang.Object

com.github.dockerjava.api.model.HostConfig

All Implemented Interfaces:

Serializable

public class HostConfig
extends Object
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	equals(Object o)
Bind[]	getBinds()
List<Object>	getBlkioDeviceReadBps()
List<Object>	getBlkioDeviceReadIOps()
List<Object>	getBlkioDeviceWriteBps()
List<Object>	getBlkioDeviceWriteIOps()
Integer	getBlkioWeight()
List<Object>	getBlkioWeightDevice()
Capability[]	getCapAdd()
Capability[]	getCapDrop()
String	getCgroupParent()
String	getContainerIDFile()
Integer	getCpuPeriod()
Integer	getCpuQuota()
String	getCpusetCpus()
String	getCpusetMems()
Integer	getCpuShares()
Device[]	getDevices()
String[]	getDns()
String[]	getDnsSearch()
String[]	getExtraHosts()
Long	getKernelMemory()
Link[]	getLinks()
LogConfig	getLogConfig()
LxcConf[]	getLxcConf()
Long	getMemory()
Long	getMemoryReservation()
Long	getMemorySwap()
Integer	getMemorySwappiness()
String	getNetworkMode()
Boolean	getOomKillDisable()
Boolean	getOomScoreAdj()
String	getPidMode()
Long	getPidsLimit()
Ports	getPortBindings()
Boolean	getPrivileged()
Boolean	getPublishAllPorts()
Boolean	getReadonlyRootfs()
RestartPolicy	getRestartPolicy()
List<String>	getSecurityOpts()
Long	getShmSize()
Ulimit[]	getUlimits()
String	getVolumeDriver()
VolumesFrom[]	getVolumesFrom()
int	hashCode()
boolean	isUserDefinedNetwork() Parse the network mode as specified at https://github.com/docker/engine-api/blob/master/types/container/hostconfig_unix.go
void	setBinds(Bind... binds)
void	setLinks(Link... links)
String	toString()
HostConfig	withBinds(Binds binds)
HostConfig	withBlkioDeviceReadBps(List<Object> blkioDeviceReadBps)
HostConfig	withBlkioDeviceReadIOps(List<Object> blkioDeviceReadIOps)
HostConfig	withBlkioDeviceWriteBps(List<Object> blkioDeviceWriteBps)
HostConfig	withBlkioDeviceWriteIOps(List<Object> blkioDeviceWriteIOps)
HostConfig	withBlkioWeight(Integer blkioWeight)
HostConfig	withBlkioWeightDevice(List<Object> blkioWeightDevice)
HostConfig	withCapAdd(Capability[] capAdd)
HostConfig	withCapDrop(Capability[] capDrop)
HostConfig	withCgroupParent(String cgroupParent)
HostConfig	withContainerIDFile(String containerIDFile)
HostConfig	withCpuPeriod(Integer cpuPeriod)
HostConfig	withCpuQuota(Integer cpuQuota)
HostConfig	withCpusetCpus(String cpusetCpus)
HostConfig	withCpusetMems(String cpusetMems)
HostConfig	withCpuShares(Integer cpuShares)
HostConfig	withDevices(Device[] devices)
HostConfig	withDns(String[] dns)
HostConfig	withDnsSearch(String[] dnsSearch)
HostConfig	withExtraHosts(String[] extraHosts)
HostConfig	withKernelMemory(Long kernelMemory)
HostConfig	withLinks(Links links)
HostConfig	withLogConfig(LogConfig logConfig)
HostConfig	withLxcConf(LxcConf[] lxcConf)
HostConfig	withMemory(Long memory)
HostConfig	withMemoryReservation(Long memoryReservation)
HostConfig	withMemorySwap(Long memorySwap)
HostConfig	withMemorySwappiness(Integer memorySwappiness)
HostConfig	withNetworkMode(String networkMode)
HostConfig	withOomKillDisable(Boolean oomKillDisable)
HostConfig	withOomScoreAdj(Boolean oomScoreAdj)
HostConfig	withPidMode(String pidMode)
HostConfig	withPidsLimit(Long pidsLimit)
HostConfig	withPortBindings(Ports portBindings)
HostConfig	withPrivileged(Boolean privileged)
HostConfig	withPublishAllPorts(Boolean publishAllPorts)
HostConfig	withReadonlyRootfs(Boolean readonlyRootfs)
HostConfig	withRestartPolicy(RestartPolicy restartPolicy)
HostConfig	withSecurityOpts(List<String> securityOpts)
HostConfig	withShmSize(Long shmSize)
HostConfig	withUlimits(Ulimit[] ulimits)
HostConfig	withVolumeDriver(String volumeDriver)
HostConfig	withVolumesFrom(VolumesFrom[] volumesFrom)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HostConfig

public HostConfig()

Method Detail

getBinds

public Bind[] getBinds()

getBlkioWeight

public Integer getBlkioWeight()

getCapAdd

public Capability[] getCapAdd()

getCapDrop

public Capability[] getCapDrop()

getContainerIDFile

public String getContainerIDFile()

getCpuPeriod

public Integer getCpuPeriod()

getCpuShares

public Integer getCpuShares()

getCpusetCpus

public String getCpusetCpus()

getCpusetMems

public String getCpusetMems()

getDevices

public Device[] getDevices()

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<Object> getBlkioDeviceReadBps()

See Also:

blkioDeviceReadBps

getBlkioDeviceReadIOps

@CheckForNull
public List<Object> getBlkioDeviceReadIOps()

See Also:

blkioDeviceReadIOps

getBlkioDeviceWriteBps

@CheckForNull
public List<Object> getBlkioDeviceWriteBps()

See Also:

blkioDeviceWriteBps

getBlkioDeviceWriteIOps

@CheckForNull
public List<Object> getBlkioDeviceWriteIOps()

See Also:

blkioDeviceWriteIOps

getBlkioWeightDevice

@CheckForNull
public List<Object> getBlkioWeightDevice()

See Also:

blkioWeightDevice

getOomScoreAdj

@CheckForNull
public Boolean getOomScoreAdj()

See Also:

oomScoreAdj

getCpuQuota

@CheckForNull
public Integer getCpuQuota()

See Also:

cpuQuota

getKernelMemory

@CheckForNull
public Long getKernelMemory()

See Also:

kernelMemory

getMemoryReservation

@CheckForNull
public Long getMemoryReservation()

See Also:

memoryReservation

getMemorySwappiness

@CheckForNull
public Integer getMemorySwappiness()

See Also:

memorySwappiness

getOomKillDisable

@CheckForNull
public Boolean getOomKillDisable()

See Also:

oomKillDisable

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

isUserDefinedNetwork

public boolean isUserDefinedNetwork()

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

setBinds

public void setBinds(Bind... binds)

setLinks

public void setLinks(Link... links)

withBinds

public HostConfig withBinds(Binds binds)

See Also:

binds

withBlkioDeviceReadBps

public HostConfig withBlkioDeviceReadBps(List<Object> blkioDeviceReadBps)

See Also:

blkioDeviceReadBps

withBlkioDeviceReadIOps

public HostConfig withBlkioDeviceReadIOps(List<Object> blkioDeviceReadIOps)

See Also:

blkioDeviceReadIOps

withBlkioDeviceWriteBps

public HostConfig withBlkioDeviceWriteBps(List<Object> blkioDeviceWriteBps)

See Also:

blkioDeviceWriteBps

withBlkioDeviceWriteIOps

public HostConfig withBlkioDeviceWriteIOps(List<Object> blkioDeviceWriteIOps)

See Also:

blkioDeviceWriteIOps

withBlkioWeight

public HostConfig withBlkioWeight(Integer blkioWeight)

See Also:

blkioWeight

withBlkioWeightDevice

public HostConfig withBlkioWeightDevice(List<Object> 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(Integer cpuPeriod)

See Also:

cpuPeriod

withCpuQuota

public HostConfig withCpuQuota(Integer 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

withDns

public HostConfig withDns(String[] dns)

See Also:

dns

withDnsSearch

public HostConfig withDnsSearch(String[] dnsSearch)

See Also:

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

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(Integer memorySwappiness)

See Also:

memorySwappiness

withNetworkMode

public HostConfig withNetworkMode(String networkMode)

See Also:

networkMode

withOomKillDisable

public HostConfig withOomKillDisable(Boolean oomKillDisable)

See Also:

oomKillDisable

withOomScoreAdj

public HostConfig withOomScoreAdj(Boolean oomScoreAdj)

See Also:

oomScoreAdj

withPidMode

public HostConfig withPidMode(String pidMode)

See Also:

pidMode

withPortBindings

public HostConfig withPortBindings(Ports portBindings)

See Also:

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)

See Also:

restartPolicy

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

withVolumeDriver

public HostConfig withVolumeDriver(String volumeDriver)

See Also:

volumeDriver

withVolumesFrom

public HostConfig withVolumesFrom(VolumesFrom[] volumesFrom)

See Also:

volumesFrom

withPidsLimit

public HostConfig withPidsLimit(Long pidsLimit)

See Also:

pidsLimit

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object