com.github.dockerjava.api.command

Interface WaitContainerCmd

All Superinterfaces:

AsyncDockerCmd<WaitContainerCmd,WaitResponse>, AutoCloseable, Closeable, DockerCmd<Void>

public interface WaitContainerCmd
extends AsyncDockerCmd<WaitContainerCmd,WaitResponse>

Wait a container Block until container stops, then returns its exit code

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WaitContainerCmd.Exec

Method Summary

Modifier and Type	Method and Description
<T extends ResultCallback<WaitResponse>> T	exec(T resultCallback)
WaitContainerCondition	getCondition() Defaults to WaitContainerCondition.NOT_RUNNING if omitted or empty.
String	getContainerId()
default WaitContainerResultCallback	start()
WaitContainerCmd	withCondition(WaitContainerCondition condition)
WaitContainerCmd	withContainerId(String containerId)

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

close

Method Detail

getContainerId

@CheckForNull
String getContainerId()

withContainerId

WaitContainerCmd withContainerId(@Nonnull
                                 String containerId)

getCondition

@Nullable
WaitContainerCondition getCondition()

Defaults to WaitContainerCondition.NOT_RUNNING if omitted or empty.

Since:

RemoteApiVersion#VERSION_1_30

withCondition

WaitContainerCmd withCondition(@Nullable
                               WaitContainerCondition condition)

Since:

RemoteApiVersion#VERSION_1_30

exec

<T extends ResultCallback<WaitResponse>> T exec(T resultCallback)

Specified by:

exec in interface AsyncDockerCmd<WaitContainerCmd,WaitResponse>

Throws:

NotFoundException - container not found

start

default WaitContainerResultCallback start()

Specified by:

start in interface AsyncDockerCmd<WaitContainerCmd,WaitResponse>