Package com.spotify.docker.client.messages

Class HostConfig

java.lang.Object

com.spotify.docker.client.messages.HostConfig

Direct Known Subclasses:

AutoValue_HostConfig

public abstract class HostConfig
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HostConfig.Bind
static class	HostConfig.BlkioDeviceRate
static class	HostConfig.BlkioWeightDevice
static class	HostConfig.Builder
static class	HostConfig.LxcConfParameter
static class	HostConfig.RestartPolicy
static class	HostConfig.Ulimit

Constructor Summary

Constructors

Constructor	Description
HostConfig()

Method Summary

Modifier and Type	Method	Description
abstract java.lang.Boolean	autoRemove()
abstract com.google.common.collect.ImmutableList<java.lang.String>	binds()
abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate>	blkioDeviceReadBps()
abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate>	blkioDeviceReadIOps()
abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate>	blkioDeviceWriteBps()
abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate>	blkioDeviceWriteIOps()
abstract java.lang.Integer	blkioWeight()
abstract com.google.common.collect.ImmutableList<HostConfig.BlkioWeightDevice>	blkioWeightDevice()
static HostConfig.Builder	builder()
abstract com.google.common.collect.ImmutableList<java.lang.String>	capAdd()
abstract com.google.common.collect.ImmutableList<java.lang.String>	capDrop()
abstract java.lang.String	cgroupParent()
abstract java.lang.String	containerIdFile()
abstract java.lang.Long	cpuPeriod()
abstract java.lang.Long	cpuQuota()
abstract java.lang.String	cpusetCpus()
abstract java.lang.String	cpusetMems()
abstract java.lang.Long	cpuShares()
(package private) static HostConfig	create(java.util.List<java.lang.String> binds, java.lang.Integer blkioWeight, java.util.List<HostConfig.BlkioWeightDevice> blkioWeightDevice, java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceReadBps, java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceWriteBps, java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceReadIOps, java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceWriteIOps, java.lang.String containerIdFile, java.util.List<HostConfig.LxcConfParameter> lxcConf, java.lang.Boolean privileged, java.util.Map<java.lang.String,java.util.List<PortBinding>> portBindings, java.util.List<java.lang.String> links, java.lang.Boolean publishAllPorts, java.util.List<java.lang.String> dns, java.util.List<java.lang.String> dnsOptions, java.util.List<java.lang.String> dnsSearch, java.util.List<java.lang.String> extraHosts, java.util.List<java.lang.String> volumesFrom, java.util.List<java.lang.String> capAdd, java.util.List<java.lang.String> capDrop, java.lang.String networkMode, java.util.List<java.lang.String> securityOpt, java.util.List<Device> devices, java.lang.Long memory, java.lang.Long memorySwap, java.lang.Integer memorySwappiness, java.lang.Long memoryReservation, java.lang.Long nanoCpus, java.lang.Long cpuPeriod, java.lang.Long cpuShares, java.lang.String cpusetCpus, java.lang.String cpusetMems, java.lang.Long cpuQuota, java.lang.String cgroupParent, HostConfig.RestartPolicy restartPolicy, LogConfig logConfig, java.lang.String ipcMode, java.util.List<HostConfig.Ulimit> ulimits, java.lang.String pidMode, java.lang.Long shmSize, java.lang.Boolean oomKillDisable, java.lang.Integer oomScoreAdj, java.lang.Boolean autoRemove, java.lang.Integer pidsLimit, java.util.Map<java.lang.String,java.lang.String> tmpfs, java.lang.Boolean readonlyRootfs, java.util.Map<java.lang.String,java.lang.String> storageOpt)
abstract com.google.common.collect.ImmutableList<Device>	devices()
abstract com.google.common.collect.ImmutableList<java.lang.String>	dns()
abstract com.google.common.collect.ImmutableList<java.lang.String>	dnsOptions()
abstract com.google.common.collect.ImmutableList<java.lang.String>	dnsSearch()
abstract com.google.common.collect.ImmutableList<java.lang.String>	extraHosts()
abstract java.lang.String	ipcMode()
abstract com.google.common.collect.ImmutableList<java.lang.String>	links()
abstract LogConfig	logConfig()
abstract com.google.common.collect.ImmutableList<HostConfig.LxcConfParameter>	lxcConf()
abstract java.lang.Long	memory()
abstract java.lang.Long	memoryReservation()
abstract java.lang.Long	memorySwap()
abstract java.lang.Integer	memorySwappiness()
abstract java.lang.Long	nanoCpus()
abstract java.lang.String	networkMode()
abstract java.lang.Boolean	oomKillDisable()
abstract java.lang.Integer	oomScoreAdj()
abstract java.lang.String	pidMode()
abstract java.lang.Integer	pidsLimit()	Tune container pids limit (set -1 for unlimited).
abstract com.google.common.collect.ImmutableMap<java.lang.String,java.util.List<PortBinding>>	portBindings()
abstract java.lang.Boolean	privileged()
abstract java.lang.Boolean	publishAllPorts()
abstract java.lang.Boolean	readonlyRootfs()
abstract HostConfig.RestartPolicy	restartPolicy()
abstract com.google.common.collect.ImmutableList<java.lang.String>	securityOpt()
abstract java.lang.Long	shmSize()
abstract com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	storageOpt()
abstract com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String>	tmpfs()
abstract HostConfig.Builder	toBuilder()
abstract com.google.common.collect.ImmutableList<HostConfig.Ulimit>	ulimits()
private static void	validateExtraHosts(java.util.List<java.lang.String> extraHosts)
abstract com.google.common.collect.ImmutableList<java.lang.String>	volumesFrom()

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

