com.github.dockerjava.api.command

Interface CreateContainerCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<CreateContainerResponse>, SyncDockerCmd<CreateContainerResponse>

public interface CreateContainerCmd
extends SyncDockerCmd<CreateContainerResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CreateContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
CreateContainerResponse	exec()
List<String>	getAliases()
Boolean	getArgsEscaped()
AuthConfig	getAuthConfig()
default Bind[]	getBinds() Deprecated.
default Integer	getBlkioWeight() Deprecated.
default Capability[]	getCapAdd() Deprecated.
default Capability[]	getCapDrop() Deprecated.
default String	getCgroupParent() Deprecated.
String[]	getCmd()
default Integer	getCpuPeriod() Deprecated.
default String	getCpusetCpus() Deprecated.
default String	getCpusetMems() Deprecated.
default Integer	getCpuShares() Deprecated.
default Device[]	getDevices() Deprecated.
default String[]	getDns() Deprecated.
default String[]	getDnsSearch() Deprecated.
String	getDomainName()
String[]	getEntrypoint()
String[]	getEnv()
ExposedPort[]	getExposedPorts()
default String[]	getExtraHosts() Deprecated.
HealthCheck	getHealthcheck()
HostConfig	getHostConfig()
String	getHostName()
String	getImage()
String	getIpv4Address()
String	getIpv6Address()
Map<String,String>	getLabels()
default Link[]	getLinks() Deprecated.
default LogConfig	getLogConfig() Deprecated.
default LxcConf[]	getLxcConf() Deprecated.
String	getMacAddress()
default Long	getMemory() Deprecated.
default Long	getMemorySwap() Deprecated.
String	getName()
default String	getNetworkMode() Deprecated.
List<String>	getOnBuild()
default Boolean	getOomKillDisable() Deprecated.
default String	getPidMode() Deprecated.
default Ports	getPortBindings() Deprecated.
String[]	getPortSpecs()
default Boolean	getPrivileged() Deprecated.
default Boolean	getPublishAllPorts() Deprecated.
default Boolean	getReadonlyRootfs() Deprecated.
default RestartPolicy	getRestartPolicy() Deprecated.
String	getStopSignal()
Integer	getStopTimeout()
default Ulimit[]	getUlimits() Deprecated.
String	getUser()
Volume[]	getVolumes()
default VolumesFrom[]	getVolumesFrom() Deprecated.
String	getWorkingDir()
Boolean	isAttachStderr()
Boolean	isAttachStdin()
Boolean	isAttachStdout()
Boolean	isNetworkDisabled()
Boolean	isStdInOnce()
Boolean	isStdinOpen()
Boolean	isTty()
CreateContainerCmd	withAliases(List<String> aliases) Add network-scoped alias for the container
CreateContainerCmd	withAliases(String... aliases) Add network-scoped alias for the container
CreateContainerCmd	withArgsEscaped(Boolean argsEscaped)
CreateContainerCmd	withAttachStderr(Boolean attachStderr)
CreateContainerCmd	withAttachStdin(Boolean attachStdin)
CreateContainerCmd	withAttachStdout(Boolean attachStdout)
CreateContainerCmd	withAuthConfig(AuthConfig authConfig) While using swarm classic, you can provide an optional auth config which will be used to pull images from a private registry, if the swarm node does not already have the docker image.
default CreateContainerCmd	withBinds(Bind... binds) Deprecated.
default CreateContainerCmd	withBinds(List<Bind> binds) Deprecated.
default CreateContainerCmd	withBlkioWeight(Integer blkioWeight) Deprecated.
default CreateContainerCmd	withCapAdd(Capability... capAdd) Deprecated.
default CreateContainerCmd	withCapAdd(List<Capability> capAdd) Deprecated.
default CreateContainerCmd	withCapDrop(Capability... capDrop) Deprecated.
default CreateContainerCmd	withCapDrop(List<Capability> capDrop) Deprecated.
default CreateContainerCmd	withCgroupParent(String cgroupParent) Deprecated.
CreateContainerCmd	withCmd(List<String> cmd)
CreateContainerCmd	withCmd(String... cmd)
default CreateContainerCmd	withContainerIDFile(String containerIDFile) Deprecated.
default CreateContainerCmd	withCpuPeriod(Integer cpuPeriod) Deprecated.
default CreateContainerCmd	withCpusetCpus(String cpusetCpus) Deprecated.
default CreateContainerCmd	withCpusetMems(String cpusetMems) Deprecated.
default CreateContainerCmd	withCpuShares(Integer cpuShares) Deprecated.
default CreateContainerCmd	withDevices(Device... devices) Deprecated.
default CreateContainerCmd	withDevices(List<Device> devices) Deprecated.
default CreateContainerCmd	withDns(List<String> dns) Deprecated.
default CreateContainerCmd	withDns(String... dns) Deprecated.
default CreateContainerCmd	withDnsSearch(List<String> dnsSearch) Deprecated.
default CreateContainerCmd	withDnsSearch(String... dnsSearch) Deprecated.
CreateContainerCmd	withDomainName(String domainName)
CreateContainerCmd	withEntrypoint(List<String> entrypoint)
CreateContainerCmd	withEntrypoint(String... entrypoint)
CreateContainerCmd	withEnv(List<String> env) Adds environment-variables.
CreateContainerCmd	withEnv(String... env) Adds environment-variables.
CreateContainerCmd	withExposedPorts(ExposedPort... exposedPorts)
CreateContainerCmd	withExposedPorts(List<ExposedPort> exposedPorts)
default CreateContainerCmd	withExtraHosts(List<String> extraHosts) Deprecated.
default CreateContainerCmd	withExtraHosts(String... extraHosts) Deprecated.
CreateContainerCmd	withHealthcheck(HealthCheck healthCheck)
CreateContainerCmd	withHostConfig(HostConfig hostConfig)
CreateContainerCmd	withHostName(String hostName)
CreateContainerCmd	withImage(String image)
CreateContainerCmd	withIpv4Address(String ipv4Address)
CreateContainerCmd	withIpv6Address(String ipv6Address)
CreateContainerCmd	withLabels(Map<String,String> labels)
default CreateContainerCmd	withLinks(Link... links) Deprecated.
default CreateContainerCmd	withLinks(List<Link> links) Deprecated.
default CreateContainerCmd	withLogConfig(LogConfig logConfig) Deprecated.
default CreateContainerCmd	withLxcConf(List<LxcConf> lxcConf) Deprecated.
default CreateContainerCmd	withLxcConf(LxcConf... lxcConf) Deprecated.
CreateContainerCmd	withMacAddress(String macAddress)
default CreateContainerCmd	withMemory(Long memory) Deprecated.
default CreateContainerCmd	withMemorySwap(Long memorySwap) Deprecated.
CreateContainerCmd	withName(String name)
CreateContainerCmd	withNetworkDisabled(Boolean disableNetwork)
default CreateContainerCmd	withNetworkMode(String networkMode) Deprecated.
CreateContainerCmd	withOnBuild(List<String> onBuild)
default CreateContainerCmd	withOomKillDisable(Boolean oomKillDisable) Deprecated.
default CreateContainerCmd	withPidMode(String pidMode) Deprecated.
default CreateContainerCmd	withPortBindings(List<PortBinding> portBindings) Deprecated.
default CreateContainerCmd	withPortBindings(PortBinding... portBindings) Deprecated.
default CreateContainerCmd	withPortBindings(Ports portBindings) Deprecated.
CreateContainerCmd	withPortSpecs(List<String> portSpecs)
CreateContainerCmd	withPortSpecs(String... portSpecs)
default CreateContainerCmd	withPrivileged(Boolean privileged) Deprecated.
default CreateContainerCmd	withPublishAllPorts(Boolean publishAllPorts) Deprecated.
default CreateContainerCmd	withReadonlyRootfs(Boolean readonlyRootfs) Deprecated.
default CreateContainerCmd	withRestartPolicy(RestartPolicy restartPolicy) Deprecated.
CreateContainerCmd	withStdInOnce(Boolean stdInOnce)
CreateContainerCmd	withStdinOpen(Boolean stdinOpen)
CreateContainerCmd	withStopSignal(String stopSignal)
CreateContainerCmd	withStopTimeout(Integer stopTimeout)
CreateContainerCmd	withTty(Boolean tty)
default CreateContainerCmd	withUlimits(List<Ulimit> ulimits) Deprecated.
default CreateContainerCmd	withUlimits(Ulimit... ulimits) Deprecated.
CreateContainerCmd	withUser(String user)
CreateContainerCmd	withVolumes(List<Volume> volumes)
CreateContainerCmd	withVolumes(Volume... volumes)
default CreateContainerCmd	withVolumesFrom(List<VolumesFrom> volumesFrom) Deprecated.
default CreateContainerCmd	withVolumesFrom(VolumesFrom... volumesFrom) Deprecated.
CreateContainerCmd	withWorkingDir(String workingDir)

