com.github.dockerjava.api.command

Interface CreateContainerCmd

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DockerCmd<CreateContainerResponse>, SyncDockerCmd<CreateContainerResponse>

All Known Implementing Classes:

CreateContainerCmdImpl

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()
java.util.List<java.lang.String>	getAliases()
AuthConfig	getAuthConfig()
Bind[]	getBinds()
java.lang.Integer	getBlkioWeight()
Capability[]	getCapAdd()
Capability[]	getCapDrop()
java.lang.String	getCgroupParent()
java.lang.String[]	getCmd()
java.lang.Integer	getCpuPeriod()
java.lang.String	getCpusetCpus()
java.lang.String	getCpusetMems()
java.lang.Integer	getCpuShares()
Device[]	getDevices()
java.lang.String[]	getDns()
java.lang.String[]	getDnsSearch()
java.lang.String	getDomainName()
java.lang.String[]	getEntrypoint()
java.lang.String[]	getEnv()
ExposedPort[]	getExposedPorts()
java.lang.String[]	getExtraHosts()
HostConfig	getHostConfig()
java.lang.String	getHostName()
java.lang.String	getImage()
java.lang.String	getIpv4Address()
java.lang.String	getIpv6Address()
java.util.Map<java.lang.String,java.lang.String>	getLabels()
Link[]	getLinks()
LogConfig	getLogConfig()
LxcConf[]	getLxcConf()
java.lang.String	getMacAddress()
java.lang.Long	getMemory()
java.lang.Long	getMemorySwap()
java.lang.String	getName()
java.lang.String	getNetworkMode()
java.lang.Boolean	getOomKillDisable()
java.lang.String	getPidMode()
Ports	getPortBindings()
java.lang.String[]	getPortSpecs()
java.lang.Boolean	getPrivileged()
java.lang.Boolean	getPublishAllPorts()
java.lang.Boolean	getReadonlyRootfs()
RestartPolicy	getRestartPolicy()
java.lang.String	getStopSignal()
Ulimit[]	getUlimits()
java.lang.String	getUser()
Volume[]	getVolumes()
VolumesFrom[]	getVolumesFrom()
java.lang.String	getWorkingDir()
java.lang.Boolean	isAttachStderr()
java.lang.Boolean	isAttachStdin()
java.lang.Boolean	isAttachStdout()
java.lang.Boolean	isNetworkDisabled()
java.lang.Boolean	isStdInOnce()
java.lang.Boolean	isStdinOpen()
java.lang.Boolean	isTty()
CreateContainerCmd	withAliases(java.util.List<java.lang.String> aliases) Add network-scoped alias for the container
CreateContainerCmd	withAliases(java.lang.String... aliases) Add network-scoped alias for the container
CreateContainerCmd	withAttachStderr(java.lang.Boolean attachStderr)
CreateContainerCmd	withAttachStdin(java.lang.Boolean attachStdin)
CreateContainerCmd	withAttachStdout(java.lang.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.
CreateContainerCmd	withBinds(Bind... binds)
CreateContainerCmd	withBinds(java.util.List<Bind> binds)
CreateContainerCmd	withBlkioWeight(java.lang.Integer blkioWeight)
CreateContainerCmd	withCapAdd(Capability... capAdd) Add linux kernel capability to the container.
CreateContainerCmd	withCapAdd(java.util.List<Capability> capAdd) Add linux kernel capability to the container.
CreateContainerCmd	withCapDrop(Capability... capDrop) Drop linux kernel capability from the container.
CreateContainerCmd	withCapDrop(java.util.List<Capability> capDrop) Drop linux kernel capability from the container.
CreateContainerCmd	withCgroupParent(java.lang.String cgroupParent)
CreateContainerCmd	withCmd(java.util.List<java.lang.String> cmd)
CreateContainerCmd	withCmd(java.lang.String... cmd)
CreateContainerCmd	withContainerIDFile(java.lang.String containerIDFile)
CreateContainerCmd	withCpuPeriod(java.lang.Integer cpuPeriod)
CreateContainerCmd	withCpusetCpus(java.lang.String cpusetCpus)
CreateContainerCmd	withCpusetMems(java.lang.String cpusetMems)
CreateContainerCmd	withCpuShares(java.lang.Integer cpuShares)
CreateContainerCmd	withDevices(Device... devices) Add host devices to the container
CreateContainerCmd	withDevices(java.util.List<Device> devices) Add host devices to the container
CreateContainerCmd	withDns(java.util.List<java.lang.String> dns) Set custom DNS servers
CreateContainerCmd	withDns(java.lang.String... dns) Set custom DNS servers
CreateContainerCmd	withDnsSearch(java.util.List<java.lang.String> dnsSearch) Set custom DNS search domains
CreateContainerCmd	withDnsSearch(java.lang.String... dnsSearch) Set custom DNS search domains
CreateContainerCmd	withDomainName(java.lang.String domainName)
CreateContainerCmd	withEntrypoint(java.util.List<java.lang.String> entrypoint)
CreateContainerCmd	withEntrypoint(java.lang.String... entrypoint)
CreateContainerCmd	withEnv(java.util.List<java.lang.String> env)
CreateContainerCmd	withEnv(java.lang.String... env)
CreateContainerCmd	withExposedPorts(ExposedPort... exposedPorts)
CreateContainerCmd	withExposedPorts(java.util.List<ExposedPort> exposedPorts)
CreateContainerCmd	withExtraHosts(java.util.List<java.lang.String> extraHosts) Add hostnames to /etc/hosts in the container
CreateContainerCmd	withExtraHosts(java.lang.String... extraHosts) Add hostnames to /etc/hosts in the container
CreateContainerCmd	withHostConfig(HostConfig hostConfig)
CreateContainerCmd	withHostName(java.lang.String hostName)
CreateContainerCmd	withImage(java.lang.String image)
CreateContainerCmd	withIpv4Address(java.lang.String ipv4Address)
CreateContainerCmd	withIpv6Address(java.lang.String ipv6Address)
CreateContainerCmd	withLabels(java.util.Map<java.lang.String,java.lang.String> labels)
CreateContainerCmd	withLinks(Link... links) Add link to another container.
CreateContainerCmd	withLinks(java.util.List<Link> links) Add link to another container.
CreateContainerCmd	withLogConfig(LogConfig logConfig)
CreateContainerCmd	withLxcConf(java.util.List<LxcConf> lxcConf)
CreateContainerCmd	withLxcConf(LxcConf... lxcConf)
CreateContainerCmd	withMacAddress(java.lang.String macAddress)
CreateContainerCmd	withMemory(java.lang.Long memory)
CreateContainerCmd	withMemorySwap(java.lang.Long memorySwap)
CreateContainerCmd	withName(java.lang.String name)
CreateContainerCmd	withNetworkDisabled(java.lang.Boolean disableNetwork)
CreateContainerCmd	withNetworkMode(java.lang.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.
CreateContainerCmd	withOomKillDisable(java.lang.Boolean oomKillDisable)
CreateContainerCmd	withPidMode(java.lang.String pidMode) Set the PID (Process) Namespace mode for the container, 'host': use the host's PID namespace inside the container
CreateContainerCmd	withPortBindings(java.util.List<PortBinding> portBindings) Add one or more PortBindings.
CreateContainerCmd	withPortBindings(PortBinding... portBindings) Add one or more PortBindings.
CreateContainerCmd	withPortBindings(Ports portBindings) Add the port bindings that are contained in the given Ports object.
CreateContainerCmd	withPortSpecs(java.util.List<java.lang.String> portSpecs)
CreateContainerCmd	withPortSpecs(java.lang.String... portSpecs)
CreateContainerCmd	withPrivileged(java.lang.Boolean privileged)
CreateContainerCmd	withPublishAllPorts(java.lang.Boolean publishAllPorts)
CreateContainerCmd	withReadonlyRootfs(java.lang.Boolean readonlyRootfs)
CreateContainerCmd	withRestartPolicy(RestartPolicy restartPolicy) Set custom RestartPolicy for the container.
CreateContainerCmd	withStdInOnce(java.lang.Boolean stdInOnce)
CreateContainerCmd	withStdinOpen(java.lang.Boolean stdinOpen)
CreateContainerCmd	withStopSignal(java.lang.String stopSignal)
CreateContainerCmd	withTty(java.lang.Boolean tty)
CreateContainerCmd	withUlimits(java.util.List<Ulimit> ulimits)
CreateContainerCmd	withUlimits(Ulimit... ulimits)
CreateContainerCmd	withUser(java.lang.String user)
CreateContainerCmd	withVolumes(java.util.List<Volume> volumes)
CreateContainerCmd	withVolumes(Volume... volumes)
CreateContainerCmd	withVolumesFrom(java.util.List<VolumesFrom> volumesFrom)
CreateContainerCmd	withVolumesFrom(VolumesFrom... volumesFrom)
CreateContainerCmd	withWorkingDir(java.lang.String workingDir)

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

close

Method Detail

getAuthConfig

@CheckForNull
AuthConfig getAuthConfig()

getAliases

@CheckForNull
java.util.List<java.lang.String> getAliases()

getBinds

@CheckForNull
Bind[] getBinds()

getBlkioWeight

@CheckForNull
java.lang.Integer getBlkioWeight()

Since:

1.19

getCapAdd

@CheckForNull
Capability[] getCapAdd()

getCapDrop

@CheckForNull
Capability[] getCapDrop()

getCmd

@CheckForNull
java.lang.String[] getCmd()

getCpuPeriod

@CheckForNull
java.lang.Integer getCpuPeriod()

Since:

1.19

getCpusetCpus

@CheckForNull
java.lang.String getCpusetCpus()

getCpusetMems

@CheckForNull
java.lang.String getCpusetMems()

Since:

1.19

getCpuShares

@CheckForNull
java.lang.Integer getCpuShares()

getDevices

@CheckForNull
Device[] getDevices()

getDns

@CheckForNull
java.lang.String[] getDns()

getDnsSearch

@CheckForNull
java.lang.String[] getDnsSearch()

getDomainName

@CheckForNull
java.lang.String getDomainName()

getEntrypoint

@CheckForNull
java.lang.String[] getEntrypoint()

getEnv

@CheckForNull
java.lang.String[] getEnv()

getExposedPorts

@CheckForNull
ExposedPort[] getExposedPorts()

getStopSignal

@CheckForNull
java.lang.String getStopSignal()

getExtraHosts

@CheckForNull
java.lang.String[] getExtraHosts()

getHostName

@CheckForNull
java.lang.String getHostName()

getImage

@CheckForNull
java.lang.String getImage()

getIpv4Address

@CheckForNull
java.lang.String getIpv4Address()

getIpv6Address

@CheckForNull
java.lang.String getIpv6Address()

getLabels

@CheckForNull
java.util.Map<java.lang.String,java.lang.String> getLabels()

getLinks

@CheckForNull
Link[] getLinks()

getLogConfig

@CheckForNull
LogConfig getLogConfig()

getLxcConf

@CheckForNull
LxcConf[] getLxcConf()

getMacAddress

@CheckForNull
java.lang.String getMacAddress()

getMemory

@CheckForNull
java.lang.Long getMemory()

getMemorySwap

@CheckForNull
java.lang.Long getMemorySwap()

getName

@CheckForNull
java.lang.String getName()

getNetworkMode

@CheckForNull
java.lang.String getNetworkMode()

getPortBindings

@CheckForNull
Ports getPortBindings()

getPortSpecs

@CheckForNull
java.lang.String[] getPortSpecs()

getRestartPolicy

@CheckForNull
RestartPolicy getRestartPolicy()

getUlimits

@CheckForNull
Ulimit[] getUlimits()

getUser

@CheckForNull
java.lang.String getUser()

getVolumes

@CheckForNull
Volume[] getVolumes()

getVolumesFrom

@CheckForNull
VolumesFrom[] getVolumesFrom()

getWorkingDir

@CheckForNull
java.lang.String getWorkingDir()

isAttachStderr

@CheckForNull
java.lang.Boolean isAttachStderr()

isAttachStdin

@CheckForNull
java.lang.Boolean isAttachStdin()

isAttachStdout

@CheckForNull
java.lang.Boolean isAttachStdout()

isNetworkDisabled

@CheckForNull
java.lang.Boolean isNetworkDisabled()

getOomKillDisable

@CheckForNull
java.lang.Boolean getOomKillDisable()

Since:

1.19

getPrivileged

@CheckForNull
java.lang.Boolean getPrivileged()

getPublishAllPorts

@CheckForNull
java.lang.Boolean getPublishAllPorts()

getReadonlyRootfs

@CheckForNull
java.lang.Boolean getReadonlyRootfs()

isStdInOnce

@CheckForNull
java.lang.Boolean isStdInOnce()

isStdinOpen

@CheckForNull
java.lang.Boolean isStdinOpen()

getPidMode

@CheckForNull
java.lang.String getPidMode()

getHostConfig

@CheckForNull
HostConfig getHostConfig()

getCgroupParent

@CheckForNull
java.lang.String getCgroupParent()

isTty

@CheckForNull
java.lang.Boolean isTty()

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

withAliases

CreateContainerCmd withAliases(java.lang.String... aliases)

Add network-scoped alias for the container

Parameters:

aliases - on ore more aliases

withAliases

CreateContainerCmd withAliases(java.util.List<java.lang.String> aliases)

Add network-scoped alias for the container

Parameters:

aliases - on ore more aliases

withAttachStderr

CreateContainerCmd withAttachStderr(java.lang.Boolean attachStderr)

withAttachStdin

CreateContainerCmd withAttachStdin(java.lang.Boolean attachStdin)

withAttachStdout

CreateContainerCmd withAttachStdout(java.lang.Boolean attachStdout)

withBinds

CreateContainerCmd withBinds(Bind... binds)

withBinds

CreateContainerCmd withBinds(java.util.List<Bind> binds)

withBlkioWeight

CreateContainerCmd withBlkioWeight(java.lang.Integer blkioWeight)

Since:

1.19

withCapAdd

CreateContainerCmd withCapAdd(Capability... capAdd)

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

withCapAdd

CreateContainerCmd withCapAdd(java.util.List<Capability> capAdd)

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

withCapDrop

CreateContainerCmd withCapDrop(Capability... capDrop)

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

withCapDrop

CreateContainerCmd withCapDrop(java.util.List<Capability> capDrop)

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

withCmd

CreateContainerCmd withCmd(java.lang.String... cmd)

withCmd

CreateContainerCmd withCmd(java.util.List<java.lang.String> cmd)

withContainerIDFile

CreateContainerCmd withContainerIDFile(java.lang.String containerIDFile)

withCpuPeriod

CreateContainerCmd withCpuPeriod(java.lang.Integer cpuPeriod)

Since:

1.19

withCpusetCpus

CreateContainerCmd withCpusetCpus(java.lang.String cpusetCpus)

withCpusetMems

CreateContainerCmd withCpusetMems(java.lang.String cpusetMems)

Since:

1.19

withCpuShares

CreateContainerCmd withCpuShares(java.lang.Integer cpuShares)

withDevices

CreateContainerCmd withDevices(Device... devices)

Add host devices to the container

withDevices

CreateContainerCmd withDevices(java.util.List<Device> devices)

Add host devices to the container

withDns

CreateContainerCmd withDns(java.lang.String... dns)

Set custom DNS servers

withDns

CreateContainerCmd withDns(java.util.List<java.lang.String> dns)

Set custom DNS servers

withDnsSearch

CreateContainerCmd withDnsSearch(java.lang.String... dnsSearch)

Set custom DNS search domains

withDnsSearch

CreateContainerCmd withDnsSearch(java.util.List<java.lang.String> dnsSearch)

Set custom DNS search domains

withDomainName

CreateContainerCmd withDomainName(java.lang.String domainName)

withEntrypoint

CreateContainerCmd withEntrypoint(java.lang.String... entrypoint)

withEntrypoint

CreateContainerCmd withEntrypoint(java.util.List<java.lang.String> entrypoint)

withEnv

CreateContainerCmd withEnv(java.lang.String... env)

withEnv

CreateContainerCmd withEnv(java.util.List<java.lang.String> env)

withExposedPorts

CreateContainerCmd withExposedPorts(ExposedPort... exposedPorts)

withStopSignal

CreateContainerCmd withStopSignal(java.lang.String stopSignal)

withExposedPorts

CreateContainerCmd withExposedPorts(java.util.List<ExposedPort> exposedPorts)

withExtraHosts

CreateContainerCmd withExtraHosts(java.lang.String... extraHosts)

Add hostnames to /etc/hosts in the container

withExtraHosts

CreateContainerCmd withExtraHosts(java.util.List<java.lang.String> extraHosts)

Add hostnames to /etc/hosts in the container

withHostName

CreateContainerCmd withHostName(java.lang.String hostName)

withImage

CreateContainerCmd withImage(java.lang.String image)

withIpv4Address

CreateContainerCmd withIpv4Address(java.lang.String ipv4Address)

withIpv6Address

CreateContainerCmd withIpv6Address(java.lang.String ipv6Address)

withLabels

CreateContainerCmd withLabels(java.util.Map<java.lang.String,java.lang.String> labels)

withLinks

CreateContainerCmd withLinks(Link... links)

Add link to another container.

withLinks

CreateContainerCmd withLinks(java.util.List<Link> links)

Add link to another container.

withLogConfig

CreateContainerCmd withLogConfig(LogConfig logConfig)

withLxcConf

CreateContainerCmd withLxcConf(LxcConf... lxcConf)

withLxcConf

CreateContainerCmd withLxcConf(java.util.List<LxcConf> lxcConf)

withMacAddress

CreateContainerCmd withMacAddress(java.lang.String macAddress)

withMemory

CreateContainerCmd withMemory(java.lang.Long memory)

withMemorySwap

CreateContainerCmd withMemorySwap(java.lang.Long memorySwap)

withName

CreateContainerCmd withName(java.lang.String name)

withNetworkDisabled

CreateContainerCmd withNetworkDisabled(java.lang.Boolean disableNetwork)

withNetworkMode

CreateContainerCmd withNetworkMode(java.lang.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.

withOomKillDisable

CreateContainerCmd withOomKillDisable(java.lang.Boolean oomKillDisable)

Since:

1.19

withPortBindings

CreateContainerCmd withPortBindings(PortBinding... portBindings)

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

withPortBindings

CreateContainerCmd withPortBindings(java.util.List<PortBinding> portBindings)

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

withPortBindings

CreateContainerCmd withPortBindings(Ports portBindings)

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

See Also:

withPortBindings(PortBinding...)

withPortSpecs

CreateContainerCmd withPortSpecs(java.lang.String... portSpecs)

withPortSpecs

CreateContainerCmd withPortSpecs(java.util.List<java.lang.String> portSpecs)

withPrivileged

CreateContainerCmd withPrivileged(java.lang.Boolean privileged)

withPublishAllPorts

CreateContainerCmd withPublishAllPorts(java.lang.Boolean publishAllPorts)

withReadonlyRootfs

CreateContainerCmd withReadonlyRootfs(java.lang.Boolean readonlyRootfs)

withRestartPolicy

CreateContainerCmd withRestartPolicy(RestartPolicy restartPolicy)

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

withStdInOnce

CreateContainerCmd withStdInOnce(java.lang.Boolean stdInOnce)

withStdinOpen

CreateContainerCmd withStdinOpen(java.lang.Boolean stdinOpen)

withTty

CreateContainerCmd withTty(java.lang.Boolean tty)

withUlimits

CreateContainerCmd withUlimits(Ulimit... ulimits)

withUlimits

CreateContainerCmd withUlimits(java.util.List<Ulimit> ulimits)

withUser

CreateContainerCmd withUser(java.lang.String user)

withVolumes

CreateContainerCmd withVolumes(Volume... volumes)

withVolumes

CreateContainerCmd withVolumes(java.util.List<Volume> volumes)

withVolumesFrom

CreateContainerCmd withVolumesFrom(VolumesFrom... volumesFrom)

withVolumesFrom

CreateContainerCmd withVolumesFrom(java.util.List<VolumesFrom> volumesFrom)

withWorkingDir

CreateContainerCmd withWorkingDir(java.lang.String workingDir)

withCgroupParent

CreateContainerCmd withCgroupParent(java.lang.String cgroupParent)

withPidMode

CreateContainerCmd withPidMode(java.lang.String pidMode)

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

withHostConfig

CreateContainerCmd withHostConfig(HostConfig hostConfig)

exec

CreateContainerResponse exec()
                      throws NotFoundException,
                             ConflictException

Specified by:

exec in interface SyncDockerCmd<CreateContainerResponse>

Throws:

NotFoundException - No such container

ConflictException - Named container already exists