diff --git a/hcloud/storage_box_types/client.py b/hcloud/storage_box_types/client.py index c37023c2..05cb03e8 100644 --- a/hcloud/storage_box_types/client.py +++ b/hcloud/storage_box_types/client.py @@ -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 @@ def get_by_id(self, id: int) -> BoundStorageBoxType: 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 @@ def get_by_name(self, name: str) -> BoundStorageBoxType | None: 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 @@ def get_list( :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 @@ def get_all( 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, diff --git a/hcloud/storage_boxes/client.py b/hcloud/storage_boxes/client.py index c0a380b6..112d6214 100644 --- a/hcloud/storage_boxes/client.py +++ b/hcloud/storage_boxes/client.py @@ -81,6 +81,9 @@ def get_actions_list( :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 @@ def get_actions( :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 @@ def 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. """ return self._client.update( self, @@ -135,6 +144,9 @@ def delete(self) -> DeleteStorageBoxResponse: 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) @@ -150,6 +162,9 @@ def get_folders( 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 +182,9 @@ def change_protection( 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 +201,9 @@ def change_type( 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 +220,9 @@ def reset_password( 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 +239,9 @@ def update_access_settings( 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 +258,9 @@ def rollback_snapshot( 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, @@ -244,6 +274,9 @@ def disable_snapshot_plan( Disable the snapshot plan 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) @@ -257,6 +290,9 @@ def enable_snapshot_plan( 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 +312,9 @@ def get_snapshot_by_id( 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 +328,9 @@ def get_snapshot_by_name( 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 +351,9 @@ def get_snapshot_list( :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 +380,9 @@ def get_snapshot_all( :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 +405,9 @@ def create_snapshot( :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 +428,9 @@ def get_subaccount_by_id( 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 +444,9 @@ def get_subaccount_by_username( 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 +465,9 @@ def get_subaccount_list( :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 +491,9 @@ def get_subaccount_all( :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 +522,9 @@ def create_subaccount( :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 +578,9 @@ def 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. """ return self._client.update_snapshot( self, @@ -526,6 +595,9 @@ def delete( 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 +644,9 @@ def 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. """ return self._client.update_subaccount( self, @@ -586,6 +661,9 @@ def delete( 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 +677,9 @@ def change_home_directory( 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 +695,9 @@ def reset_password( 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 +711,9 @@ def update_access_settings( 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 +741,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 +766,9 @@ def get_by_id(self, id: int) -> BoundStorageBox: 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,6 +783,9 @@ def get_by_name(self, name: str) -> BoundStorageBox | None: 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) @@ -711,6 +807,9 @@ def get_list( :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: @@ -748,6 +847,9 @@ def get_all( :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 +881,9 @@ def create( :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 +927,9 @@ def update( :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 +955,9 @@ def delete( 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", @@ -871,6 +982,9 @@ def get_folders( :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 +1017,9 @@ def get_actions_list( :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 +1056,9 @@ def get_actions( :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 +1080,9 @@ def change_protection( :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 +1107,9 @@ def change_type( :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 +1134,9 @@ def reset_password( :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 +1161,9 @@ def update_access_settings( :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 +1186,9 @@ def rollback_snapshot( :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, @@ -1076,6 +1211,9 @@ def disable_snapshot_plan( 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", @@ -1095,6 +1233,9 @@ def 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 +1261,9 @@ def get_snapshot_by_id( :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 +1283,9 @@ def get_snapshot_by_name( :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 +1305,12 @@ def get_snapshot_list( :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 +1353,9 @@ def get_snapshot_all( :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 +1382,9 @@ def create_snapshot( :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 +1422,9 @@ def update_snapshot( :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 +1452,9 @@ def delete_snapshot( 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 +1482,9 @@ def get_subaccount_by_id( :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 +1504,9 @@ def get_subaccount_by_username( :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 +1531,9 @@ def get_subaccount_list( :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 +1573,9 @@ def get_subaccount_all( :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 +1607,9 @@ def create_subaccount( :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 +1652,9 @@ def update_subaccount( :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 +1682,9 @@ def delete_subaccount( 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 +1709,9 @@ def change_subaccount_home_directory( :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 +1739,9 @@ def reset_subaccount_password( :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 +1769,9 @@ def update_subaccount_access_settings( :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")