com.github.dockerjava.api.command

Interface RemoveSwarmNodeCmd

All Superinterfaces:

AutoCloseable, Closeable, DockerCmd<Void>, SyncDockerCmd<Void>

public interface RemoveSwarmNodeCmd
extends SyncDockerCmd<Void>

Remove a swarmNode.

Since:

RemoteApiVersion#VERSION_1_24

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RemoveSwarmNodeCmd.Exec

Method Summary

Modifier and Type	Method and Description
Void	exec()
String	getSwarmNodeId()
Boolean	hasForceEnabled()
RemoveSwarmNodeCmd	withForce(Boolean force)
RemoveSwarmNodeCmd	withSwarmNodeId(String swarmNodeId)

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

close

Method Detail

getSwarmNodeId

@CheckForNull
String getSwarmNodeId()

hasForceEnabled

@CheckForNull
Boolean hasForceEnabled()

withSwarmNodeId

RemoveSwarmNodeCmd withSwarmNodeId(@Nonnull
                                   String swarmNodeId)

withForce

RemoveSwarmNodeCmd withForce(Boolean force)

exec

Void exec()
   throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<Void>

Throws:

NotFoundException - No such swarmNode