CreateContainerCmd (docker-java 1.2.0 API)

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<CreateContainerResponse>

All Known Implementing Classes:

CreateContainerCmdImpl
```
public interface CreateContainerCmd
extends DockerCmd<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()`
`Capability[]`	`getCapAdd()`
`Capability[]`	`getCapDrop()`
`String[]`	`getCmd()`
`String`	`getCpuset()`
`int`	`getCpuShares()`
`Device[]`	`getDevices()`
`String[]`	`getDns()`
`String[]`	`getDnsSearch()`
`String[]`	`getEntrypoint()`
`String[]`	`getEnv()`
`ExposedPort[]`	`getExposedPorts()`
`String[]`	`getExtraHosts()`
`HostConfig`	`getHostConfig()`
`String`	`getHostName()`
`String`	`getImage()`
`Link[]`	`getLinks()`
`LxcConf[]`	`getLxcConf()`
`long`	`getMemoryLimit()`
`long`	`getMemorySwap()`
`String`	`getName()`
`String`	`getNetworkMode()`
`Ports`	`getPortBindings()`
`String[]`	`getPortSpecs()`
`RestartPolicy`	`getRestartPolicy()`
`String`	`getUser()`
`Volume[]`	`getVolumes()`
`VolumesFrom[]`	`getVolumesFrom()`
`String`	`getWorkingDir()`
`boolean`	`isAttachStderr()`
`boolean`	`isAttachStdin()`
`boolean`	`isAttachStdout()`
`boolean`	`isDisableNetwork()`
`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`	`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`	`withCpuset(String cpuset)`
`CreateContainerCmd`	`withCpuShares(int cpuShares)`
`CreateContainerCmd`	`withDevices(Device... devices)` Add host devices to the container
`CreateContainerCmd`	`withDisableNetwork(boolean disableNetwork)`
`CreateContainerCmd`	`withDns(String... dns)` Set custom DNS servers
`CreateContainerCmd`	`withDnsSearch(String... dnsSearch)` Set custom DNS search domains
`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`	`withHostConfig(HostConfig hostConfig)`
`CreateContainerCmd`	`withHostName(String hostName)`
`CreateContainerCmd`	`withImage(String image)`
`CreateContainerCmd`	`withLinks(Link... links)` Add link to another container.
`CreateContainerCmd`	`withLxcConf(LxcConf... lxcConf)`
`CreateContainerCmd`	`withMemoryLimit(long memoryLimit)`
`CreateContainerCmd`	`withMemorySwap(long memorySwap)`
`CreateContainerCmd`	`withName(String name)`
`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`	`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`	`withRestartPolicy(RestartPolicy restartPolicy)` Set custom `RestartPolicy` for the container.
`CreateContainerCmd`	`withStdInOnce(boolean stdInOnce)`
`CreateContainerCmd`	`withStdinOpen(boolean stdinOpen)`
`CreateContainerCmd`	`withTty(boolean tty)`
`CreateContainerCmd`	`withUser(String user)`
`CreateContainerCmd`	`withVolumes(Volume... volumes)`
`CreateContainerCmd`	`withVolumesFrom(VolumesFrom... volumesFrom)`
`CreateContainerCmd`	`withWorkingDir(String workingDir)`

Methods inherited from interface java.io.Closeable
close

Method Detail

exec

CreateContainerResponse exec()
                             throws NotFoundException,
                                    ConflictException

Specified by:: exec in interface DockerCmd<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()
```

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

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

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

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

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

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

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

getHostConfig
```
HostConfig getHostConfig()
```

getHostName
```
String getHostName()
```

getImage
```
String getImage()
```

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

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

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()
```

isAttachStderr
```
boolean isAttachStderr()
```

isAttachStdin
```
boolean isAttachStdin()
```

isAttachStdout
```
boolean isAttachStdout()
```

isDisableNetwork
```
boolean isDisableNetwork()
```

isPrivileged
```
Boolean isPrivileged()
```

isPublishAllPorts
```
Boolean isPublishAllPorts()
```

isStdInOnce
```
boolean isStdInOnce()
```

isStdinOpen
```
boolean isStdinOpen()
```

isTty
```
boolean isTty()
```

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)

withDevices

CreateContainerCmd withDevices(Device... devices)

Add host devices to the container

withDisableNetwork

CreateContainerCmd withDisableNetwork(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

withHostConfig

CreateContainerCmd withHostConfig(HostConfig hostConfig)

withHostName

CreateContainerCmd withHostName(String hostName)

withImage

CreateContainerCmd withImage(String image)

withLinks

CreateContainerCmd withLinks(Link... links)

Add link to another container.

withLxcConf

CreateContainerCmd withLxcConf(LxcConf... lxcConf)

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)

Interface CreateContainerCmd

Nested Class Summary

Method Summary

Methods inherited from interface java.io.Closeable

Method Detail

exec

getBinds

getCapAdd

getCapDrop

getCmd

getCpuset

getCpuShares

getDevices

getDns

getDnsSearch

getEntrypoint

getEnv

getExposedPorts

getExtraHosts

getHostConfig

getHostName

getImage

getLinks

getLxcConf

getMemoryLimit

getMemorySwap

getName

getNetworkMode

getPortBindings

getPortSpecs

getRestartPolicy

getUser

getVolumes

getVolumesFrom

getWorkingDir

isAttachStderr

isAttachStdin

isAttachStdout

isDisableNetwork

isPrivileged

isPublishAllPorts

isStdInOnce

isStdinOpen

isTty

withAttachStderr

withAttachStdin

withAttachStdout

withBinds

withCapAdd

withCapDrop

withCmd

withCpuset

withCpuShares

withDevices

withDisableNetwork

withDns

withDnsSearch

withEntrypoint

withEnv

withExposedPorts

withExtraHosts

withHostConfig

withHostName

withImage

withLinks

withLxcConf

withMemoryLimit

withMemorySwap

withName

withNetworkMode

withPortBindings

withPortBindings

withPortSpecs

withPrivileged

withPublishAllPorts

withRestartPolicy

withStdInOnce

withStdinOpen

withTty

withUser