com.github.dockerjava.core.command

Class CreateContainerCmdImpl

java.lang.Object

com.github.dockerjava.core.command.AbstrDockerCmd<CreateContainerCmd,CreateContainerResponse>

com.github.dockerjava.core.command.CreateContainerCmdImpl

All Implemented Interfaces:

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

public class CreateContainerCmdImpl
extends AbstrDockerCmd<CreateContainerCmd,CreateContainerResponse>
implements CreateContainerCmd

Creates a new container. `/containers/create`

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateContainerCmdImpl.NetworkingConfig

Nested classes/interfaces inherited from interface com.github.dockerjava.api.command.CreateContainerCmd

CreateContainerCmd.Exec

Field Summary

Fields inherited from class com.github.dockerjava.core.command.AbstrDockerCmd

execution

Constructor Summary

Constructors

Constructor and Description
CreateContainerCmdImpl(CreateContainerCmd.Exec exec, AuthConfig authConfig, java.lang.String image)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
CreateContainerResponse	exec()
java.util.List<java.lang.String>	getAliases()
java.lang.Boolean	getArgsEscaped()
AuthConfig	getAuthConfig()
java.lang.String[]	getCmd()
java.lang.String	getDomainName()
java.lang.String[]	getEntrypoint()
java.lang.String[]	getEnv()
ExposedPort[]	getExposedPorts()
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()
java.lang.String	getMacAddress()
java.lang.String	getName()
java.util.List<java.lang.String>	getOnBuild()
java.lang.String[]	getPortSpecs()
java.lang.String	getStopSignal()
java.lang.Integer	getStopTimeout()
java.lang.String	getUser()
Volume[]	getVolumes()
java.lang.String	getWorkingDir()
int	hashCode()
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()
java.lang.String	toString()
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
CreateContainerCmdImpl	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	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)
CreateContainerCmdImpl	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	withMacAddress(java.lang.String macAddress)
CreateContainerCmd	withName(java.lang.String name)
CreateContainerCmd	withNetworkDisabled(java.lang.Boolean disableNetwork)
CreateContainerCmdImpl	withOnBuild(java.util.List<java.lang.String> onBuild)
CreateContainerCmd	withPortSpecs(java.util.List<java.lang.String> portSpecs)
CreateContainerCmd	withPortSpecs(java.lang.String... portSpecs)
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	withWorkingDir(java.lang.String workingDir)

Methods inherited from class com.github.dockerjava.core.command.AbstrDockerCmd

close, registryAuth

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

close

Constructor Detail

CreateContainerCmdImpl

public CreateContainerCmdImpl(CreateContainerCmd.Exec exec,
                              AuthConfig authConfig,
                              java.lang.String image)

Method Detail

getAuthConfig

public AuthConfig getAuthConfig()

Specified by:

getAuthConfig in interface CreateContainerCmd

withAuthConfig

public CreateContainerCmd withAuthConfig(AuthConfig authConfig)

Description copied from interface: CreateContainerCmd

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

Specified by:

withAuthConfig in interface CreateContainerCmd

Parameters:

authConfig - The optional auth config

getAliases

public java.util.List<java.lang.String> getAliases()

Specified by:

getAliases in interface CreateContainerCmd

withAliases

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

Description copied from interface: CreateContainerCmd

Add network-scoped alias for the container

Specified by:

withAliases in interface CreateContainerCmd

Parameters:

aliases - on ore more aliases

withAliases

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

Description copied from interface: CreateContainerCmd

Add network-scoped alias for the container

Specified by:

withAliases in interface CreateContainerCmd

Parameters:

aliases - on ore more aliases

getCmd

public java.lang.String[] getCmd()

Specified by:

getCmd in interface CreateContainerCmd

withCmd

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

Specified by:

withCmd in interface CreateContainerCmd

withCmd

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

Specified by:

withCmd in interface CreateContainerCmd

getHealthcheck

@CheckForNull
public HealthCheck getHealthcheck()

Specified by:

getHealthcheck in interface CreateContainerCmd

withHealthcheck

public CreateContainerCmdImpl withHealthcheck(HealthCheck healthcheck)

