com.github.dockerjava.api.command

Interface RemoveContainerCmd

All Superinterfaces:

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

All Known Implementing Classes:

RemoveContainerCmdImpl

public interface RemoveContainerCmd
extends SyncDockerCmd<java.lang.Void>

Remove a container.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RemoveContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.lang.Void	exec()
java.lang.String	getContainerId()
java.lang.Boolean	hasForceEnabled()
java.lang.Boolean	hasRemoveVolumesEnabled()
RemoveContainerCmd	withContainerId(java.lang.String containerId)
RemoveContainerCmd	withForce(java.lang.Boolean force)
RemoveContainerCmd	withRemoveVolumes(java.lang.Boolean removeVolumes)

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

close

Method Detail

getContainerId

@CheckForNull
java.lang.String getContainerId()

hasRemoveVolumesEnabled

@CheckForNull
java.lang.Boolean hasRemoveVolumesEnabled()

hasForceEnabled

@CheckForNull
java.lang.Boolean hasForceEnabled()

withContainerId

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

withRemoveVolumes

RemoveContainerCmd withRemoveVolumes(java.lang.Boolean removeVolumes)

withForce

RemoveContainerCmd withForce(java.lang.Boolean force)

exec

java.lang.Void exec()
             throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<java.lang.Void>

Throws:

NotFoundException - No such container