binds

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> binds()

blkioWeight

@Nullable
public abstract java.lang.Integer blkioWeight()

blkioWeightDevice

@Nullable
public abstract com.google.common.collect.ImmutableList<HostConfig.BlkioWeightDevice> blkioWeightDevice()

blkioDeviceReadBps

@Nullable
public abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate> blkioDeviceReadBps()

blkioDeviceWriteBps

@Nullable
public abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate> blkioDeviceWriteBps()

blkioDeviceReadIOps

@Nullable
public abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate> blkioDeviceReadIOps()

blkioDeviceWriteIOps

@Nullable
public abstract com.google.common.collect.ImmutableList<HostConfig.BlkioDeviceRate> blkioDeviceWriteIOps()

containerIdFile

@Nullable
public abstract java.lang.String containerIdFile()

lxcConf

@Nullable
public abstract com.google.common.collect.ImmutableList<HostConfig.LxcConfParameter> lxcConf()

privileged

@Nullable
public abstract java.lang.Boolean privileged()

portBindings

@Nullable
public abstract com.google.common.collect.ImmutableMap<java.lang.String,java.util.List<PortBinding>> portBindings()

links

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> links()

publishAllPorts

@Nullable
public abstract java.lang.Boolean publishAllPorts()

dns

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> dns()

dnsOptions

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> dnsOptions()

dnsSearch

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> dnsSearch()

extraHosts

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> extraHosts()

volumesFrom

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> volumesFrom()

capAdd

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> capAdd()

capDrop

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> capDrop()

networkMode

@Nullable
public abstract java.lang.String networkMode()

securityOpt

@Nullable
public abstract com.google.common.collect.ImmutableList<java.lang.String> securityOpt()

devices

@Nullable
public abstract com.google.common.collect.ImmutableList<Device> devices()

memory

@Nullable
public abstract java.lang.Long memory()

memorySwap

@Nullable
public abstract java.lang.Long memorySwap()

memorySwappiness

@Nullable
public abstract java.lang.Integer memorySwappiness()

memoryReservation

@Nullable
public abstract java.lang.Long memoryReservation()

nanoCpus

@Nullable
public abstract java.lang.Long nanoCpus()

cpuPeriod

@Nullable
public abstract java.lang.Long cpuPeriod()

cpuShares

@Nullable
public abstract java.lang.Long cpuShares()

cpusetCpus

@Nullable
public abstract java.lang.String cpusetCpus()

cpusetMems

