mirror of
https://github.com/ansible-collections/hetzner.hcloud.git
synced 2026-02-04 16:11:49 +00:00
tmp: update vendored files
This commit is contained in:
parent
bd21616674
commit
fd51b98cc8
2 changed files with 216 additions and 5 deletions
|
|
@ -25,6 +25,9 @@ class StorageBoxTypesClient(ResourceClientBase):
|
|||
A client for the Storage Box Types API.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
|
||||
_base_url = "/storage_box_types"
|
||||
|
|
@ -40,6 +43,9 @@ class StorageBoxTypesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types-get-a-storage-box-type
|
||||
|
||||
:param id: ID of the Storage Box Type.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
response = self._client.request(
|
||||
method="GET",
|
||||
|
|
@ -54,6 +60,9 @@ class StorageBoxTypesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types-list-storage-box-types
|
||||
|
||||
:param name: Name of the Storage Box Type.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._get_first_by(self.get_list, name=name)
|
||||
|
||||
|
|
@ -71,6 +80,9 @@ class StorageBoxTypesClient(ResourceClientBase):
|
|||
:param name: Name of the Storage Box Type.
|
||||
:param page: Page number to return.
|
||||
:param per_page: Maximum number of entries returned per page.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
params: dict[str, Any] = {}
|
||||
if name is not None:
|
||||
|
|
@ -102,6 +114,9 @@ class StorageBoxTypesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-types-list-storage-box-types
|
||||
|
||||
:param name: Name of the Storage Box Type.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._iter_pages(
|
||||
self.get_list,
|
||||
|
|
|
|||
|
|
@ -81,6 +81,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
:param sort: Sort resources by field and direction.
|
||||
:param page: Page number to return.
|
||||
:param per_page: Maximum number of entries returned per page.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_actions_list(
|
||||
self,
|
||||
|
|
@ -103,6 +106,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
|
||||
:param status: Filter the actions by status. The response will only contain actions matching the specified statuses.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_actions(
|
||||
self,
|
||||
|
|
@ -123,6 +129,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
|
||||
:param name: Name of the Storage Box.
|
||||
:param labels: User-defined labels (key/value pairs) for the Storage Box.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.update(
|
||||
self,
|
||||
|
|
@ -135,11 +144,15 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
Deletes a Storage Box.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-boxes-delete-a-storage-box
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.delete(self)
|
||||
|
||||
def get_folders(
|
||||
self,
|
||||
*,
|
||||
path: str | None = None,
|
||||
) -> StorageBoxFoldersResponse:
|
||||
"""
|
||||
|
|
@ -150,6 +163,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-boxes-list-folders-of-a-storage-box
|
||||
|
||||
:param path: Relative path to list the folders from.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_folders(
|
||||
self,
|
||||
|
|
@ -167,6 +183,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-change-protection
|
||||
|
||||
:param delete: Prevents the Storage Box from being deleted.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.change_protection(
|
||||
self,
|
||||
|
|
@ -183,6 +202,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-change-type
|
||||
|
||||
:param storage_box_type: Storage Box Type to change to.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.change_type(
|
||||
self,
|
||||
|
|
@ -199,6 +221,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-reset-password
|
||||
|
||||
:param password: New password.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.reset_password(
|
||||
self,
|
||||
|
|
@ -215,6 +240,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-update-access-settings
|
||||
|
||||
:param access_settings: New access settings for the Storage Box.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.update_access_settings(
|
||||
self,
|
||||
|
|
@ -231,6 +259,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-rollback-snapshot
|
||||
|
||||
:param snapshot: Snapshot to rollback to.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.rollback_snapshot(
|
||||
self,
|
||||
|
|
@ -241,9 +272,12 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
self,
|
||||
) -> BoundAction:
|
||||
"""
|
||||
Disable the snapshot plan a Storage Box.
|
||||
Disable the snapshot plan of a Storage Box.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-disable-snapshot-plan
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.disable_snapshot_plan(self)
|
||||
|
||||
|
|
@ -252,11 +286,14 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
snapshot_plan: StorageBoxSnapshotPlan,
|
||||
) -> BoundAction:
|
||||
"""
|
||||
Enable the snapshot plan a Storage Box.
|
||||
Enable the snapshot plan of a Storage Box.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-enable-snapshot-plan
|
||||
|
||||
:param snapshot_plan: Snapshot Plan to enable.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.enable_snapshot_plan(
|
||||
self,
|
||||
|
|
@ -276,6 +313,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-snapshots-get-a-snapshot
|
||||
|
||||
:param id: ID of the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_snapshot_by_id(self, id=id)
|
||||
|
||||
|
|
@ -289,6 +329,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-snapshots-list-snapshots
|
||||
|
||||
:param name: Name of the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_snapshot_by_name(self, name=name)
|
||||
|
||||
|
|
@ -309,6 +352,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
:param is_automatic: Filter wether the snapshot was made by a Snapshot Plan.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_snapshot_list(
|
||||
self,
|
||||
|
|
@ -335,6 +381,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
:param is_automatic: Filter whether the snapshot was made by a Snapshot Plan.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_snapshot_all(
|
||||
self,
|
||||
|
|
@ -357,6 +406,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
|
||||
:param description: Description of the Snapshot.
|
||||
:param labels: User-defined labels (key/value pairs) for the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.create_snapshot(
|
||||
self,
|
||||
|
|
@ -377,6 +429,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccounts-get-a-subaccount
|
||||
|
||||
:param id: ID of the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_subaccount_by_id(self, id=id)
|
||||
|
||||
|
|
@ -390,6 +445,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccounts-list-subaccounts
|
||||
|
||||
:param username: User name of the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_subaccount_by_username(self, username=username)
|
||||
|
||||
|
|
@ -408,6 +466,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
:param username: Filter resources by their username. The response will only contain the resources matching exactly the specified username.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_subaccount_list(
|
||||
self,
|
||||
|
|
@ -431,6 +492,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
:param username: Filter resources by their username. The response will only contain the resources matching exactly the specified username.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.get_subaccount_all(
|
||||
self,
|
||||
|
|
@ -459,6 +523,9 @@ class BoundStorageBox(BoundModelBase, StorageBox):
|
|||
:param access_settings: Access settings of the Subaccount.
|
||||
:param description: Description of the Subaccount.
|
||||
:param labels: User-defined labels (key/value pairs) for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.create_subaccount(
|
||||
self,
|
||||
|
|
@ -512,6 +579,9 @@ class BoundStorageBoxSnapshot(BoundModelBase, StorageBoxSnapshot):
|
|||
|
||||
:param description: Description of the Snapshot.
|
||||
:param labels: User-defined labels (key/value pairs) for the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.update_snapshot(
|
||||
self,
|
||||
|
|
@ -526,6 +596,9 @@ class BoundStorageBoxSnapshot(BoundModelBase, StorageBoxSnapshot):
|
|||
Deletes a Storage Box Snapshot.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-snapshots-delete-a-snapshot
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.delete_snapshot(self)
|
||||
|
||||
|
|
@ -572,6 +645,9 @@ class BoundStorageBoxSubaccount(BoundModelBase, StorageBoxSubaccount):
|
|||
|
||||
:param description: Description of the Subaccount.
|
||||
:param labels: User-defined labels (key/value pairs) for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.update_subaccount(
|
||||
self,
|
||||
|
|
@ -586,6 +662,9 @@ class BoundStorageBoxSubaccount(BoundModelBase, StorageBoxSubaccount):
|
|||
Deletes a Storage Box Subaccount.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccounts-delete-a-subaccount
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.delete_subaccount(self)
|
||||
|
||||
|
|
@ -599,6 +678,9 @@ class BoundStorageBoxSubaccount(BoundModelBase, StorageBoxSubaccount):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccount-actions-change-home-directory
|
||||
|
||||
:param home_directory: Home directory for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.change_subaccount_home_directory(
|
||||
self, home_directory=home_directory
|
||||
|
|
@ -614,6 +696,9 @@ class BoundStorageBoxSubaccount(BoundModelBase, StorageBoxSubaccount):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccount-actions-reset-password
|
||||
|
||||
:param password: Password for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.reset_subaccount_password(self, password=password)
|
||||
|
||||
|
|
@ -627,6 +712,9 @@ class BoundStorageBoxSubaccount(BoundModelBase, StorageBoxSubaccount):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccount-actions-update-access-settings
|
||||
|
||||
:param access_settings: Access settings for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._client.update_subaccount_access_settings(
|
||||
self,
|
||||
|
|
@ -654,6 +742,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
A client for the Storage Boxes API.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-boxes.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
|
||||
_base_url = "/storage_boxes"
|
||||
|
|
@ -676,6 +767,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-boxes-get-a-storage-box
|
||||
|
||||
:param id: ID of the Storage Box.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
response = self._client.request(
|
||||
method="GET",
|
||||
|
|
@ -690,11 +784,15 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-boxes-list-storage-boxes
|
||||
|
||||
:param name: Name of the Storage Box.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._get_first_by(self.get_list, name=name)
|
||||
|
||||
def get_list(
|
||||
self,
|
||||
*,
|
||||
name: str | None = None,
|
||||
label_selector: str | None = None,
|
||||
sort: list[str] | None = None,
|
||||
|
|
@ -711,6 +809,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param sort: Sort resources by field and direction.
|
||||
:param page: Page number to return.
|
||||
:param per_page: Maximum number of entries returned per page.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
params: dict[str, Any] = {}
|
||||
if name is not None:
|
||||
|
|
@ -736,6 +837,7 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
def get_all(
|
||||
self,
|
||||
*,
|
||||
name: str | None = None,
|
||||
label_selector: str | None = None,
|
||||
sort: list[str] | None = None,
|
||||
|
|
@ -748,6 +850,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param name: Name of the Storage Box.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._iter_pages(
|
||||
self.get_list,
|
||||
|
|
@ -779,6 +884,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param ssh_keys: SSH public keys of the Storage Box.
|
||||
:param access_settings: Access settings of the Storage Box.
|
||||
:param labels: User-defined labels (key/value pairs) for the Storage Box.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {
|
||||
"name": name,
|
||||
|
|
@ -822,6 +930,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param storage_box: Storage Box to update.
|
||||
:param name: Name of the Storage Box.
|
||||
:param labels: User-defined labels (key/value pairs) for the Storage Box.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {}
|
||||
if name is not None:
|
||||
|
|
@ -847,6 +958,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-boxes-delete-a-storage-box
|
||||
|
||||
:param storage_box: Storage Box to delete.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
response = self._client.request(
|
||||
method="DELETE",
|
||||
|
|
@ -860,6 +974,7 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
def get_folders(
|
||||
self,
|
||||
storage_box: BoundStorageBox | StorageBox,
|
||||
*,
|
||||
path: str | None = None,
|
||||
) -> StorageBoxFoldersResponse:
|
||||
"""
|
||||
|
|
@ -871,6 +986,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to list the folders from.
|
||||
:param path: Relative path to list the folders from.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
params: dict[str, Any] = {}
|
||||
if path is not None:
|
||||
|
|
@ -903,6 +1021,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param sort: Sort resources by field and direction.
|
||||
:param page: Page number to return.
|
||||
:param per_page: Maximum number of entries returned per page.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
params: dict[str, Any] = {}
|
||||
if status is not None:
|
||||
|
|
@ -939,6 +1060,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param storage_box: Storage Box to fetch the Actions from.
|
||||
:param status: Filter the actions by status. The response will only contain actions matching the specified statuses.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._iter_pages(
|
||||
self.get_actions_list,
|
||||
|
|
@ -960,6 +1084,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to update.
|
||||
:param delete: Prevents the Storage Box from being deleted.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {}
|
||||
if delete is not None:
|
||||
|
|
@ -984,6 +1111,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to update.
|
||||
:param storage_box_type: Storage Box Type to change to.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {
|
||||
"storage_box_type": storage_box_type.id_or_name,
|
||||
|
|
@ -1008,6 +1138,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to update.
|
||||
:param password: New password.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {
|
||||
"password": password,
|
||||
|
|
@ -1032,6 +1165,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to update.
|
||||
:param access_settings: New access settings for the Storage Box.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = access_settings.to_payload()
|
||||
|
||||
|
|
@ -1054,6 +1190,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to update.
|
||||
:param snapshot: Snapshot to rollback to.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {
|
||||
"snapshot": snapshot.id_or_name,
|
||||
|
|
@ -1071,11 +1210,14 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
storage_box: StorageBox | BoundStorageBox,
|
||||
) -> BoundAction:
|
||||
"""
|
||||
Disable the snapshot plan a Storage Box.
|
||||
Disable the snapshot plan of a Storage Box.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-disable-snapshot-plan
|
||||
|
||||
:param storage_box: Storage Box to update.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
response = self._client.request(
|
||||
method="POST",
|
||||
|
|
@ -1089,12 +1231,15 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
snapshot_plan: StorageBoxSnapshotPlan,
|
||||
) -> BoundAction:
|
||||
"""
|
||||
Enable the snapshot plan a Storage Box.
|
||||
Enable the snapshot plan of a Storage Box.
|
||||
|
||||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-actions-enable-snapshot-plan
|
||||
|
||||
:param storage_box: Storage Box to update.
|
||||
:param snapshot_plan: Snapshot Plan to enable.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = snapshot_plan.to_payload()
|
||||
|
||||
|
|
@ -1120,6 +1265,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to get the Snapshot from.
|
||||
:param id: ID of the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
response = self._client.request(
|
||||
method="GET",
|
||||
|
|
@ -1139,6 +1287,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to get the Snapshot from.
|
||||
:param name: Name of the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._get_first_by(self.get_snapshot_list, storage_box, name=name)
|
||||
|
||||
|
|
@ -1158,9 +1309,12 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to get the Snapshots from.
|
||||
:param name: Filter resources by their name. The response will only contain the resources matching exactly the specified name.
|
||||
:param is_automatic: Filter wether the snapshot was made by a Snapshot Plan.
|
||||
:param is_automatic: Filter whether the snapshot was made by a Snapshot Plan.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
params: dict[str, Any] = {}
|
||||
if name is not None:
|
||||
|
|
@ -1203,6 +1357,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param is_automatic: Filter whether the snapshot was made by a Snapshot Plan.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
# The endpoint does not have pagination, forward to the list method.
|
||||
result, _ = self.get_snapshot_list(
|
||||
|
|
@ -1229,6 +1386,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param storage_box: Storage Box to create a Snapshot from.
|
||||
:param description: Description of the Snapshot.
|
||||
:param labels: User-defined labels (key/value pairs) for the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {}
|
||||
if description is not None:
|
||||
|
|
@ -1266,6 +1426,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param snapshot: Storage Box Snapshot to update.
|
||||
:param description: Description of the Snapshot.
|
||||
:param labels: User-defined labels (key/value pairs) for the Snapshot.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
if snapshot.storage_box is None:
|
||||
raise ValueError("snapshot storage_box property is none")
|
||||
|
|
@ -1293,6 +1456,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-snapshots-delete-a-snapshot
|
||||
|
||||
:param snapshot: Storage Box Snapshot to delete.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
if snapshot.storage_box is None:
|
||||
raise ValueError("snapshot storage_box property is none")
|
||||
|
|
@ -1320,6 +1486,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to get the Subaccount from.
|
||||
:param id: ID of the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
response = self._client.request(
|
||||
method="GET",
|
||||
|
|
@ -1339,6 +1508,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param storage_box: Storage Box to get the Subaccount from.
|
||||
:param username: User name of the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
return self._get_first_by(
|
||||
self.get_subaccount_list,
|
||||
|
|
@ -1363,6 +1535,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param username: Filter resources by their username. The response will only contain the resources matching exactly the specified username.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
params: dict[str, Any] = {}
|
||||
if username is not None:
|
||||
|
|
@ -1402,6 +1577,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param username: Filter resources by their username. The response will only contain the resources matching exactly the specified username.
|
||||
:param label_selector: Filter resources by labels. The response will only contain resources matching the label selector.
|
||||
:param sort: Sort resources by field and direction.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
# The endpoint does not have pagination, forward to the list method.
|
||||
result, _ = self.get_subaccount_list(
|
||||
|
|
@ -1433,6 +1611,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param access_settings: Access settings of the Subaccount.
|
||||
:param description: Description of the Subaccount.
|
||||
:param labels: User-defined labels (key/value pairs) for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
data: dict[str, Any] = {
|
||||
"home_directory": home_directory,
|
||||
|
|
@ -1475,6 +1656,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
:param subaccount: Storage Box Subaccount to update.
|
||||
:param description: Description of the Subaccount.
|
||||
:param labels: User-defined labels (key/value pairs) for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
if subaccount.storage_box is None:
|
||||
raise ValueError("subaccount storage_box property is none")
|
||||
|
|
@ -1502,6 +1686,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
See https://docs.hetzner.cloud/reference/hetzner#storage-box-subaccounts-delete-a-subaccount
|
||||
|
||||
:param subaccount: Storage Box Subaccount to delete.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
if subaccount.storage_box is None:
|
||||
raise ValueError("subaccount storage_box property is none")
|
||||
|
|
@ -1526,6 +1713,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param subaccount: Storage Box Subaccount to update.
|
||||
:param home_directory: Home directory for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
if subaccount.storage_box is None:
|
||||
raise ValueError("subaccount storage_box property is none")
|
||||
|
|
@ -1553,6 +1743,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param subaccount: Storage Box Subaccount to update.
|
||||
:param password: Password for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
if subaccount.storage_box is None:
|
||||
raise ValueError("subaccount storage_box property is none")
|
||||
|
|
@ -1580,6 +1773,9 @@ class StorageBoxesClient(ResourceClientBase):
|
|||
|
||||
:param subaccount: Storage Box Subaccount to update.
|
||||
:param access_settings: Access settings for the Subaccount.
|
||||
|
||||
Experimental:
|
||||
Storage Box support is experimental, breaking changes may occur within minor releases.
|
||||
"""
|
||||
if subaccount.storage_box is None:
|
||||
raise ValueError("subaccount storage_box property is none")
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue