CreateContainerCmd (docker-java 2.2.0 API)

All Superinterfaces:

AutoCloseable, 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

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CreateContainerCmd.Exec`

Method Summary

Methods
Modifier and Type	Method and Description
`CreateContainerResponse`	`exec()`
`Bind[]`	`getBinds()`
`Integer`	`getBlkioWeight()`
`Capability[]`	`getCapAdd()`
`Capability[]`	`getCapDrop()`
`String[]`	`getCmd()`
`Integer`	`getCpuPeriod()`
`String`	`getCpuset()`
`String`	`getCpusetMems()`
`int`	`getCpuShares()`
`Device[]`	`getDevices()`
`String[]`	`getDns()`
`String[]`	`getDnsSearch()`
`String`	`getDomainName()`
`String[]`	`getEntrypoint()`
`String[]`	`getEnv()`
`ExposedPort[]`	`getExposedPorts()`
`String[]`	`getExtraHosts()`
`String`	`getHostName()`
`String`	`getImage()`
`Map<String,String>`	`getLabels()`
`Link[]`	`getLinks()`
`LogConfig`	`getLogConfig()`
`LxcConf[]`	`getLxcConf()`
`String`	`getMacAddress()`
`long`	`getMemoryLimit()`
`long`	`getMemorySwap()`
`String`	`getName()`
`String`	`getNetworkMode()`
`String`	`getPidMode()`
`Ports`	`getPortBindings()`
`String[]`	`getPortSpecs()`
`RestartPolicy`	`getRestartPolicy()`
`Ulimit[]`	`getUlimits()`
`String`	`getUser()`
`Volume[]`	`getVolumes()`
`VolumesFrom[]`	`getVolumesFrom()`
`String`	`getWorkingDir()`
`boolean`	`isAttachStderr()`
`boolean`	`isAttachStdin()`
`boolean`	`isAttachStdout()`
`boolean`	`isNetworkDisabled()`
`Boolean`	`isOomKillDisable()`
`Boolean`	`isPrivileged()`
`Boolean`	`isPublishAllPorts()`
`boolean`	`isStdInOnce()`
`boolean`	`isStdinOpen()`
`boolean`	`isTty()`
`CreateContainerCmd`	`withAttachStderr(boolean attachStderr)`
`CreateContainerCmd`	`withAttachStdin(boolean attachStdin)`
`CreateContainerCmd`	`withAttachStdout(boolean attachStdout)`
`CreateContainerCmd`	`withBinds(Bind... binds)`
`CreateContainerCmd`	`withBlkioWeight(Integer blkioWeight)`
`CreateContainerCmd`	`withCapAdd(Capability... capAdd)` Add linux kernel capability to the container.
`CreateContainerCmd`	`withCapDrop(Capability... capDrop)` Drop linux kernel capability from the container.
`CreateContainerCmd`	`withCmd(String... cmd)`
`CreateContainerCmd`	`withContainerIDFile(String containerIDFile)`
`CreateContainerCmd`	`withCpuPeriod(Integer cpuPeriod)`
`CreateContainerCmd`	`withCpuset(String cpuset)`
`CreateContainerCmd`	`withCpusetMems(String cpusetMems)`
`CreateContainerCmd`	`withCpuShares(int cpuShares)`
`CreateContainerCmd`	`withDevices(Device... devices)` Add host devices to the container
`CreateContainerCmd`	`withDns(String... dns)` Set custom DNS servers
`CreateContainerCmd`	`withDnsSearch(String... dnsSearch)` Set custom DNS search domains
`CreateContainerCmd`	`withDomainName(String domainName)`
`CreateContainerCmd`	`withEntrypoint(String... entrypoint)`
`CreateContainerCmd`	`withEnv(String... env)`
`CreateContainerCmd`	`withExposedPorts(ExposedPort... exposedPorts)`
`CreateContainerCmd`	`withExtraHosts(String... extraHosts)` Add hostnames to /etc/hosts in the container
`CreateContainerCmd`	`withHostName(String hostName)`
`CreateContainerCmd`	`withImage(String image)`
`CreateContainerCmd`	`withLabels(Map<String,String> labels)`
`CreateContainerCmd`	`withLinks(Link... links)` Add link to another container.
`CreateContainerCmd`	`withLogConfig(LogConfig logConfig)`
`CreateContainerCmd`	`withLxcConf(LxcConf... lxcConf)`
`CreateContainerCmd`	`withMacAddress(String macAddress)`
`CreateContainerCmd`	`withMemoryLimit(long memoryLimit)`
`CreateContainerCmd`	`withMemorySwap(long memorySwap)`
`CreateContainerCmd`	`withName(String name)`
`CreateContainerCmd`	`withNetworkDisabled(boolean disableNetwork)`
`CreateContainerCmd`	`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.
`CreateContainerCmd`	`withOomKillDisable(Boolean oomKillDisable)`
`CreateContainerCmd`	`withPidMode(String pidMode)` Set the PID (Process) Namespace mode for the container, 'host': use the host's PID namespace inside the container
`CreateContainerCmd`	`withPortBindings(PortBinding... portBindings)` Add one or more `PortBinding`s.
`CreateContainerCmd`	`withPortBindings(Ports portBindings)` Add the port bindings that are contained in the given `Ports` object.
`CreateContainerCmd`	`withPortSpecs(String... portSpecs)`
`CreateContainerCmd`	`withPrivileged(boolean privileged)`
`CreateContainerCmd`	`withPublishAllPorts(boolean publishAllPorts)`
`CreateContainerCmd`	`withReadonlyRootfs(boolean readonlyRootfs)`
`CreateContainerCmd`	`withRestartPolicy(RestartPolicy restartPolicy)` Set custom `RestartPolicy` for the container.
`CreateContainerCmd`	`withStdInOnce(boolean stdInOnce)`
`CreateContainerCmd`	`withStdinOpen(boolean stdinOpen)`
`CreateContainerCmd`	`withTty(boolean tty)`
`CreateContainerCmd`	`withUlimits(Ulimit[] ulimits)`
`CreateContainerCmd`	`withUser(String user)`
`CreateContainerCmd`	`withVolumes(Volume... volumes)`
`CreateContainerCmd`	`withVolumesFrom(VolumesFrom... volumesFrom)`
`CreateContainerCmd`	`withWorkingDir(String workingDir)`

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

Method Detail

exec

CreateContainerResponse exec()
                             throws NotFoundException,
                                    ConflictException

Specified by:: exec in interface SyncDockerCmd<CreateContainerResponse>
Throws:: NotFoundException - No such container; ConflictException - Named container already exists

getBinds
```
Bind[] getBinds()
```

getCapAdd
```
Capability[] getCapAdd()
```

getCapDrop
```
Capability[] getCapDrop()
```

getCmd
```
String[] getCmd()
```

getCpuset
```
String getCpuset()
```

getCpuShares
```
int getCpuShares()
```

getCpuPeriod
```
Integer getCpuPeriod()
```
Since:

1.19

getCpusetMems
```
String getCpusetMems()
```
Since:

1.19

getBlkioWeight
```
Integer getBlkioWeight()
```
Since:

1.19

isOomKillDisable
```
Boolean isOomKillDisable()
```
Since:

1.19

getDevices
```
Device[] getDevices()
```

getDns
```
String[] getDns()
```

getDnsSearch
```
String[] getDnsSearch()
```

getEntrypoint
```
String[] getEntrypoint()
```

getEnv
```
String[] getEnv()
```

getExposedPorts
```
ExposedPort[] getExposedPorts()
```

getExtraHosts
```
String[] getExtraHosts()
```

getHostName
```
String getHostName()
```

getDomainName
```
String getDomainName()
```

getImage
```
String getImage()
```

getLinks
```
Link[] getLinks()
```

getLxcConf
```
LxcConf[] getLxcConf()
```

getLogConfig
```
LogConfig getLogConfig()
```

getMacAddress
```
String getMacAddress()
```

getMemoryLimit
```
long getMemoryLimit()
```

getMemorySwap
```
long getMemorySwap()
```

getName
```
String getName()
```

getNetworkMode
```
String getNetworkMode()
```

getPortBindings
```
Ports getPortBindings()
```

getPortSpecs
```
String[] getPortSpecs()
```

getRestartPolicy
```
RestartPolicy getRestartPolicy()
```

getUser
```
String getUser()
```

getVolumes
```
Volume[] getVolumes()
```

getVolumesFrom
```
VolumesFrom[] getVolumesFrom()
```

getWorkingDir
```
String getWorkingDir()
```

getUlimits
```
Ulimit[] getUlimits()
```

isAttachStderr
```
boolean isAttachStderr()
```

isAttachStdin
```
boolean isAttachStdin()
```

isAttachStdout
```
boolean isAttachStdout()
```

isNetworkDisabled
```
boolean isNetworkDisabled()
```

isPrivileged
```
Boolean isPrivileged()
```

isPublishAllPorts
```
Boolean isPublishAllPorts()
```

isStdInOnce
```
boolean isStdInOnce()
```

isStdinOpen
```
boolean isStdinOpen()
```

isTty
```
boolean isTty()
```

getPidMode
```
@CheckForNull
String getPidMode()
```

withAttachStderr

CreateContainerCmd withAttachStderr(boolean attachStderr)

withAttachStdin

CreateContainerCmd withAttachStdin(boolean attachStdin)

withAttachStdout

CreateContainerCmd withAttachStdout(boolean attachStdout)

withBinds

CreateContainerCmd withBinds(Bind... binds)

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.

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.

withCmd

CreateContainerCmd withCmd(String... cmd)

withCpuset

CreateContainerCmd withCpuset(String cpuset)

withCpuShares

CreateContainerCmd withCpuShares(int cpuShares)

withCpuPeriod

CreateContainerCmd withCpuPeriod(Integer cpuPeriod)

Since:: 1.19

withCpusetMems