Methods inherited from interface com.github.dockerjava.api.command.DockerCmd

close

Method Detail

getAuthConfig

@CheckForNull
AuthConfig getAuthConfig()

withAuthConfig

CreateContainerCmd withAuthConfig(AuthConfig authConfig)

While using swarm classic, you can provide an optional auth config which will be used to pull images from a private registry, if the swarm node does not already have the docker image. Note: This option does not have any effect in normal docker

Parameters:

authConfig - The optional auth config

getAliases

@CheckForNull
List<String> getAliases()

getBinds

@Deprecated
 @CheckForNull
default Bind[] getBinds()

Deprecated.

withBinds

@Deprecated
default CreateContainerCmd withBinds(Bind... binds)

Deprecated.

withBinds

@Deprecated
default CreateContainerCmd withBinds(List<Bind> binds)

Deprecated.

withAliases

CreateContainerCmd withAliases(List<String> aliases)

Add network-scoped alias for the container

Parameters:

aliases - on ore more aliases

withAliases

CreateContainerCmd withAliases(String... aliases)

Add network-scoped alias for the container

Parameters:

aliases - on ore more aliases

getCmd

@CheckForNull
String[] getCmd()

withCmd

CreateContainerCmd withCmd(String... cmd)

withCmd

CreateContainerCmd withCmd(List<String> cmd)

