mirror of
https://github.com/ansible-collections/hetzner.hcloud.git
synced 2026-02-04 08:01:49 +00:00
120 lines
3.6 KiB
Python
120 lines
3.6 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, TypedDict
|
|
|
|
from ..core import BaseDomain, DomainIdentityMixin
|
|
|
|
if TYPE_CHECKING:
|
|
from ..actions import BoundAction
|
|
from ..locations import BoundLocation, Location
|
|
from ..servers import BoundServer, Server
|
|
from .client import BoundVolume
|
|
|
|
__all__ = [
|
|
"Volume",
|
|
"VolumeProtection",
|
|
"CreateVolumeResponse",
|
|
]
|
|
|
|
|
|
class Volume(BaseDomain, DomainIdentityMixin):
|
|
"""Volume Domain
|
|
|
|
:param id: int
|
|
ID of the Volume
|
|
:param name: str
|
|
Name of the Volume
|
|
:param server: :class:`BoundServer <hcloud.servers.client.BoundServer>`, None
|
|
Server the Volume is attached to, None if it is not attached at all.
|
|
:param created: datetime
|
|
Point in time when the Volume was created
|
|
:param location: :class:`BoundLocation <hcloud.locations.client.BoundLocation>`
|
|
Location of the Volume. Volume can only be attached to Servers in the same location.
|
|
:param size: int
|
|
Size in GB of the Volume
|
|
:param linux_device: str
|
|
Device path on the file system for the Volume
|
|
:param protection: dict
|
|
Protection configuration for the Volume
|
|
:param labels: dict
|
|
User-defined labels (key-value pairs)
|
|
:param status: str
|
|
Current status of the volume Choices: `creating`, `available`
|
|
:param format: str, None
|
|
Filesystem of the volume if formatted on creation, None if not formatted on creation.
|
|
"""
|
|
|
|
STATUS_CREATING = "creating"
|
|
"""Volume Status creating"""
|
|
STATUS_AVAILABLE = "available"
|
|
"""Volume Status available"""
|
|
|
|
__api_properties__ = (
|
|
"id",
|
|
"name",
|
|
"server",
|
|
"location",
|
|
"size",
|
|
"linux_device",
|
|
"format",
|
|
"protection",
|
|
"labels",
|
|
"status",
|
|
"created",
|
|
)
|
|
__slots__ = __api_properties__
|
|
|
|
def __init__(
|
|
self,
|
|
id: int,
|
|
name: str | None = None,
|
|
server: Server | BoundServer | None = None,
|
|
created: str | None = None,
|
|
location: Location | BoundLocation | None = None,
|
|
size: int | None = None,
|
|
linux_device: str | None = None,
|
|
format: str | None = None,
|
|
protection: VolumeProtection | None = None,
|
|
labels: dict[str, str] | None = None,
|
|
status: str | None = None,
|
|
):
|
|
self.id = id
|
|
self.name = name
|
|
self.server = server
|
|
self.created = self._parse_datetime(created)
|
|
self.location = location
|
|
self.size = size
|
|
self.linux_device = linux_device
|
|
self.format = format
|
|
self.protection = protection
|
|
self.labels = labels
|
|
self.status = status
|
|
|
|
|
|
class VolumeProtection(TypedDict):
|
|
delete: bool
|
|
|
|
|
|
class CreateVolumeResponse(BaseDomain):
|
|
"""Create Volume Response Domain
|
|
|
|
:param volume: :class:`BoundVolume <hcloud.volumes.client.BoundVolume>`
|
|
The created volume
|
|
:param action: :class:`BoundAction <hcloud.actions.client.BoundAction>`
|
|
The action that shows the progress of the Volume Creation
|
|
:param next_actions: List[:class:`BoundAction <hcloud.actions.client.BoundAction>`]
|
|
List of actions that are performed after the creation, like attaching to a server
|
|
"""
|
|
|
|
__api_properties__ = ("volume", "action", "next_actions")
|
|
__slots__ = __api_properties__
|
|
|
|
def __init__(
|
|
self,
|
|
volume: BoundVolume,
|
|
action: BoundAction,
|
|
next_actions: list[BoundAction],
|
|
):
|
|
self.volume = volume
|
|
self.action = action
|
|
self.next_actions = next_actions
|