com.github.dockerjava.api.command

Interface StopContainerCmd

All Superinterfaces:

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

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

Stop a running container.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StopContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.lang.Void	exec()
java.lang.String	getContainerId()
java.lang.Integer	getTimeout()
StopContainerCmd	withContainerId(java.lang.String containerId)
StopContainerCmd	withTimeout(java.lang.Integer timeout)

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

close

Method Detail

getContainerId

@CheckForNull
java.lang.String getContainerId()

getTimeout

@CheckForNull
java.lang.Integer getTimeout()

withContainerId

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

withTimeout

StopContainerCmd withTimeout(java.lang.Integer timeout)

exec

java.lang.Void exec()
             throws NotFoundException,
                    NotModifiedException

Specified by:

exec in interface SyncDockerCmd<java.lang.Void>

Throws:

NotFoundException - No such container

NotModifiedException - Container already stopped