getHealthcheck

@CheckForNull
HealthCheck getHealthcheck()

withHealthcheck

CreateContainerCmd withHealthcheck(HealthCheck healthCheck)

getArgsEscaped

@CheckForNull
Boolean getArgsEscaped()

withArgsEscaped

CreateContainerCmd withArgsEscaped(Boolean argsEscaped)

getDomainName

@CheckForNull
String getDomainName()

withDomainName

CreateContainerCmd withDomainName(String domainName)

getEntrypoint

@CheckForNull
String[] getEntrypoint()

withEntrypoint

CreateContainerCmd withEntrypoint(String... entrypoint)

withEntrypoint

CreateContainerCmd withEntrypoint(List<String> entrypoint)

getEnv

@CheckForNull
String[] getEnv()

withEnv

CreateContainerCmd withEnv(String... env)

Adds environment-variables. NB: Not additive, i.e. in case of multiple calls to the method, only the most recent values will be injected. Prior env-variables will be deleted.

Parameters:

env - the String(s) to set as ENV in the container

withEnv

CreateContainerCmd withEnv(List<String> env)

Adds environment-variables. NB: Not additive, i.e. in case of multiple calls to the method, only the most recent values will be injected. Prior env-variables will be deleted.

Parameters:

env - the list of Strings to set as ENV in the container

getExposedPorts

@CheckForNull
ExposedPort[] getExposedPorts()

withExposedPorts

CreateContainerCmd withExposedPorts(List<ExposedPort> exposedPorts)

withExposedPorts

CreateContainerCmd withExposedPorts(ExposedPort... exposedPorts)

getStopSignal

@CheckForNull
String getStopSignal()

withStopSignal

CreateContainerCmd withStopSignal(String stopSignal)

getStopTimeout

