docker.models.volumes.Volume

class documentation

class Volume(Model): (source)

A volume.

Method	`remove`	Remove this volume.
Class Variable	`id_attribute`	Undocumented
Property	`name`	The name of the volume.

Inherited from Model:

Method	`__eq__`	Undocumented
Method	`__hash__`	Undocumented
Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`reload`	Load this object from the server again and update ``attrs`` with the new data.
Instance Variable	`attrs`	Undocumented
Instance Variable	`client`	Undocumented
Instance Variable	`collection`	Undocumented
Property	`id`	The ID of the object.
Property	`short_id`	The ID of the object, truncated to 12 characters.

def remove(self, force=False): (source) ¶

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.

id_attribute: str = (source) ¶

overrides docker.models.resource.Model.id_attribute

Undocumented

@property
name = (source) ¶

The name of the volume.