com.github.dockerjava.api.command.RemoveContainerCmd Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of docker-java Show documentation

Java API Client for Docker

There is a newer version: 3.4.1

package com.github.dockerjava.api.command;

import com.github.dockerjava.api.NotFoundException;

/**
 * Remove a container.
 *
 * @param removeVolumes
 *            - true or false, Remove the volumes associated to the container. Defaults to false
 * @param force
 *            - true or false, Removes the container even if it was running. Defaults to false
 */
public interface RemoveContainerCmd extends SyncDockerCmd {

    public String getContainerId();

    public boolean hasRemoveVolumesEnabled();

    public boolean hasForceEnabled();

    public RemoveContainerCmd withContainerId(String containerId);

    public RemoveContainerCmd withRemoveVolumes(boolean removeVolumes);

    public RemoveContainerCmd withForce();

    public RemoveContainerCmd withForce(boolean force);

    /**
     * @throws NotFoundException
     *             No such container
     */
    @Override
    public Void exec() throws NotFoundException;

    public static interface Exec extends DockerCmdSyncExec {
    }

}