@CheckForNull
Integer getStopTimeout()

withStopTimeout

CreateContainerCmd withStopTimeout(Integer stopTimeout)

getHostName

@CheckForNull
String getHostName()

withHostName

CreateContainerCmd withHostName(String hostName)

getImage

@CheckForNull
String getImage()

withImage

CreateContainerCmd withImage(String image)

getIpv4Address

@CheckForNull
String getIpv4Address()

withIpv4Address

CreateContainerCmd withIpv4Address(String ipv4Address)

getLinks

@Deprecated
 @CheckForNull
default Link[] getLinks()

Deprecated.

withLinks

@Deprecated
default CreateContainerCmd withLinks(Link... links)

Deprecated.

Add link to another container.

withLinks

@Deprecated
default CreateContainerCmd withLinks(List<Link> links)

Deprecated.

Add link to another container.

getIpv6Address

@CheckForNull
String getIpv6Address()

withIpv6Address

CreateContainerCmd withIpv6Address(String ipv6Address)

getLabels

@CheckForNull
Map<String,String> getLabels()

withLabels

CreateContainerCmd withLabels(Map<String,String> labels)

getMacAddress

@CheckForNull
String getMacAddress()

withMacAddress

CreateContainerCmd withMacAddress(String macAddress)

getMemory

@Deprecated
 @CheckForNull
default Long getMemory()

Deprecated.

withMemory

@Deprecated
default CreateContainerCmd withMemory(Long memory)

Deprecated.

getMemorySwap

@Deprecated
 @CheckForNull
default Long getMemorySwap()

Deprecated.

withMemorySwap

@Deprecated
default CreateContainerCmd withMemorySwap(Long memorySwap)

Deprecated.

getName

@CheckForNull
String getName()

getNetworkMode

@Deprecated
 @CheckForNull
default String getNetworkMode()

Deprecated.

withNetworkMode

@Deprecated
default CreateContainerCmd withNetworkMode(String networkMode)

Deprecated.

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.

getPortBindings

@Deprecated
 @CheckForNull
default Ports getPortBindings()

Deprecated.

withPortBindings

@Deprecated
default CreateContainerCmd withPortBindings(PortBinding... portBindings)

Deprecated.

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

withPortBindings

@Deprecated
default CreateContainerCmd withPortBindings(List<PortBinding> portBindings)

Deprecated.

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

withPortBindings

@Deprecated
default CreateContainerCmd withPortBindings(Ports portBindings)

Deprecated.

Add the port bindings that are contained in the given Ports object.

See Also:

withPortBindings(PortBinding...)

withName

CreateContainerCmd withName(String name)

getPortSpecs

@CheckForNull
String[] getPortSpecs()

withPortSpecs

CreateContainerCmd withPortSpecs(String... portSpecs)

withPortSpecs

CreateContainerCmd withPortSpecs(List<String> portSpecs)

getPrivileged

@Deprecated
 @CheckForNull
default Boolean getPrivileged()

Deprecated.

withPrivileged

@Deprecated
default CreateContainerCmd withPrivileged(Boolean privileged)

Deprecated.

getUser

@CheckForNull
String getUser()

withUser

CreateContainerCmd withUser(String user)

getVolumes

@CheckForNull
Volume[] getVolumes()

withVolumes

CreateContainerCmd withVolumes(Volume... volumes)

withVolumes

CreateContainerCmd withVolumes(List<Volume> volumes)

getVolumesFrom

@Deprecated
 @CheckForNull
default VolumesFrom[] getVolumesFrom()

Deprecated.

withVolumesFrom

@Deprecated
default CreateContainerCmd withVolumesFrom(VolumesFrom... volumesFrom)

Deprecated.

withVolumesFrom

@Deprecated
default CreateContainerCmd withVolumesFrom(List<VolumesFrom> volumesFrom)

Deprecated.

getWorkingDir

@CheckForNull
String getWorkingDir()

withWorkingDir

CreateContainerCmd withWorkingDir(String workingDir)

isAttachStderr

@CheckForNull
Boolean isAttachStderr()

withAttachStderr

