com.github.dockerjava.api.command

Interface KillContainerCmd

All Superinterfaces:

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

All Known Implementing Classes:

KillContainerCmdImpl

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

Kill a running container.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	KillContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.lang.Void	exec()
java.lang.String	getContainerId()
java.lang.String	getSignal()
KillContainerCmd	withContainerId(java.lang.String containerId)
KillContainerCmd	withSignal(java.lang.String signal)

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

close

Method Detail

getContainerId

@CheckForNull
java.lang.String getContainerId()

getSignal

@CheckForNull
java.lang.String getSignal()

withContainerId

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

withSignal

KillContainerCmd withSignal(java.lang.String signal)

exec

java.lang.Void exec()
             throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<java.lang.Void>

Throws:

NotFoundException - No such container