CommitCmd (docker-java 3.0.8 API)

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<String>, SyncDockerCmd<String>

All Known Implementing Classes:

CommitCmdImpl
```
public interface CommitCmd
extends SyncDockerCmd<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

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`CommitCmd.Exec`

Method Summary

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

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

Method Detail

getAuthor
```
@CheckForNull
String getAuthor()
```

getContainerId
```
@CheckForNull
String getContainerId()
```

getEnv
```
@CheckForNull
String[] getEnv()
```

getExposedPorts

@CheckForNull
ExposedPorts getExposedPorts()

getHostname
```
@CheckForNull
String getHostname()
```

getLabels

@CheckForNull
Map<String,String> getLabels()

getMemory
```
@CheckForNull
Integer getMemory()
```

getMemorySwap
```
@CheckForNull
Integer getMemorySwap()
```

getMessage
```
@CheckForNull
String getMessage()
```

getPortSpecs
```
@CheckForNull
String[] getPortSpecs()
```

getRepository
```
@CheckForNull
String getRepository()
```

getTag
```
@CheckForNull
String getTag()
```

getUser
```
@CheckForNull
String getUser()
```

getVolumes
```
@CheckForNull
Volumes getVolumes()
```

getWorkingDir
```
@CheckForNull
String getWorkingDir()
```

hasPauseEnabled

@CheckForNull
Boolean hasPauseEnabled()

isOpenStdin
```
@CheckForNull
Boolean isOpenStdin()
```

isStdinOnce
```
@CheckForNull
Boolean isStdinOnce()
```

isTty
```
@CheckForNull
Boolean isTty()
```

withAttachStderr

CommitCmd withAttachStderr(Boolean attachStderr)

withAttachStdin

CommitCmd withAttachStdin(Boolean attachStdin)

withAttachStdout

CommitCmd withAttachStdout(Boolean attachStdout)

withAuthor
```
CommitCmd withAuthor(String author)
```

withCmd
```
CommitCmd withCmd(String... cmd)
```

withContainerId

CommitCmd withContainerId(@Nonnull
                          String containerId)

withDisableNetwork

CommitCmd withDisableNetwork(Boolean disableNetwork)

withEnv
```
CommitCmd withEnv(String... env)
```

withExposedPorts

CommitCmd withExposedPorts(ExposedPorts exposedPorts)

withHostname

CommitCmd withHostname(String hostname)

withLabels

CommitCmd withLabels(Map<String,String> labels)

Since:: 1.19

withMemory
```
CommitCmd withMemory(Integer memory)
```

withMemorySwap

CommitCmd withMemorySwap(Integer memorySwap)

withMessage
```
CommitCmd withMessage(String message)
```

withOpenStdin

CommitCmd withOpenStdin(Boolean openStdin)

withPause
```
CommitCmd withPause(Boolean pause)
```

withPortSpecs

CommitCmd withPortSpecs(String... portSpecs)

withRepository

CommitCmd withRepository(String repository)

withStdinOnce

CommitCmd withStdinOnce(Boolean stdinOnce)

withTag
```
CommitCmd withTag(String tag)
```

withTty
```
CommitCmd withTty(Boolean tty)
```

withUser
```
CommitCmd withUser(String user)
```

withVolumes

CommitCmd withVolumes(Volumes volumes)

withWorkingDir

CommitCmd withWorkingDir(String workingDir)

exec
```
String exec()
     throws NotFoundException
```
Specified by:

exec in interface SyncDockerCmd<String>

Throws:

NotFoundException - No such container

Interface CommitCmd

Nested Class Summary

Method Summary

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

Method Detail

getAuthor

getContainerId

getEnv

getExposedPorts

getHostname

getLabels

getMemory

getMemorySwap

getMessage

getPortSpecs

getRepository

getTag

getUser

getVolumes

getWorkingDir

hasPauseEnabled

isOpenStdin

isStdinOnce

isTty

withAttachStderr

withAttachStdin

withAttachStdout

withAuthor

withCmd

withContainerId

withDisableNetwork

withEnv

withExposedPorts

withHostname

withLabels

withMemory

withMemorySwap

withMessage

withOpenStdin

withPause

withPortSpecs

withRepository

withStdinOnce

withTag

withTty

withUser

withVolumes

withWorkingDir

exec