com.github.dockerjava.api.command

Interface RemoveVolumeCmd

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, DockerCmd<java.lang.Void>, SyncDockerCmd<java.lang.Void>

All Known Implementing Classes:

RemoveVolumeCmdImpl

public interface RemoveVolumeCmd
extends SyncDockerCmd<java.lang.Void>

Remove a volume.

Author:

Marcus Linke

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RemoveVolumeCmd.Exec

Method Summary

Modifier and Type	Method and Description
java.lang.Void	exec()
java.lang.String	getName()
RemoveVolumeCmd	withName(java.lang.String name)

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

close

Method Detail

getName

java.lang.String getName()

withName

RemoveVolumeCmd withName(@Nonnull
                         java.lang.String name)

exec

java.lang.Void exec()
             throws NotFoundException

Specified by:

exec in interface SyncDockerCmd<java.lang.Void>

Throws:

NotFoundException - No such volume

ConflictException - Volume is in use and cannot be removed