Package org.jenkinsci.plugins.dockerbuildstep.cmd

Class RemoveCommand

java.lang.Object

org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

org.jenkinsci.plugins.dockerbuildstep.cmd.RemoveCommand

All Implemented Interfaces:

ExtensionPoint, Describable<DockerCommand>

public class RemoveCommand
extends DockerCommand

This command removes specified Docker container(s).

Author:

vjuranek

See Also:

Remove a container

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RemoveCommand.RemoveCommandDescriptor

Nested classes/interfaces inherited from class org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

DockerCommand.DockerCommandDescriptor

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

CREDENTIALS_MATCHER

Constructor Summary

Constructors

Constructor	Description
RemoveCommand(String containerIds, boolean ignoreIfNotFound, boolean removeVolumes, boolean force)

Method Summary

Modifier and Type	Method	Description
void	execute(Launcher launcher, AbstractBuild build, ConsoleLogger console)
String	getContainerIds()
boolean	getIgnoreIfNotFound()
boolean	isForce()
boolean	isRemoveVolumes()

Methods inherited from class org.jenkinsci.plugins.dockerbuildstep.cmd.DockerCommand

all, attachContainerOutput, getAuthConfig, getClient, getClient, getConfig, getDescriptor, getDockerRegistryEndpoint, getInfoString, readResolve

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RemoveCommand

@DataBoundConstructor
public RemoveCommand(String containerIds,
                     boolean ignoreIfNotFound,
                     boolean removeVolumes,
                     boolean force)

Method Detail

getContainerIds

public String getContainerIds()

getIgnoreIfNotFound

public boolean getIgnoreIfNotFound()

isRemoveVolumes

public boolean isRemoveVolumes()

isForce

public boolean isForce()

execute

public void execute(Launcher launcher,
                    AbstractBuild build,
                    ConsoleLogger console)
             throws com.github.dockerjava.api.exception.DockerException

Specified by:

execute in class DockerCommand

Throws:

com.github.dockerjava.api.exception.DockerException