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

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

Java API Client for Docker

There is a newer version: 3.4.0

package com.github.dockerjava.api.command;

import javax.annotation.Nonnull;

import com.github.dockerjava.api.exception.ConflictException;
import com.github.dockerjava.api.exception.NotFoundException;

/**
 * Remove a volume.
 *
 * @author Marcus Linke
 */
public interface RemoveVolumeCmd extends SyncDockerCmd {

    String getName();

    RemoveVolumeCmd withName(@Nonnull String name);

    /**
     * @throws NotFoundException
     *             No such volume
     * @throws ConflictException
     *             Volume is in use and cannot be removed
     */
    @Override
    Void exec() throws NotFoundException;

    interface Exec extends DockerCmdSyncExec {
    }
}