@Nullable
public abstract java.lang.String cpusetMems()

cpuQuota

@Nullable
public abstract java.lang.Long cpuQuota()

cgroupParent

@Nullable
public abstract java.lang.String cgroupParent()

restartPolicy

@Nullable
public abstract HostConfig.RestartPolicy restartPolicy()

logConfig

@Nullable
public abstract LogConfig logConfig()

ipcMode

@Nullable
public abstract java.lang.String ipcMode()

ulimits

@Nullable
public abstract com.google.common.collect.ImmutableList<HostConfig.Ulimit> ulimits()

pidMode

@Nullable
public abstract java.lang.String pidMode()

shmSize

@Nullable
public abstract java.lang.Long shmSize()

oomKillDisable

@Nullable
public abstract java.lang.Boolean oomKillDisable()

oomScoreAdj

@Nullable
public abstract java.lang.Integer oomScoreAdj()

autoRemove

@Nullable
public abstract java.lang.Boolean autoRemove()

pidsLimit

@Nullable
public abstract java.lang.Integer pidsLimit()

Tune container pids limit (set -1 for unlimited). Only works for kernels >= 4.3

Returns:

An integer indicating the pids limit.

tmpfs

@Nullable
public abstract com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> tmpfs()

readonlyRootfs

@Nullable
public abstract java.lang.Boolean readonlyRootfs()

storageOpt

@Nullable
public abstract com.google.common.collect.ImmutableMap<java.lang.String,java.lang.String> storageOpt()

create

static HostConfig create(java.util.List<java.lang.String> binds,
                         java.lang.Integer blkioWeight,
                         java.util.List<HostConfig.BlkioWeightDevice> blkioWeightDevice,
                         java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceReadBps,
                         java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceWriteBps,
                         java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceReadIOps,
                         java.util.List<HostConfig.BlkioDeviceRate> blkioDeviceWriteIOps,
                         java.lang.String containerIdFile,
                         java.util.List<HostConfig.LxcConfParameter> lxcConf,
                         java.lang.Boolean privileged,
                         java.util.Map<java.lang.String,java.util.List<PortBinding>> portBindings,
                         java.util.List<java.lang.String> links,
                         java.lang.Boolean publishAllPorts,
                         java.util.List<java.lang.String> dns,
                         java.util.List<java.lang.String> dnsOptions,
                         java.util.List<java.lang.String> dnsSearch,
                         java.util.List<java.lang.String> extraHosts,
                         java.util.List<java.lang.String> volumesFrom,
                         java.util.List<java.lang.String> capAdd,
                         java.util.List<java.lang.String> capDrop,
                         java.lang.String networkMode,
                         java.util.List<java.lang.String> securityOpt,
                         java.util.List<Device> devices,
                         java.lang.Long memory,
                         java.lang.Long memorySwap,
                         java.lang.Integer memorySwappiness,
                         java.lang.Long memoryReservation,
                         java.lang.Long nanoCpus,
                         java.lang.Long cpuPeriod,
                         java.lang.Long cpuShares,
                         java.lang.String cpusetCpus,
                         java.lang.String cpusetMems,
                         java.lang.Long cpuQuota,
                         java.lang.String cgroupParent,
                         HostConfig.RestartPolicy restartPolicy,
                         LogConfig logConfig,
                         java.lang.String ipcMode,
                         java.util.List<HostConfig.Ulimit> ulimits,
                         java.lang.String pidMode,
                         java.lang.Long shmSize,
                         java.lang.Boolean oomKillDisable,
                         java.lang.Integer oomScoreAdj,
                         java.lang.Boolean autoRemove,
                         java.lang.Integer pidsLimit,
                         java.util.Map<java.lang.String,java.lang.String> tmpfs,
                         java.lang.Boolean readonlyRootfs,
                         java.util.Map<java.lang.String,java.lang.String> storageOpt)

toBuilder

public abstract HostConfig.Builder toBuilder()

builder

public static HostConfig.Builder builder()

validateExtraHosts

private static void validateExtraHosts(java.util.List<java.lang.String> extraHosts)