mirror of
https://github.com/ansible-collections/hetzner.hcloud.git
synced 2026-02-03 23:51:48 +00:00
cfa0d181f7
##### SUMMARY All `module_utils` are now marked as **private**. None of the modules were intended for public use. Similar to https://togithub.com/ansible-collections/community.general/issues/11312
108 lines
3.7 KiB
Python
108 lines
3.7 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import Any, NamedTuple
|
|
|
|
from ..core import BoundModelBase, Meta, ResourceClientBase
|
|
from .domain import Iso
|
|
|
|
__all__ = [
|
|
"BoundIso",
|
|
"IsosPageResult",
|
|
"IsosClient",
|
|
]
|
|
|
|
|
|
class BoundIso(BoundModelBase[Iso], Iso):
|
|
_client: IsosClient
|
|
|
|
model = Iso
|
|
|
|
|
|
class IsosPageResult(NamedTuple):
|
|
isos: list[BoundIso]
|
|
meta: Meta
|
|
|
|
|
|
class IsosClient(ResourceClientBase):
|
|
_base_url = "/isos"
|
|
|
|
def get_by_id(self, id: int) -> BoundIso:
|
|
"""Get a specific ISO by its id
|
|
|
|
:param id: int
|
|
:return: :class:`BoundIso <hcloud.isos.client.BoundIso>`
|
|
"""
|
|
response = self._client.request(url=f"{self._base_url}/{id}", method="GET")
|
|
return BoundIso(self, response["iso"])
|
|
|
|
def get_list(
|
|
self,
|
|
name: str | None = None,
|
|
architecture: list[str] | None = None,
|
|
include_architecture_wildcard: bool | None = None,
|
|
page: int | None = None,
|
|
per_page: int | None = None,
|
|
) -> IsosPageResult:
|
|
"""Get a list of ISOs
|
|
|
|
:param name: str (optional)
|
|
Can be used to filter ISOs by their name.
|
|
:param architecture: List[str] (optional)
|
|
Can be used to filter ISOs by their architecture. Choices: x86 arm
|
|
:param include_architecture_wildcard: bool (optional)
|
|
Custom ISOs do not have an architecture set. You must also set this flag to True if you are filtering by
|
|
architecture and also want custom ISOs.
|
|
:param page: int (optional)
|
|
Specifies the page to fetch
|
|
:param per_page: int (optional)
|
|
Specifies how many results are returned by page
|
|
:return: (List[:class:`BoundIso <hcloud.isos.client.BoundIso>`], :class:`Meta <hcloud.core.domain.Meta>`)
|
|
"""
|
|
params: dict[str, Any] = {}
|
|
if name is not None:
|
|
params["name"] = name
|
|
if architecture is not None:
|
|
params["architecture"] = architecture
|
|
if include_architecture_wildcard is not None:
|
|
params["include_architecture_wildcard"] = include_architecture_wildcard
|
|
if page is not None:
|
|
params["page"] = page
|
|
if per_page is not None:
|
|
params["per_page"] = per_page
|
|
|
|
response = self._client.request(url=self._base_url, method="GET", params=params)
|
|
isos = [BoundIso(self, iso_data) for iso_data in response["isos"]]
|
|
return IsosPageResult(isos, Meta.parse_meta(response))
|
|
|
|
def get_all(
|
|
self,
|
|
name: str | None = None,
|
|
architecture: list[str] | None = None,
|
|
include_architecture_wildcard: bool | None = None,
|
|
) -> list[BoundIso]:
|
|
"""Get all ISOs
|
|
|
|
:param name: str (optional)
|
|
Can be used to filter ISOs by their name.
|
|
:param architecture: List[str] (optional)
|
|
Can be used to filter ISOs by their architecture. Choices: x86 arm
|
|
:param include_architecture_wildcard: bool (optional)
|
|
Custom ISOs do not have an architecture set. You must also set this flag to True if you are filtering by
|
|
architecture and also want custom ISOs.
|
|
:return: List[:class:`BoundIso <hcloud.isos.client.BoundIso>`]
|
|
"""
|
|
return self._iter_pages(
|
|
self.get_list,
|
|
name=name,
|
|
architecture=architecture,
|
|
include_architecture_wildcard=include_architecture_wildcard,
|
|
)
|
|
|
|
def get_by_name(self, name: str) -> BoundIso | None:
|
|
"""Get iso by name
|
|
|
|
:param name: str
|
|
Used to get iso by name.
|
|
:return: :class:`BoundIso <hcloud.isos.client.BoundIso>`
|
|
"""
|
|
return self._get_first_by(self.get_list, name=name)
|