mirror of
https://github.com/ansible-collections/hetzner.hcloud.git
synced 2026-02-04 08:01:49 +00:00
refactor: mark module_utils modules as private (#782)
##### 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
This commit is contained in:
parent
0f23e6c58c
commit
cfa0d181f7
152 changed files with 283 additions and 239 deletions
85
plugins/module_utils/_vendor/hcloud/locations/client.py
Normal file
85
plugins/module_utils/_vendor/hcloud/locations/client.py
Normal file
|
|
@ -0,0 +1,85 @@
|
|||
from __future__ import annotations
|
||||
|
||||
from typing import Any, NamedTuple
|
||||
|
||||
from ..core import BoundModelBase, Meta, ResourceClientBase
|
||||
from .domain import Location
|
||||
|
||||
__all__ = [
|
||||
"BoundLocation",
|
||||
"LocationsPageResult",
|
||||
"LocationsClient",
|
||||
]
|
||||
|
||||
|
||||
class BoundLocation(BoundModelBase[Location], Location):
|
||||
_client: LocationsClient
|
||||
|
||||
model = Location
|
||||
|
||||
|
||||
class LocationsPageResult(NamedTuple):
|
||||
locations: list[BoundLocation]
|
||||
meta: Meta
|
||||
|
||||
|
||||
class LocationsClient(ResourceClientBase):
|
||||
_base_url = "/locations"
|
||||
|
||||
def get_by_id(self, id: int) -> BoundLocation:
|
||||
"""Get a specific location by its ID.
|
||||
|
||||
:param id: int
|
||||
:return: :class:`BoundLocation <hcloud.locations.client.BoundLocation>`
|
||||
"""
|
||||
response = self._client.request(url=f"{self._base_url}/{id}", method="GET")
|
||||
return BoundLocation(self, response["location"])
|
||||
|
||||
def get_list(
|
||||
self,
|
||||
name: str | None = None,
|
||||
page: int | None = None,
|
||||
per_page: int | None = None,
|
||||
) -> LocationsPageResult:
|
||||
"""Get a list of locations
|
||||
|
||||
:param name: str (optional)
|
||||
Can be used to filter locations by their name.
|
||||
: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:`BoundLocation <hcloud.locations.client.BoundLocation>`], :class:`Meta <hcloud.core.domain.Meta>`)
|
||||
"""
|
||||
params: dict[str, Any] = {}
|
||||
if name is not None:
|
||||
params["name"] = name
|
||||
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)
|
||||
locations = [
|
||||
BoundLocation(self, location_data)
|
||||
for location_data in response["locations"]
|
||||
]
|
||||
return LocationsPageResult(locations, Meta.parse_meta(response))
|
||||
|
||||
def get_all(self, name: str | None = None) -> list[BoundLocation]:
|
||||
"""Get all locations
|
||||
|
||||
:param name: str (optional)
|
||||
Can be used to filter locations by their name.
|
||||
:return: List[:class:`BoundLocation <hcloud.locations.client.BoundLocation>`]
|
||||
"""
|
||||
return self._iter_pages(self.get_list, name=name)
|
||||
|
||||
def get_by_name(self, name: str) -> BoundLocation | None:
|
||||
"""Get location by name
|
||||
|
||||
:param name: str
|
||||
Used to get location by name.
|
||||
:return: :class:`BoundLocation <hcloud.locations.client.BoundLocation>`
|
||||
"""
|
||||
return self._get_first_by(self.get_list, name=name)
|
||||
Loading…
Add table
Add a link
Reference in a new issue