Specified by:

withHealthcheck in interface CreateContainerCmd

getArgsEscaped

public java.lang.Boolean getArgsEscaped()

Specified by:

getArgsEscaped in interface CreateContainerCmd

withArgsEscaped

public CreateContainerCmdImpl withArgsEscaped(java.lang.Boolean argsEscaped)

Specified by:

withArgsEscaped in interface CreateContainerCmd

getDomainName

public java.lang.String getDomainName()

Specified by:

getDomainName in interface CreateContainerCmd

withDomainName

public CreateContainerCmd withDomainName(java.lang.String domainName)

Specified by:

withDomainName in interface CreateContainerCmd

getEntrypoint

public java.lang.String[] getEntrypoint()

Specified by:

getEntrypoint in interface CreateContainerCmd

withEntrypoint

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

Specified by:

withEntrypoint in interface CreateContainerCmd

withEntrypoint

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

Specified by:

withEntrypoint in interface CreateContainerCmd

getEnv

public java.lang.String[] getEnv()

Specified by:

getEnv in interface CreateContainerCmd

withEnv

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

Specified by:

withEnv in interface CreateContainerCmd

withEnv

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

Specified by:

withEnv in interface CreateContainerCmd

getExposedPorts

public ExposedPort[] getExposedPorts()

Specified by:

getExposedPorts in interface CreateContainerCmd

withExposedPorts

public CreateContainerCmd withExposedPorts(ExposedPort... exposedPorts)

Specified by:

withExposedPorts in interface CreateContainerCmd

withExposedPorts

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

Specified by:

withExposedPorts in interface CreateContainerCmd

getStopSignal

public java.lang.String getStopSignal()

Specified by:

getStopSignal in interface CreateContainerCmd

See Also:

stopSignal

withStopSignal

public CreateContainerCmd withStopSignal(java.lang.String stopSignal)

Specified by:

withStopSignal in interface CreateContainerCmd

getStopTimeout

public java.lang.Integer getStopTimeout()

Specified by:

getStopTimeout in interface CreateContainerCmd

withStopTimeout

public CreateContainerCmd withStopTimeout(java.lang.Integer stopTimeout)

Specified by:

withStopTimeout in interface CreateContainerCmd

getHostName

public java.lang.String getHostName()

Specified by:

getHostName in interface CreateContainerCmd

withHostName

public CreateContainerCmd withHostName(java.lang.String hostName)

Specified by:

withHostName in interface CreateContainerCmd

getImage

public java.lang.String getImage()

Specified by:

getImage in interface CreateContainerCmd

withImage

public CreateContainerCmd withImage(java.lang.String image)

Specified by:

withImage in interface CreateContainerCmd

getLabels

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

Specified by:

getLabels in interface CreateContainerCmd

withLabels

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

Specified by:

withLabels in interface CreateContainerCmd

getMacAddress

public java.lang.String getMacAddress()

Specified by:

getMacAddress in interface CreateContainerCmd

withMacAddress

public CreateContainerCmd withMacAddress(java.lang.String macAddress)

Specified by:

withMacAddress in interface CreateContainerCmd

getName

public java.lang.String getName()

Specified by:

getName in interface CreateContainerCmd

withName

public CreateContainerCmd withName(java.lang.String name)

Specified by:

withName in interface CreateContainerCmd

getPortSpecs

public java.lang.String[] getPortSpecs()

Specified by:

getPortSpecs in interface CreateContainerCmd

withPortSpecs

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

Specified by:

withPortSpecs in interface CreateContainerCmd

withPortSpecs

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

Specified by:

withPortSpecs in interface CreateContainerCmd

getUser

public java.lang.String getUser()

Specified by:

getUser in interface CreateContainerCmd

withUser

public CreateContainerCmd withUser(java.lang.String user)

Specified by:

withUser in interface CreateContainerCmd

isAttachStderr

public java.lang.Boolean isAttachStderr()

Specified by:

isAttachStderr in interface CreateContainerCmd

withAttachStderr

public CreateContainerCmd withAttachStderr(java.lang.Boolean attachStderr)

