1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
|
from __future__ import annotations
from typing import TYPE_CHECKING, Any, NamedTuple
from ..actions import BoundAction, ResourceActionsClient
from ..core import BoundModelBase, ClientEntityBase, Meta
from .domain import CreatePrimaryIPResponse, PrimaryIP
if TYPE_CHECKING:
from .._client import Client
from ..datacenters import BoundDatacenter, Datacenter
class BoundPrimaryIP(BoundModelBase, PrimaryIP):
_client: PrimaryIPsClient
model = PrimaryIP
def __init__(self, client: PrimaryIPsClient, data: dict, complete: bool = True):
# pylint: disable=import-outside-toplevel
from ..datacenters import BoundDatacenter
datacenter = data.get("datacenter", {})
if datacenter:
data["datacenter"] = BoundDatacenter(client._client.datacenters, datacenter)
super().__init__(client, data, complete)
def update(
self,
auto_delete: bool | None = None,
labels: dict[str, str] | None = None,
name: str | None = None,
) -> BoundPrimaryIP:
"""Updates the description or labels of a Primary IP.
:param auto_delete: bool (optional)
Auto delete IP when assignee gets deleted
:param labels: Dict[str, str] (optional)
User-defined labels (key-value pairs)
:param name: str (optional)
New Name to set
:return: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>`
"""
return self._client.update(
self, auto_delete=auto_delete, labels=labels, name=name
)
def delete(self) -> bool:
"""Deletes a Primary IP. If it is currently assigned to a server it will automatically get unassigned.
:return: boolean
"""
return self._client.delete(self)
def change_protection(self, delete: bool | None = None) -> BoundAction:
"""Changes the protection configuration of the Primary IP.
:param delete: boolean
If true, prevents the Primary IP from being deleted
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
return self._client.change_protection(self, delete)
def assign(self, assignee_id: int, assignee_type: str) -> BoundAction:
"""Assigns a Primary IP to a assignee.
:param assignee_id: int`
Id of an assignee the Primary IP shall be assigned to
:param assignee_type: string`
Assignee type (e.g server) the Primary IP shall be assigned to
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
return self._client.assign(self, assignee_id, assignee_type)
def unassign(self) -> BoundAction:
"""Unassigns a Primary IP, resulting in it being unreachable. You may assign it to a server again at a later time.
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
return self._client.unassign(self)
def change_dns_ptr(self, ip: str, dns_ptr: str) -> BoundAction:
"""Changes the hostname that will appear when getting the hostname belonging to this Primary IP.
:param ip: str
The IP address for which to set the reverse DNS entry
:param dns_ptr: str
Hostname to set as a reverse DNS PTR entry, will reset to original default value if `None`
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
return self._client.change_dns_ptr(self, ip, dns_ptr)
class PrimaryIPsPageResult(NamedTuple):
primary_ips: list[BoundPrimaryIP]
meta: Meta | None
class PrimaryIPsClient(ClientEntityBase):
_client: Client
actions: ResourceActionsClient
"""Primary IPs scoped actions client
:type: :class:`ResourceActionsClient <hcloud.actions.client.ResourceActionsClient>`
"""
def __init__(self, client: Client):
super().__init__(client)
self.actions = ResourceActionsClient(client, "/primary_ips")
def get_by_id(self, id: int) -> BoundPrimaryIP:
"""Returns a specific Primary IP object.
:param id: int
:return: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>`
"""
response = self._client.request(url=f"/primary_ips/{id}", method="GET")
return BoundPrimaryIP(self, response["primary_ip"])
def get_list(
self,
label_selector: str | None = None,
page: int | None = None,
per_page: int | None = None,
name: str | None = None,
ip: str | None = None,
) -> PrimaryIPsPageResult:
"""Get a list of primary ips from this account
:param label_selector: str (optional)
Can be used to filter Primary IPs by labels. The response will only contain Primary IPs matching the label selectorable values.
:param page: int (optional)
Specifies the page to fetch
:param per_page: int (optional)
Specifies how many results are returned by page
:param name: str (optional)
Can be used to filter networks by their name.
:param ip: str (optional)
Can be used to filter resources by their ip. The response will only contain the resources matching the specified ip.
:return: (List[:class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>`], :class:`Meta <hcloud.core.domain.Meta>`)
"""
params: dict[str, Any] = {}
if label_selector is not None:
params["label_selector"] = label_selector
if page is not None:
params["page"] = page
if per_page is not None:
params["per_page"] = per_page
if name is not None:
params["name"] = name
if ip is not None:
params["ip"] = ip
response = self._client.request(url="/primary_ips", method="GET", params=params)
primary_ips = [
BoundPrimaryIP(self, primary_ip_data)
for primary_ip_data in response["primary_ips"]
]
return PrimaryIPsPageResult(primary_ips, Meta.parse_meta(response))
def get_all(
self,
label_selector: str | None = None,
name: str | None = None,
) -> list[BoundPrimaryIP]:
"""Get all primary ips from this account
:param label_selector: str (optional)
Can be used to filter Primary IPs by labels. The response will only contain Primary IPs matching the label selector.able values.
:param name: str (optional)
Can be used to filter networks by their name.
:return: List[:class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>`]
"""
return self._iter_pages(self.get_list, label_selector=label_selector, name=name)
def get_by_name(self, name: str) -> BoundPrimaryIP | None:
"""Get Primary IP by name
:param name: str
Used to get Primary IP by name.
:return: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>`
"""
return self._get_first_by(name=name)
def create(
self,
type: str,
name: str,
datacenter: Datacenter | BoundDatacenter | None = None,
assignee_type: str | None = "server",
assignee_id: int | None = None,
auto_delete: bool | None = False,
labels: dict | None = None,
) -> CreatePrimaryIPResponse:
"""Creates a new Primary IP assigned to a server.
:param type: str Primary IP type Choices: ipv4, ipv6
:param name: str
:param datacenter: Datacenter (optional)
:param assignee_type: str (optional)
:param assignee_id: int (optional)
:param auto_delete: bool (optional)
:param labels: Dict[str, str] (optional) User-defined labels (key-value pairs)
:return: :class:`CreatePrimaryIPResponse <hcloud.primary_ips.domain.CreatePrimaryIPResponse>`
"""
data: dict[str, Any] = {
"name": name,
"type": type,
"assignee_type": assignee_type,
"auto_delete": auto_delete,
}
if datacenter is not None:
data["datacenter"] = datacenter.id_or_name
if assignee_id is not None:
data["assignee_id"] = assignee_id
if labels is not None:
data["labels"] = labels
response = self._client.request(url="/primary_ips", json=data, method="POST")
action = None
if response.get("action") is not None:
action = BoundAction(self._client.actions, response["action"])
result = CreatePrimaryIPResponse(
primary_ip=BoundPrimaryIP(self, response["primary_ip"]), action=action
)
return result
def update(
self,
primary_ip: PrimaryIP | BoundPrimaryIP,
auto_delete: bool | None = None,
labels: dict[str, str] | None = None,
name: str | None = None,
) -> BoundPrimaryIP:
"""Updates the name, auto_delete or labels of a Primary IP.
:param primary_ip: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>` or :class:`PrimaryIP <hcloud.primary_ips.domain.PrimaryIP>`
:param auto_delete: bool (optional)
Delete this Primary IP when the resource it is assigned to is deleted
:param labels: Dict[str, str] (optional)
User-defined labels (key-value pairs)
:param name: str (optional)
New name to set
:return: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>`
"""
data: dict[str, Any] = {}
if auto_delete is not None:
data["auto_delete"] = auto_delete
if labels is not None:
data["labels"] = labels
if name is not None:
data["name"] = name
response = self._client.request(
url=f"/primary_ips/{primary_ip.id}",
method="PUT",
json=data,
)
return BoundPrimaryIP(self, response["primary_ip"])
def delete(self, primary_ip: PrimaryIP | BoundPrimaryIP) -> bool:
"""Deletes a Primary IP. If it is currently assigned to an assignee it will automatically get unassigned.
:param primary_ip: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>` or :class:`PrimaryIP <hcloud.primary_ips.domain.PrimaryIP>`
:return: boolean
"""
self._client.request(
url=f"/primary_ips/{primary_ip.id}",
method="DELETE",
)
# Return always true, because the API does not return an action for it. When an error occurs a HcloudAPIException will be raised
return True
def change_protection(
self,
primary_ip: PrimaryIP | BoundPrimaryIP,
delete: bool | None = None,
) -> BoundAction:
"""Changes the protection configuration of the Primary IP.
:param primary_ip: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>` or :class:`PrimaryIP <hcloud.primary_ips.domain.PrimaryIP>`
:param delete: boolean
If true, prevents the Primary IP from being deleted
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
data: dict[str, Any] = {}
if delete is not None:
data.update({"delete": delete})
response = self._client.request(
url=f"/primary_ips/{primary_ip.id}/actions/change_protection",
method="POST",
json=data,
)
return BoundAction(self._client.actions, response["action"])
def assign(
self,
primary_ip: PrimaryIP | BoundPrimaryIP,
assignee_id: int,
assignee_type: str = "server",
) -> BoundAction:
"""Assigns a Primary IP to a assignee_id.
:param primary_ip: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>` or :class:`PrimaryIP <hcloud.primary_ips.domain.PrimaryIP>`
:param assignee_id: int
Assignee the Primary IP shall be assigned to
:param assignee_type: str
Assignee the Primary IP shall be assigned to
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
response = self._client.request(
url=f"/primary_ips/{primary_ip.id}/actions/assign",
method="POST",
json={"assignee_id": assignee_id, "assignee_type": assignee_type},
)
return BoundAction(self._client.actions, response["action"])
def unassign(self, primary_ip: PrimaryIP | BoundPrimaryIP) -> BoundAction:
"""Unassigns a Primary IP, resulting in it being unreachable. You may assign it to a server again at a later time.
:param primary_ip: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>` or :class:`PrimaryIP <hcloud.primary_ips.domain.PrimaryIP>`
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
response = self._client.request(
url=f"/primary_ips/{primary_ip.id}/actions/unassign",
method="POST",
)
return BoundAction(self._client.actions, response["action"])
def change_dns_ptr(
self,
primary_ip: PrimaryIP | BoundPrimaryIP,
ip: str,
dns_ptr: str,
) -> BoundAction:
"""Changes the dns ptr that will appear when getting the dns ptr belonging to this Primary IP.
:param primary_ip: :class:`BoundPrimaryIP <hcloud.primary_ips.client.BoundPrimaryIP>` or :class:`PrimaryIP <hcloud.primary_ips.domain.PrimaryIP>`
:param ip: str
The IP address for which to set the reverse DNS entry
:param dns_ptr: str
Hostname to set as a reverse DNS PTR entry, will reset to original default value if `None`
:return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
"""
response = self._client.request(
url=f"/primary_ips/{primary_ip.id}/actions/change_dns_ptr",
method="POST",
json={"ip": ip, "dns_ptr": dns_ptr},
)
return BoundAction(self._client.actions, response["action"])
|