com.github.dockerjava.api.command

Interface StartContainerCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<Void>

All Known Implementing Classes:

StartContainerCmdImpl

public interface StartContainerCmd
extends DockerCmd<Void>

Start a container. TODO: Almost all methods are deprecated as they have corresponding siblings in CreateContainerCmd now.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StartContainerCmd.Exec

Method Summary

Methods

Modifier and Type	Method and Description
Void	exec()
Bind[]	getBinds()
Capability[]	getCapAdd()
Capability[]	getCapDrop()
String	getContainerId()
Device[]	getDevices()
String[]	getDns()
String[]	getDnsSearch()
String[]	getExtraHosts()
Link[]	getLinks()
LxcConf[]	getLxcConf()
String	getNetworkMode()
Ports	getPortBindings()
RestartPolicy	getRestartPolicy()
String	getVolumesFrom()
Boolean	isPrivileged()
Boolean	isPublishAllPorts()
StartContainerCmd	withBinds(Bind... binds) Deprecated.
StartContainerCmd	withCapAdd(Capability... capAdd) Deprecated.
StartContainerCmd	withCapDrop(Capability... capDrop) Deprecated.
StartContainerCmd	withContainerId(String containerId) Deprecated.
StartContainerCmd	withDevices(Device... devices) Deprecated.
StartContainerCmd	withDns(String... dns) Deprecated.
StartContainerCmd	withDnsSearch(String... dnsSearch) Deprecated.
StartContainerCmd	withExtraHosts(String... extraHosts) Deprecated.
StartContainerCmd	withLinks(Link... links) Deprecated.
StartContainerCmd	withLxcConf(LxcConf... lxcConf) Deprecated.
StartContainerCmd	withNetworkMode(String networkMode) Deprecated.
StartContainerCmd	withPortBindings(PortBinding... portBindings) Deprecated.
StartContainerCmd	withPortBindings(Ports portBindings) Deprecated.
StartContainerCmd	withPrivileged(Boolean privileged) Deprecated.
StartContainerCmd	withPublishAllPorts(Boolean publishAllPorts) Deprecated.
StartContainerCmd	withRestartPolicy(RestartPolicy restartPolicy) Deprecated.
StartContainerCmd	withVolumesFrom(String volumesFrom) Deprecated.

Methods inherited from interface java.io.Closeable

close

Method Detail

getBinds

Bind[] getBinds()

getLinks

Link[] getLinks()

getLxcConf

LxcConf[] getLxcConf()

getPortBindings

Ports getPortBindings()

isPublishAllPorts

Boolean isPublishAllPorts()

isPrivileged

Boolean isPrivileged()

getDns

String[] getDns()

getDnsSearch

String[] getDnsSearch()

getVolumesFrom

String getVolumesFrom()

getContainerId

String getContainerId()

getNetworkMode

String getNetworkMode()

getDevices

Device[] getDevices()

getExtraHosts

String[] getExtraHosts()

getRestartPolicy

RestartPolicy getRestartPolicy()

getCapAdd

Capability[] getCapAdd()

getCapDrop

Capability[] getCapDrop()

withBinds

@Deprecated
StartContainerCmd withBinds(Bind... binds)

Deprecated.

withLinks

@Deprecated
StartContainerCmd withLinks(Link... links)

Deprecated.

Add link to another container.

withLxcConf

@Deprecated
StartContainerCmd withLxcConf(LxcConf... lxcConf)

Deprecated.

withPortBindings

@Deprecated
StartContainerCmd withPortBindings(Ports portBindings)

Deprecated.

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

See Also:

withPortBindings(PortBinding...)

withPortBindings

@Deprecated
StartContainerCmd withPortBindings(PortBinding... portBindings)

Deprecated.

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

withPrivileged

@Deprecated
StartContainerCmd withPrivileged(Boolean privileged)

Deprecated.

withPublishAllPorts

@Deprecated
StartContainerCmd withPublishAllPorts(Boolean publishAllPorts)

Deprecated.

withDns

@Deprecated
StartContainerCmd withDns(String... dns)

Deprecated.

Set custom DNS servers

withDnsSearch

@Deprecated
StartContainerCmd withDnsSearch(String... dnsSearch)

Deprecated.

Set custom DNS search domains

withVolumesFrom

@Deprecated
StartContainerCmd withVolumesFrom(String volumesFrom)

Deprecated.

withContainerId

@Deprecated
StartContainerCmd withContainerId(String containerId)

Deprecated.

withNetworkMode

@Deprecated
StartContainerCmd 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.

withDevices

@Deprecated
StartContainerCmd withDevices(Device... devices)

Deprecated.

Add host devices to the container

withExtraHosts

@Deprecated
StartContainerCmd withExtraHosts(String... extraHosts)

Deprecated.

Add hostnames to /etc/hosts in the container

withRestartPolicy

@Deprecated
StartContainerCmd withRestartPolicy(RestartPolicy restartPolicy)

Deprecated.

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

withCapAdd

@Deprecated
StartContainerCmd 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.

withCapDrop

@Deprecated
StartContainerCmd 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.

exec

Void exec()
          throws NotFoundException,
                 NotModifiedException

Specified by:

exec in interface DockerCmd<Void>

Throws:

NotFoundException - No such container

NotModifiedException - Container already started