com.github.dockerjava.api.command

Interface CommitCmd

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DockerCmd<java.lang.String>, SyncDockerCmd<java.lang.String>

public interface CommitCmd
extends SyncDockerCmd<java.lang.String>

Create a new image from a container's changes. Returns the new image ID.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CommitCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.lang.String	exec()
java.lang.String	getAuthor()
java.lang.String	getContainerId()
java.lang.String[]	getEnv()
ExposedPorts	getExposedPorts()
java.lang.String	getHostname()
java.util.Map<java.lang.String,java.lang.String>	getLabels()
java.lang.Integer	getMemory()
java.lang.Integer	getMemorySwap()
java.lang.String	getMessage()
java.lang.String[]	getPortSpecs()
java.lang.String	getRepository()
java.lang.String	getTag()
java.lang.String	getUser()
Volumes	getVolumes()
java.lang.String	getWorkingDir()
java.lang.Boolean	hasPauseEnabled()
java.lang.Boolean	isOpenStdin()
java.lang.Boolean	isStdinOnce()
java.lang.Boolean	isTty()
CommitCmd	withAttachStderr(java.lang.Boolean attachStderr)
CommitCmd	withAttachStdin(java.lang.Boolean attachStdin)
CommitCmd	withAttachStdout(java.lang.Boolean attachStdout)
CommitCmd	withAuthor(java.lang.String author)
CommitCmd	withCmd(java.lang.String... cmd)
CommitCmd	withContainerId(java.lang.String containerId)
CommitCmd	withDisableNetwork(java.lang.Boolean disableNetwork)
CommitCmd	withEnv(java.lang.String... env)
CommitCmd	withExposedPorts(ExposedPorts exposedPorts)
CommitCmd	withHostname(java.lang.String hostname)
CommitCmd	withLabels(java.util.Map<java.lang.String,java.lang.String> labels)
CommitCmd	withMemory(java.lang.Integer memory)
CommitCmd	withMemorySwap(java.lang.Integer memorySwap)
CommitCmd	withMessage(java.lang.String message)
CommitCmd	withOpenStdin(java.lang.Boolean openStdin)
CommitCmd	withPause(java.lang.Boolean pause)
CommitCmd	withPortSpecs(java.lang.String... portSpecs)
CommitCmd	withRepository(java.lang.String repository)
CommitCmd	withStdinOnce(java.lang.Boolean stdinOnce)
CommitCmd	withTag(java.lang.String tag)
CommitCmd	withTty(java.lang.Boolean tty)
CommitCmd	withUser(java.lang.String user)
CommitCmd	withVolumes(Volumes volumes)
CommitCmd	withWorkingDir(java.lang.String workingDir)

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

close

Method Detail

getAuthor

@CheckForNull
java.lang.String getAuthor()

getContainerId

@CheckForNull
java.lang.String getContainerId()

getEnv

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

getExposedPorts

@CheckForNull
ExposedPorts getExposedPorts()

getHostname

@CheckForNull
java.lang.String getHostname()

getLabels

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

getMemory

@CheckForNull
java.lang.Integer getMemory()

getMemorySwap

@CheckForNull
java.lang.Integer getMemorySwap()

getMessage

@CheckForNull
java.lang.String getMessage()

getPortSpecs

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

getRepository

@CheckForNull
java.lang.String getRepository()

getTag

@CheckForNull
java.lang.String getTag()

getUser

@CheckForNull
java.lang.String getUser()

getVolumes

@CheckForNull
Volumes getVolumes()

getWorkingDir

@CheckForNull
java.lang.String getWorkingDir()

hasPauseEnabled

@CheckForNull
java.lang.Boolean hasPauseEnabled()

isOpenStdin

@CheckForNull
java.lang.Boolean isOpenStdin()

isStdinOnce

@CheckForNull
java.lang.Boolean isStdinOnce()

isTty

@CheckForNull
java.lang.Boolean isTty()

withAttachStderr

CommitCmd withAttachStderr(java.lang.Boolean attachStderr)

withAttachStdin

CommitCmd withAttachStdin(java.lang.Boolean attachStdin)

withAttachStdout

CommitCmd withAttachStdout(java.lang.Boolean attachStdout)

withAuthor

CommitCmd withAuthor(java.lang.String author)

withCmd

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

withContainerId

CommitCmd withContainerId(@Nonnull
                          java.lang.String containerId)

withDisableNetwork

CommitCmd withDisableNetwork(java.lang.Boolean disableNetwork)

withEnv

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

withExposedPorts

CommitCmd withExposedPorts(ExposedPorts exposedPorts)

withHostname

CommitCmd withHostname(java.lang.String hostname)

withLabels

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

Since:

1.19

withMemory

CommitCmd withMemory(java.lang.Integer memory)

withMemorySwap

CommitCmd withMemorySwap(java.lang.Integer memorySwap)

withMessage

CommitCmd withMessage(java.lang.String message)

withOpenStdin

CommitCmd withOpenStdin(java.lang.Boolean openStdin)

withPause

CommitCmd withPause(java.lang.Boolean pause)

withPortSpecs

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

withRepository

CommitCmd withRepository(java.lang.String repository)

withStdinOnce

CommitCmd withStdinOnce(java.lang.Boolean stdinOnce)

withTag

CommitCmd withTag(java.lang.String tag)

withTty

CommitCmd withTty(java.lang.Boolean tty)

withUser

CommitCmd withUser(java.lang.String user)

withVolumes

CommitCmd withVolumes(Volumes volumes)

withWorkingDir

CommitCmd withWorkingDir(java.lang.String workingDir)

exec

java.lang.String exec()
               throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<java.lang.String>

Throws:

NotFoundException - No such container