mirror of
https://github.com/ansible-collections/hetzner.hcloud
synced 2025-01-10 11:18:46 +00:00
68 lines
2.4 KiB
Python
68 lines
2.4 KiB
Python
|
from ..core.client import BoundModelBase, ClientEntityBase, GetEntityByNameMixin
|
||
|
|
from .domain import Location
|
||
|
|
|
||
|
|
|
||
|
|
class BoundLocation(BoundModelBase):
|
||
|
|
model = Location
|
||
|
|
|
||
|
|
|
||
|
|
class LocationsClient(ClientEntityBase, GetEntityByNameMixin):
|
||
|
|
results_list_attribute_name = "locations"
|
||
|
|
|
||
|
|
def get_by_id(self, id):
|
||
|
|
# type: (int) -> locations.client.BoundLocation
|
||
|
|
"""Get a specific location by its ID.
|
||
|
|
|
||
|
|
:param id: int
|
||
|
|
:return: :class:`BoundLocation <hcloud.locations.client.BoundLocation>`
|
||
|
|
"""
|
||
|
|
response = self._client.request(url=f"/locations/{id}", method="GET")
|
||
|
|
return BoundLocation(self, response["location"])
|
||
|
|
|
||
|
|
def get_list(self, name=None, page=None, per_page=None):
|
||
|
|
# type: (Optional[str], Optional[int], Optional[int]) -> PageResult[List[BoundLocation], Meta]
|
||
|
|
"""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 = {}
|
||
|
|
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="/locations", method="GET", params=params)
|
||
|
|
locations = [
|
||
|
|
BoundLocation(self, location_data)
|
||
|
|
for location_data in response["locations"]
|
||
|
|
]
|
||
|
|
return self._add_meta_to_result(locations, response)
|
||
|
|
|
||
|
|
def get_all(self, name=None):
|
||
|
|
# type: (Optional[str]) -> 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 super().get_all(name=name)
|
||
|
|
|
||
|
|
def get_by_name(self, name):
|
||
|
|
# type: (str) -> BoundLocation
|
||
|
|
"""Get location by name
|
||
|
|
|
||
|
|
:param name: str
|
||
|
|
Used to get location by name.
|
||
|
|
:return: :class:`BoundLocation <hcloud.locations.client.BoundLocation>`
|
||
|
|
"""
|
||
|
|
return super().get_by_name(name)
|