CreateContainerCmd withCpusetMems(String cpusetMems)

Since:: 1.19

withBlkioWeight

CreateContainerCmd withBlkioWeight(Integer blkioWeight)

Since:: 1.19

withOomKillDisable

CreateContainerCmd withOomKillDisable(Boolean oomKillDisable)

Since:: 1.19

withDevices

CreateContainerCmd withDevices(Device... devices)

Add host devices to the container

withNetworkDisabled

CreateContainerCmd withNetworkDisabled(boolean disableNetwork)

withDns

CreateContainerCmd withDns(String... dns)

Set custom DNS servers

withDnsSearch

CreateContainerCmd withDnsSearch(String... dnsSearch)

Set custom DNS search domains

withEntrypoint

CreateContainerCmd withEntrypoint(String... entrypoint)

withEnv

CreateContainerCmd withEnv(String... env)

withExposedPorts

CreateContainerCmd withExposedPorts(ExposedPort... exposedPorts)

withExtraHosts

CreateContainerCmd withExtraHosts(String... extraHosts)

Add hostnames to /etc/hosts in the container

withHostName

CreateContainerCmd withHostName(String hostName)

withDomainName

CreateContainerCmd withDomainName(String domainName)

withImage

CreateContainerCmd withImage(String image)

withLabels

CreateContainerCmd withLabels(Map<String,String> labels)

withLinks

CreateContainerCmd withLinks(Link... links)

Add link to another container.

withLxcConf

CreateContainerCmd withLxcConf(LxcConf... lxcConf)

withLogConfig

CreateContainerCmd withLogConfig(LogConfig logConfig)

withMemoryLimit

CreateContainerCmd withMemoryLimit(long memoryLimit)

withMemorySwap

CreateContainerCmd withMemorySwap(long memorySwap)

withName

CreateContainerCmd withName(String name)

withNetworkMode
```
CreateContainerCmd 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.

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(Ports portBindings)
```
Add the port bindings that are contained in the given Ports object.

See Also:
withPortBindings(PortBinding...)

withPortSpecs

CreateContainerCmd withPortSpecs(String... portSpecs)

withPrivileged

CreateContainerCmd withPrivileged(boolean privileged)

withPublishAllPorts

CreateContainerCmd withPublishAllPorts(boolean publishAllPorts)

withRestartPolicy
```
CreateContainerCmd withRestartPolicy(RestartPolicy restartPolicy)
```
Set custom RestartPolicy for the container. Defaults to RestartPolicy.noRestart()

withStdInOnce

CreateContainerCmd withStdInOnce(boolean stdInOnce)

withStdinOpen

CreateContainerCmd withStdinOpen(boolean stdinOpen)

withTty

CreateContainerCmd withTty(boolean tty)

withUser

CreateContainerCmd withUser(String user)

withVolumes

CreateContainerCmd withVolumes(Volume... volumes)

withVolumesFrom

CreateContainerCmd withVolumesFrom(VolumesFrom... volumesFrom)

withWorkingDir

CreateContainerCmd withWorkingDir(String workingDir)

withMacAddress

CreateContainerCmd withMacAddress(String macAddress)

withUlimits

CreateContainerCmd withUlimits(Ulimit[] ulimits)

withReadonlyRootfs

CreateContainerCmd withReadonlyRootfs(boolean readonlyRootfs)

withContainerIDFile

CreateContainerCmd withContainerIDFile(String containerIDFile)

withPidMode
```
CreateContainerCmd withPidMode(String pidMode)
```
Set the PID (Process) Namespace mode for the container, 'host': use the host's PID namespace inside the container

getLabels
```
Map<String,String> getLabels()
```
Returns:

Interface CreateContainerCmd

Nested Class Summary

Method Summary

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

Method Detail

exec

getBinds

getCapAdd

getCapDrop

getCmd

getCpuset

getCpuShares

getCpuPeriod

getCpusetMems

getBlkioWeight

isOomKillDisable

getDevices

getDns

getDnsSearch

getEntrypoint

getEnv

getExposedPorts

getExtraHosts

getHostName

getDomainName

getImage

getLinks

getLxcConf

getLogConfig

getMacAddress

getMemoryLimit

getMemorySwap

getName

getNetworkMode

getPortBindings

getPortSpecs

getRestartPolicy

getUser

getVolumes

getVolumesFrom

getWorkingDir

getUlimits

isAttachStderr

isAttachStdin

isAttachStdout

isNetworkDisabled

isPrivileged

isPublishAllPorts

isStdInOnce

isStdinOpen

isTty

getPidMode

withAttachStderr

withAttachStdin

withAttachStdout

withBinds

withCapAdd

withCapDrop

withCmd

withCpuset

withCpuShares

withCpuPeriod

withCpusetMems

withBlkioWeight

withOomKillDisable

withDevices

withNetworkDisabled

withDns

withDnsSearch

withEntrypoint

withEnv

withExposedPorts

withExtraHosts

withHostName

withDomainName

withImage

withLabels

withLinks

withLxcConf

withLogConfig