CreateContainerCmd withAttachStderr(Boolean attachStderr)

isAttachStdin

@CheckForNull
Boolean isAttachStdin()

withAttachStdin

CreateContainerCmd withAttachStdin(Boolean attachStdin)

isAttachStdout

@CheckForNull
Boolean isAttachStdout()

withAttachStdout

CreateContainerCmd withAttachStdout(Boolean attachStdout)

isNetworkDisabled

@CheckForNull
Boolean isNetworkDisabled()

withNetworkDisabled

CreateContainerCmd withNetworkDisabled(Boolean disableNetwork)

isStdInOnce

@CheckForNull
Boolean isStdInOnce()

withStdInOnce

CreateContainerCmd withStdInOnce(Boolean stdInOnce)

isStdinOpen

@CheckForNull
Boolean isStdinOpen()

withStdinOpen

CreateContainerCmd withStdinOpen(Boolean stdinOpen)

isTty

@CheckForNull
Boolean isTty()

withTty

CreateContainerCmd withTty(Boolean tty)

getPublishAllPorts

@Deprecated
 @CheckForNull
default Boolean getPublishAllPorts()

Deprecated.

withPublishAllPorts

@Deprecated
default CreateContainerCmd withPublishAllPorts(Boolean publishAllPorts)

Deprecated.

getExtraHosts

@CheckForNull
 @Deprecated
default String[] getExtraHosts()

Deprecated.

withExtraHosts

@Deprecated
default CreateContainerCmd withExtraHosts(String... extraHosts)

Deprecated.

Add hostnames to /etc/hosts in the container

withExtraHosts

@Deprecated
default CreateContainerCmd withExtraHosts(List<String> extraHosts)

Deprecated.

Add hostnames to /etc/hosts in the container

getCapAdd

@CheckForNull
 @Deprecated
default Capability[] getCapAdd()

Deprecated.

withCapAdd

@Deprecated
default CreateContainerCmd withCapAdd(Capability... capAdd)

Deprecated.

Add linux kernel capability to the container. For example: adding Capability.MKNOD allows the container to create special files using the 'mknod' command.

withCapAdd

@Deprecated
default CreateContainerCmd withCapAdd(List<Capability> capAdd)

Deprecated.

Add linux kernel capability to the container. For example: adding Capability.MKNOD allows the container to create special files using the 'mknod' command.

getCapDrop

@CheckForNull
 @Deprecated
default Capability[] getCapDrop()

Deprecated.

withCapDrop

@Deprecated
default CreateContainerCmd withCapDrop(Capability... capDrop)

Deprecated.

Drop linux kernel capability from the container. For example: dropping Capability.CHOWN prevents the container from changing the owner of any files.

withCapDrop

@Deprecated
default CreateContainerCmd withCapDrop(List<Capability> capDrop)

Deprecated.

Drop linux kernel capability from the container. For example: dropping Capability.CHOWN prevents the container from changing the owner of any files.

getOnBuild

@CheckForNull
List<String> getOnBuild()

withOnBuild

CreateContainerCmd withOnBuild(List<String> onBuild)

getHostConfig

@CheckForNull
HostConfig getHostConfig()

withHostConfig

CreateContainerCmd withHostConfig(HostConfig hostConfig)

getBlkioWeight

@Deprecated
 @CheckForNull
default Integer getBlkioWeight()

Deprecated.

getCgroupParent

@CheckForNull
 @Deprecated
default String getCgroupParent()

Deprecated.

getCpuPeriod

@Deprecated
 @CheckForNull
default Integer getCpuPeriod()

Deprecated.

getCpuShares

@Deprecated
 @CheckForNull
default Integer getCpuShares()

Deprecated.

getCpusetCpus

@Deprecated
 @CheckForNull
default String getCpusetCpus()

Deprecated.

getCpusetMems

@Deprecated
 @CheckForNull
default String getCpusetMems()

Deprecated.

getDevices

@Deprecated
 @CheckForNull
default Device[] getDevices()

Deprecated.

getDns

@Deprecated
 @CheckForNull
default String[] getDns()

