Class DockerApi.VolumeApi

java.lang.Object

org.springframework.boot.buildpack.platform.docker.DockerApi.VolumeApi

Enclosing class:

DockerApi

public class DockerApi.VolumeApi
extends Object

Docker API for volume operations.

Since:

2.3.0

Author:

Phillip Webb, Scott Frederick, Rafael Ceccone, Moritz Halbritter

Method Summary

Modifier and Type	Method	Description
void	delete(VolumeName name, boolean force)	Delete a volume.

Methods inherited from class java.lang.Object

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

Method Details

delete

public void delete(VolumeName name,
 boolean force)
            throws IOException

Delete a volume.

Parameters:

name - the name of the volume to delete

force - if the deletion should be forced

Throws:

IOException - on IO error