Source code for linode_api4.objects.volume

from linode_api4.errors import UnexpectedResponseError
from linode_api4.objects import Base, Instance, Property, Region


[docs]class Volume(Base): """ A single Block Storage Volume. Block Storage Volumes are persistent storage devices that can be attached to a Compute Instance and used to store any type of data. API Documentation: https://www.linode.com/docs/api/volumes/#volume-view """ api_endpoint = "/volumes/{id}" properties = { "id": Property(identifier=True), "created": Property(is_datetime=True), "updated": Property(is_datetime=True), "linode_id": Property(id_relationship=Instance), "label": Property(mutable=True), "size": Property(), "status": Property(), "region": Property(slug_relationship=Region), "tags": Property(mutable=True), "filesystem_path": Property(), "hardware_type": Property(), "linode_label": Property(), }
[docs] def attach(self, to_linode, config=None): """ Attaches this Volume to the given Linode. API Documentation: https://www.linode.com/docs/api/volumes/#volume-attach :param to_linode: The ID or object of the Linode to attach the volume to. :type to_linode: Union[Instance, int] :param config: The ID or object of the Linode Config to include this Volume in. Must belong to the Linode referenced by linode_id. If not given, the last booted Config will be chosen. :type config: Union[Config, int] """ result = self._client.post( "{}/attach".format(Volume.api_endpoint), model=self, data={ "linode_id": to_linode.id if issubclass(type(to_linode), Base) else to_linode, "config": None if not config else config.id if issubclass(type(config), Base) else config, }, ) if not "id" in result: raise UnexpectedResponseError( "Unexpected response when attaching volume!", json=result ) self._populate(result) return True
[docs] def detach(self): """ Detaches this Volume if it is attached API Documentation: https://www.linode.com/docs/api/volumes/#volume-detach :returns: Returns true if operation was successful :rtype: bool """ self._client.post("{}/detach".format(Volume.api_endpoint), model=self) return True
[docs] def resize(self, size): """ Resizes this Volume API Documentation: https://www.linode.com/docs/api/volumes/#volume-resize :param size: The Volume’s size, in GiB. :type size: int :returns: Returns true if operation was successful :rtype: bool """ result = self._client.post( "{}/resize".format(Volume.api_endpoint), model=self, data={"size": size}, ) self._populate(result) return True
[docs] def clone(self, label): """ Clones this volume to a new volume in the same region with the given label API Documentation: https://www.linode.com/docs/api/volumes/#volume-clone :param label: The label for the new volume. :type label: str :returns: The new volume object. :rtype: Volume """ result = self._client.post( "{}/clone".format(Volume.api_endpoint), model=self, data={"label": label}, ) if not "id" in result: raise UnexpectedResponseError("Unexpected response cloning volume!") return Volume(self._client, result["id"], result)