Deprecated.

getDnsSearch

@Deprecated
 @CheckForNull
default String[] getDnsSearch()

Deprecated.

getLogConfig

@Deprecated
 @CheckForNull
default LogConfig getLogConfig()

Deprecated.

getLxcConf

@Deprecated
 @CheckForNull
default LxcConf[] getLxcConf()

Deprecated.

getOomKillDisable

@Deprecated
 @CheckForNull
default Boolean getOomKillDisable()

Deprecated.

getPidMode

@Deprecated
 @CheckForNull
default String getPidMode()

Deprecated.

getReadonlyRootfs

@Deprecated
 @CheckForNull
default Boolean getReadonlyRootfs()

Deprecated.

getRestartPolicy

@Deprecated
 @CheckForNull
default RestartPolicy getRestartPolicy()

Deprecated.

getUlimits

@Deprecated
 @CheckForNull
default Ulimit[] getUlimits()

Deprecated.

withBlkioWeight

@Deprecated
default CreateContainerCmd withBlkioWeight(Integer blkioWeight)

Deprecated.

withCgroupParent

@Deprecated
default CreateContainerCmd withCgroupParent(String cgroupParent)

Deprecated.

withContainerIDFile

@Deprecated
default CreateContainerCmd withContainerIDFile(String containerIDFile)

Deprecated.

withCpuPeriod

@Deprecated
default CreateContainerCmd withCpuPeriod(Integer cpuPeriod)

Deprecated.

withCpuShares

@Deprecated
default CreateContainerCmd withCpuShares(Integer cpuShares)

Deprecated.

withCpusetCpus

@Deprecated
default CreateContainerCmd withCpusetCpus(String cpusetCpus)

Deprecated.

withCpusetMems

@Deprecated
default CreateContainerCmd withCpusetMems(String cpusetMems)

Deprecated.

withDevices

@Deprecated
default CreateContainerCmd withDevices(Device... devices)

Deprecated.

withDevices

@Deprecated
default CreateContainerCmd withDevices(List<Device> devices)

Deprecated.

Add host devices to the container

withDns

@Deprecated
default CreateContainerCmd withDns(String... dns)

Deprecated.

Set custom DNS servers

withDns

@Deprecated
default CreateContainerCmd withDns(List<String> dns)

Deprecated.

Set custom DNS servers

withDnsSearch

@Deprecated
default CreateContainerCmd withDnsSearch(String... dnsSearch)

Deprecated.

Set custom DNS search domains

withDnsSearch

@Deprecated
default CreateContainerCmd withDnsSearch(List<String> dnsSearch)

Deprecated.

Set custom DNS search domains

withLogConfig

@Deprecated
default CreateContainerCmd withLogConfig(LogConfig logConfig)

Deprecated.

withLxcConf

@Deprecated
default CreateContainerCmd withLxcConf(LxcConf... lxcConf)

Deprecated.

withLxcConf

@Deprecated
default CreateContainerCmd withLxcConf(List<LxcConf> lxcConf)

Deprecated.

withOomKillDisable

@Deprecated
default CreateContainerCmd withOomKillDisable(Boolean oomKillDisable)

Deprecated.

withPidMode

@Deprecated
default CreateContainerCmd withPidMode(String pidMode)

Deprecated.

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

withReadonlyRootfs

@Deprecated
default CreateContainerCmd withReadonlyRootfs(Boolean readonlyRootfs)

Deprecated.

withRestartPolicy

@Deprecated
default CreateContainerCmd withRestartPolicy(RestartPolicy restartPolicy)

Deprecated.

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

withUlimits

@Deprecated
default CreateContainerCmd withUlimits(Ulimit... ulimits)

Deprecated.

withUlimits

@Deprecated
default CreateContainerCmd withUlimits(List<Ulimit> ulimits)

Deprecated.

exec

CreateContainerResponse exec()
                      throws NotFoundException,
                             ConflictException

Specified by:

exec in interface SyncDockerCmd<CreateContainerResponse>

Throws:

NotFoundException - No such container

ConflictException - Named container already exists