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()
java.lang.Boolean	getArgsEscaped()
AuthConfig	getAuthConfig()
Bind[]	getBinds() Deprecated.
Capability[]	getCapAdd() Deprecated.
Capability[]	getCapDrop() Deprecated.
java.lang.String[]	getCmd()
java.lang.String	getDomainName()
java.lang.String[]	getEntrypoint()
java.lang.String[]	getEnv()
ExposedPort[]	getExposedPorts()
java.lang.String[]	getExtraHosts() Deprecated.
HealthCheck	getHealthcheck()
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() Deprecated.
java.lang.String	getMacAddress()
java.lang.Long	getMemory() Deprecated.
java.lang.Long	getMemorySwap() Deprecated.
java.lang.String	getName()
java.lang.String	getNetworkMode() Deprecated.
java.util.List<java.lang.String>	getOnBuild()
Ports	getPortBindings() Deprecated.
java.lang.String[]	getPortSpecs()
java.lang.Boolean	getPrivileged() Deprecated.
java.lang.Boolean	getPublishAllPorts() Deprecated.
java.lang.String	getStopSignal()
java.lang.Integer	getStopTimeout()
java.lang.String	getUser()
Volume[]	getVolumes()
VolumesFrom[]	getVolumesFrom() Deprecated.
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	withArgsEscaped(java.lang.Boolean argsEscaped)
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) Deprecated.
CreateContainerCmd	withBinds(java.util.List<Bind> binds) Deprecated.
CreateContainerCmd	withCapAdd(Capability... capAdd) Deprecated.
CreateContainerCmd	withCapAdd(java.util.List<Capability> capAdd) Deprecated.
CreateContainerCmd	withCapDrop(Capability... capDrop) Deprecated.
CreateContainerCmd	withCapDrop(java.util.List<Capability> capDrop) Deprecated.
CreateContainerCmd	withCmd(java.util.List<java.lang.String> cmd)
CreateContainerCmd	withCmd(java.lang.String... cmd)
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) Deprecated.
CreateContainerCmd	withExtraHosts(java.lang.String... extraHosts) Deprecated.
CreateContainerCmd	withHealthcheck(HealthCheck healthCheck)
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) Deprecated.
CreateContainerCmd	withLinks(java.util.List<Link> links) Deprecated.
CreateContainerCmd	withMacAddress(java.lang.String macAddress)
CreateContainerCmd	withMemory(java.lang.Long memory) Deprecated.
CreateContainerCmd	withMemorySwap(java.lang.Long memorySwap) Deprecated.
CreateContainerCmd	withName(java.lang.String name)
CreateContainerCmd	withNetworkDisabled(java.lang.Boolean disableNetwork)
CreateContainerCmd	withNetworkMode(java.lang.String networkMode) Deprecated.
CreateContainerCmd	withOnBuild(java.util.List<java.lang.String> onBuild)
CreateContainerCmd	withPortBindings(java.util.List<PortBinding> portBindings) Deprecated.
CreateContainerCmd	withPortBindings(PortBinding... portBindings) Deprecated.
CreateContainerCmd	withPortBindings(Ports portBindings) Deprecated.
CreateContainerCmd	withPortSpecs(java.util.List<java.lang.String> portSpecs)
CreateContainerCmd	withPortSpecs(java.lang.String... portSpecs)
CreateContainerCmd	withPrivileged(java.lang.Boolean privileged) Deprecated.
CreateContainerCmd	withPublishAllPorts(java.lang.Boolean publishAllPorts) Deprecated.
CreateContainerCmd	withStdInOnce(java.lang.Boolean stdInOnce)
CreateContainerCmd	withStdinOpen(java.lang.Boolean stdinOpen)
CreateContainerCmd	withStopSignal(java.lang.String stopSignal)
CreateContainerCmd	withStopTimeout(java.lang.Integer stopTimeout)
CreateContainerCmd	withTty(java.lang.Boolean tty)
CreateContainerCmd	withUser(java.lang.String user)
CreateContainerCmd	withVolumes(java.util.List<Volume> volumes)
CreateContainerCmd	withVolumes(Volume... volumes)
CreateContainerCmd	withVolumesFrom(java.util.List<VolumesFrom> volumesFrom) Deprecated.
CreateContainerCmd	withVolumesFrom(VolumesFrom... volumesFrom) Deprecated.
CreateContainerCmd	withWorkingDir(java.lang.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
java.util.List<java.lang.String> getAliases()

getBinds

@Deprecated
 @CheckForNull
Bind[] getBinds()

Deprecated.

withBinds

@Deprecated
CreateContainerCmd withBinds(Bind... binds)

Deprecated.

withBinds

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

Deprecated.

withAliases

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

Add network-scoped alias for the container

Parameters:

aliases - on ore more aliases

withAliases

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

Add network-scoped alias for the container

Parameters:

aliases - on ore more aliases

getCmd

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

withCmd

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

withCmd

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

getHealthcheck

@CheckForNull
HealthCheck getHealthcheck()

withHealthcheck

CreateContainerCmd withHealthcheck(HealthCheck healthCheck)

getArgsEscaped

@CheckForNull
java.lang.Boolean getArgsEscaped()

withArgsEscaped

CreateContainerCmd withArgsEscaped(java.lang.Boolean argsEscaped)

getDomainName

@CheckForNull
java.lang.String getDomainName()

withDomainName

CreateContainerCmd withDomainName(java.lang.String domainName)

getEntrypoint

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

withEntrypoint

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

withEntrypoint

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

getEnv

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

withEnv

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

withEnv

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

getExposedPorts

@CheckForNull
ExposedPort[] getExposedPorts()

withExposedPorts

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

withExposedPorts

CreateContainerCmd withExposedPorts(ExposedPort... exposedPorts)

getStopSignal

@CheckForNull
java.lang.String getStopSignal()

withStopSignal

CreateContainerCmd withStopSignal(java.lang.String stopSignal)

getStopTimeout

@CheckForNull
java.lang.Integer getStopTimeout()

withStopTimeout

CreateContainerCmd withStopTimeout(java.lang.Integer stopTimeout)

getHostName

@CheckForNull
java.lang.String getHostName()

withHostName

CreateContainerCmd withHostName(java.lang.String hostName)

getImage

@CheckForNull
java.lang.String getImage()

withImage

CreateContainerCmd withImage(java.lang.String image)

getIpv4Address

@CheckForNull
java.lang.String getIpv4Address()

withIpv4Address

CreateContainerCmd withIpv4Address(java.lang.String ipv4Address)

getLinks

@Deprecated
 @CheckForNull
Link[] getLinks()

Deprecated.

withLinks

@Deprecated
CreateContainerCmd withLinks(Link... links)

Deprecated.

Add link to another container.

withLinks

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

Deprecated.

Add link to another container.

getIpv6Address

@CheckForNull
java.lang.String getIpv6Address()

withIpv6Address

CreateContainerCmd withIpv6Address(java.lang.String ipv6Address)

getLabels

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

withLabels

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

getMacAddress

@CheckForNull
java.lang.String getMacAddress()

withMacAddress

CreateContainerCmd withMacAddress(java.lang.String macAddress)

getMemory

@Deprecated
 @CheckForNull
java.lang.Long getMemory()

Deprecated.

withMemory

@Deprecated
CreateContainerCmd withMemory(java.lang.Long memory)

Deprecated.

getMemorySwap

@Deprecated
 @CheckForNull
java.lang.Long getMemorySwap()

Deprecated.

withMemorySwap

@Deprecated
CreateContainerCmd withMemorySwap(java.lang.Long memorySwap)

Deprecated.

getName

@CheckForNull
java.lang.String getName()

getNetworkMode

@Deprecated
 @CheckForNull
java.lang.String getNetworkMode()

Deprecated.

withNetworkMode

@Deprecated
CreateContainerCmd withNetworkMode(java.lang.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
Ports getPortBindings()

Deprecated.

withPortBindings

@Deprecated
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
CreateContainerCmd withPortBindings(java.util.List<PortBinding> portBindings)

Deprecated.

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

withPortBindings

@Deprecated
CreateContainerCmd withPortBindings(Ports portBindings)

Deprecated.

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

See Also:

withPortBindings(PortBinding...)

withName

CreateContainerCmd withName(java.lang.String name)

getPortSpecs

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

withPortSpecs

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

withPortSpecs

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

getPrivileged

@Deprecated
 @CheckForNull
java.lang.Boolean getPrivileged()

Deprecated.

withPrivileged

@Deprecated
CreateContainerCmd withPrivileged(java.lang.Boolean privileged)

Deprecated.

getUser

@CheckForNull
java.lang.String getUser()

withUser

CreateContainerCmd withUser(java.lang.String user)

getVolumes

@CheckForNull
Volume[] getVolumes()

withVolumes

CreateContainerCmd withVolumes(Volume... volumes)

withVolumes

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

getVolumesFrom

@Deprecated
 @CheckForNull
VolumesFrom[] getVolumesFrom()

Deprecated.

withVolumesFrom

@Deprecated
CreateContainerCmd withVolumesFrom(VolumesFrom... volumesFrom)

Deprecated.

withVolumesFrom

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

Deprecated.

getWorkingDir

@CheckForNull
java.lang.String getWorkingDir()

withWorkingDir

CreateContainerCmd withWorkingDir(java.lang.String workingDir)

isAttachStderr

@CheckForNull
java.lang.Boolean isAttachStderr()

withAttachStderr

CreateContainerCmd withAttachStderr(java.lang.Boolean attachStderr)

isAttachStdin

@CheckForNull
java.lang.Boolean isAttachStdin()

withAttachStdin

CreateContainerCmd withAttachStdin(java.lang.Boolean attachStdin)

isAttachStdout

@CheckForNull
java.lang.Boolean isAttachStdout()

withAttachStdout

CreateContainerCmd withAttachStdout(java.lang.Boolean attachStdout)

isNetworkDisabled

@CheckForNull
java.lang.Boolean isNetworkDisabled()

withNetworkDisabled

CreateContainerCmd withNetworkDisabled(java.lang.Boolean disableNetwork)

isStdInOnce

@CheckForNull
java.lang.Boolean isStdInOnce()

withStdInOnce

CreateContainerCmd withStdInOnce(java.lang.Boolean stdInOnce)

isStdinOpen

@CheckForNull
java.lang.Boolean isStdinOpen()

withStdinOpen

CreateContainerCmd withStdinOpen(java.lang.Boolean stdinOpen)

isTty

@CheckForNull
java.lang.Boolean isTty()

withTty

CreateContainerCmd withTty(java.lang.Boolean tty)

getPublishAllPorts

@Deprecated
 @CheckForNull
java.lang.Boolean getPublishAllPorts()

Deprecated.

withPublishAllPorts

@Deprecated
CreateContainerCmd withPublishAllPorts(java.lang.Boolean publishAllPorts)

Deprecated.

getExtraHosts

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

Deprecated.

withExtraHosts

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

Deprecated.

Add hostnames to /etc/hosts in the container

withExtraHosts

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

Deprecated.

Add hostnames to /etc/hosts in the container

getCapAdd

@CheckForNull
 @Deprecated
Capability[] getCapAdd()

Deprecated.

withCapAdd

@Deprecated
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
CreateContainerCmd withCapAdd(java.util.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
Capability[] getCapDrop()

Deprecated.

withCapDrop

@Deprecated
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
CreateContainerCmd withCapDrop(java.util.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
java.util.List<java.lang.String> getOnBuild()

withOnBuild

CreateContainerCmd withOnBuild(java.util.List<java.lang.String> onBuild)

getHostConfig

@CheckForNull
HostConfig getHostConfig()

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