MCPcopy Index your code
hub / github.com/docker/docker-py / remove

Method remove

docker/models/volumes.py:14–25  ·  view source on GitHub ↗

Remove this volume. Args: force (bool): Force removal of volumes that were already removed out of band by the volume driver plugin. Raises: :py:class:`docker.errors.APIError` If volume failed to remove.

(self, force=False)

Source from the content-addressed store, hash-verified

12 return self.attrs['Name']
13
14 def remove(self, force=False):
15 """
16 Remove this volume.
17
18 Args:
19 force (bool): Force removal of volumes that were already removed
20 out of band by the volume driver plugin.
21 Raises:
22 :py:class:`docker.errors.APIError`
23 If volume failed to remove.
24 """
25 return self.client.api.remove_volume(self.id, force=force)
26
27
28class VolumeCollection(Collection):

Callers

nothing calls this directly

Calls 1

remove_volumeMethod · 0.80

Tested by

no test coverage detected