Specified by:

withAttachStderr in interface CreateContainerCmd

isAttachStdin

public java.lang.Boolean isAttachStdin()

Specified by:

isAttachStdin in interface CreateContainerCmd

withAttachStdin

public CreateContainerCmd withAttachStdin(java.lang.Boolean attachStdin)

Specified by:

withAttachStdin in interface CreateContainerCmd

isAttachStdout

public java.lang.Boolean isAttachStdout()

Specified by:

isAttachStdout in interface CreateContainerCmd

withAttachStdout

public CreateContainerCmd withAttachStdout(java.lang.Boolean attachStdout)

Specified by:

withAttachStdout in interface CreateContainerCmd

getVolumes

public Volume[] getVolumes()

Specified by:

getVolumes in interface CreateContainerCmd

withVolumes

public CreateContainerCmd withVolumes(Volume... volumes)

Specified by:

withVolumes in interface CreateContainerCmd

withVolumes

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

Specified by:

withVolumes in interface CreateContainerCmd

getWorkingDir

public java.lang.String getWorkingDir()

Specified by:

getWorkingDir in interface CreateContainerCmd

withWorkingDir

public CreateContainerCmd withWorkingDir(java.lang.String workingDir)

Specified by:

withWorkingDir in interface CreateContainerCmd

isNetworkDisabled

public java.lang.Boolean isNetworkDisabled()

Specified by:

isNetworkDisabled in interface CreateContainerCmd

withNetworkDisabled

public CreateContainerCmd withNetworkDisabled(java.lang.Boolean disableNetwork)

Specified by:

withNetworkDisabled in interface CreateContainerCmd

isStdInOnce

public java.lang.Boolean isStdInOnce()

Specified by:

isStdInOnce in interface CreateContainerCmd

withStdInOnce

public CreateContainerCmd withStdInOnce(java.lang.Boolean stdInOnce)

Specified by:

withStdInOnce in interface CreateContainerCmd

isStdinOpen

public java.lang.Boolean isStdinOpen()

Specified by:

isStdinOpen in interface CreateContainerCmd

withStdinOpen

public CreateContainerCmd withStdinOpen(java.lang.Boolean stdinOpen)

Specified by:

withStdinOpen in interface CreateContainerCmd

isTty

public java.lang.Boolean isTty()

Specified by:

isTty in interface CreateContainerCmd

withTty

public CreateContainerCmd withTty(java.lang.Boolean tty)

Specified by:

withTty in interface CreateContainerCmd

getHostConfig

public HostConfig getHostConfig()

Specified by:

getHostConfig in interface CreateContainerCmd

withHostConfig

public CreateContainerCmd withHostConfig(HostConfig hostConfig)

Specified by:

withHostConfig in interface CreateContainerCmd

getIpv4Address

public java.lang.String getIpv4Address()

Specified by:

getIpv4Address in interface CreateContainerCmd

withIpv4Address

public CreateContainerCmd withIpv4Address(java.lang.String ipv4Address)

Specified by:

withIpv4Address in interface CreateContainerCmd

getIpv6Address

public java.lang.String getIpv6Address()

Specified by:

getIpv6Address in interface CreateContainerCmd

withIpv6Address

public CreateContainerCmd withIpv6Address(java.lang.String ipv6Address)

Specified by:

withIpv6Address in interface CreateContainerCmd

getOnBuild

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

Specified by:

getOnBuild in interface CreateContainerCmd

withOnBuild

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

Specified by:

withOnBuild in interface CreateContainerCmd

exec

public CreateContainerResponse exec()
                             throws NotFoundException,
                                    ConflictException

Specified by:

exec in interface CreateContainerCmd

Specified by:

exec in interface SyncDockerCmd<CreateContainerResponse>

Overrides:

exec in class AbstrDockerCmd<CreateContainerCmd,CreateContainerResponse>

Throws:

NotFoundException - No such container

ConflictException - Named container already exists

toString

public java.lang.String toString()

Overrides:

toString in class AbstrDockerCmd<CreateContainerCmd,CreateContainerResponse>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object